Add skip_if_exists property to YAML configuration and update validation

Author: httpdss

README.md

@@ -133,15 +133,27 @@ struct generate \
 
 ## 📝 YAML Configuration
 
-Here is an example of a YAML configuration file:
+### Configuration Properties
+
+When defining your project structure in the YAML configuration file, you can use various properties to control the behavior of the script. Here are the available properties:
+
+- **skip**: If set to `true`, the file or folder will be skipped and not created.
+- **skip_if_exists**: If set to `true`, the file or folder will be skipped if it already exists.
+- **permissions**: Set custom file permissions using a string representation of the octal value (e.g., `'0777'`).
+- **content**: Define the content of the file directly in the YAML configuration.
+- **file**: Specify a local or remote file to include. Supported protocols include `file://`, `http://`, `https://`, `github://`, `githubhttps://`, `githubssh://`, `s3://`, and `gs://`.
+
+Example:
 
 ```yaml
 structure:
   - README.md:
+      skip: true
       content: |
         # {{@ project_name @}}
         This is a template repository.
   - script.sh:
+      skip_if_exists: true
       permissions: '0777'
       content: |
         #!/bin/bash
@@ -185,6 +197,8 @@ variables:
       default: "John Doe"
 ```
 
+These properties allow you to customize the behavior and content of the files and folders generated by the script, providing flexibility and control over your project structure.
+
 ### Template variables
 
 You can use template variables in your configuration file by enclosing them in `{{@` and `@}}`. For example, `{{@ project_name @}}` will be replaced with the value of the `project_name` variable at runtime. If this are not set when running the script, it will prompt you to enter the value interactively.

example/structure.yaml

@@ -6,6 +6,7 @@ structure:
         This is a template repository.
   - script.sh:
       permissions: '0777'
+      skip_if_exists: true
       content: |
         #!/bin/bash
         echo "Hello, {{@ author_name @}}!"

struct-schema.json

@@ -11,6 +11,7 @@
             "type": "object",
             "properties": {
               "skip": { "type": "boolean" },
+              "skip_if_exists": { "type": "boolean" },
               "content": { "type": "string" },
               "permissions": { "type": "string" },
               "file": { "type": "string", "format": "uri" }

struct_module/commands/validate.py

@@ -110,6 +110,8 @@ def _validate_structure_config(self, structure):
                 raise ValueError(f"The 'prompt' value for '{name}' must be a string.")
               if 'skip' in content and not isinstance(content['skip'], bool):
                 raise ValueError(f"The 'skip' value for '{name}' must be a string.")
+              if 'skip_if_exists' in content and not isinstance(content['skip_if_exists'], bool):
+                raise ValueError(f"The 'skip_if_exists' value for '{name}' must be a string.")
             elif not isinstance(content, str):
               raise ValueError(f"The content of '{name}' must be a string or dictionary.")
       self.logger.info("Configuration validation passed.")

struct_module/file_item.py

@@ -25,6 +25,7 @@ def __init__(self, properties):
       self.permissions = properties.get("permissions")
       self.input_store = properties.get("input_store")
       self.skip = properties.get("skip", False)
+      self.skip_if_exists = properties.get("skip_if_exists", False)
 
       self.content_fetcher = ContentFetcher()
 
@@ -121,6 +122,11 @@ def create(self, base_path, dry_run=False, backup_path=None, file_strategy='over
         self.logger.info(f"[DRY RUN] Would create file: {file_path} with content: \n\n{self.content}")
         return
 
+      if self.skip_if_exists and os.path.exists(file_path):
+        self.logger.info(f"Skipping file creation as file exists")
+        self.logger.info(f"  File path: {file_path}")
+        return
+
       # Create the directory if it does not exist
       os.makedirs(os.path.dirname(file_path), exist_ok=True)