Refactor configuration structure from 'structure' to 'files' (#42)

Update configuration files to prioritize the 'structure' key over 'files', enhancing clarity and consistency in the configuration format.

Author: httpdss

README.es.md

@@ -1,4 +1,4 @@
-structure:
+files:
   - README.md:
       skip: true
       content: |

README.md

@@ -1,5 +1,5 @@
 {
-  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$schema": "https://json-schema.org/draft-07/schema",
   "type": "object",
   "properties": {
     "structure": {
@@ -21,6 +21,36 @@
         }
       }
     },
+    "files": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "patternProperties": {
+          ".*": {
+            "type": "object",
+            "properties": {
+              "skip": {
+                "type": "boolean"
+              },
+              "skip_if_exists": {
+                "type": "boolean"
+              },
+              "content": {
+                "type": "string"
+              },
+              "permissions": {
+                "type": "string"
+              },
+              "file": {
+                "type": "string",
+                "format": "uri"
+              }
+            },
+            "additionalProperties": false
+          }
+        }
+      }
+    },
     "folders": {
       "type": "array",
       "items": {

example/structure.yaml

@@ -63,7 +63,7 @@ def _create_structure(self, args):
         config = yaml.safe_load(f)
 
     template_vars = dict(item.split('=') for item in args.vars.split(',')) if args.vars else None
-    config_structure = config.get('structure', [])
+    config_structure = config.get('files', config.get('structure', []))
     config_folders = config.get('folders', [])
     config_variables = config.get('variables', [])
 

struct-schema.json

@@ -38,9 +38,9 @@ def _get_info(self, args):
       print(f"   📌 Name: {args.structure_definition}\n")
       print(f"   📌 Description: {config.get('description', 'No description')}\n")
 
-      if config.get('structure'):
-        print(f"   📌 Structure:")
-        for item in config.get('structure', []):
+      if config.get('files'):
+        print(f"   📌 Files:")
+        for item in config.get('files', []):
           for name, content in item.items():
             print(f"       - {name} ")
             # indent all lines of content

struct_module/commands/generate.py

@@ -18,7 +18,9 @@ def execute(self, args):
       with open(args.yaml_file, 'r') as f:
         config = yaml.safe_load(f)
 
-      self._validate_structure_config(config.get('structure', []))
+      if 'structure' in config and 'files' in config:
+          self.logger.warning("Both 'structure' and 'files' keys exist. Prioritizing 'structure'.")
+      self._validate_structure_config(config.get('structure') or config.get('files', []))
       self._validate_folders_config(config.get('folders', []))
       self._validate_variables_config(config.get('variables', []))
 

struct_module/commands/info.py

@@ -1,4 +1,4 @@
-structure:
+files:
   - main.yml:
       content: |
         - name: Example Playbook

struct_module/commands/validate.py

@@ -1,4 +1,4 @@
-structure:
+files:
   - recipes/default.rb:
       content: |
         package 'nginx' do

struct_module/contribs/ansible-playbook.yaml

@@ -1,4 +1,4 @@
-structure:
+files:
   - .gitlab-ci.yml:
       content: |
         stages: