Add Argcomplete for Command-Line Auto-Completion & Completer Functions (#10)

**Overview:**
This pull request introduces command-line auto-completion for the
`struct` script using the `argcomplete` library, along with some
refactoring and enhancements in the command structure. Additionally,
completer functions are implemented to streamline argument handling.

**Changes:**
- Added `argcomplete` for auto-completion in the `Dockerfile` and Python
scripts.
- Updated the `README.md` with instructions for enabling
auto-completion.
- Modified YAML template files to use a consistent syntax for variables
(`{{@ var @}}`).
- Integrated command-line completers for options such as `log_level` and
`file_strategy` in the `struct_module`.
- Updated the `requirements.txt` to include `argcomplete`.
- Created tests for filter functions, focusing on `get_latest_release`
and `stringify`.

**Justification:**
The inclusion of command-line auto-completion improves the developer
experience by allowing faster and more accurate command entry. The added
completers make commands more user-friendly and reduce errors during
input. YAML files have been refactored for better consistency.

**Impact:**
- Users will now benefit from auto-completion when using the `struct`
script.
- The new completion functionality will require reloading of shell
configuration for it to take effect.
- Refactored YAML templates and improved testing coverage enhance
maintainability and consistency.

Author: httpdss

.github/workflows/test-script.yaml

@@ -4,9 +4,9 @@ on:
   push:
     branches:
       - main
-  # pull_request:
-  #   branches:
-  #     - main
+  pull_request:
+    branches:
+      - main
 
 jobs:
   build:

Dockerfile

@@ -10,8 +10,14 @@ COPY requirements.txt .
 # Install any needed packages specified in requirements.txt
 RUN pip install --no-cache-dir -r requirements.txt
 
+# Install argcomplete and activate global completion
+RUN pip install argcomplete
+
 # Copy the rest of the working directory contents into the container at /app
 COPY . .
 
+# Register the script for auto-completion
+RUN echo 'eval "$(register-python-argcomplete struct)"' >> /etc/bash.bashrc
+
 # Run your script when the container launches
 ENTRYPOINT ["python", "struct_module/main.py"]

README.md

@@ -208,6 +208,40 @@ pip install -r requirements.txt
 pip install -r requirements.dev.txt
 ```
 
+## 🛠️ Command-Line Auto-Completion
+
+This project uses [argcomplete](https://kislyuk.github.io/argcomplete/) to provide command-line auto-completion for the `struct` script. Follow these steps to enable auto-completion:
+
+1. **Install `argcomplete`**:
+
+    ```sh
+    pip install argcomplete
+    ```
+
+2. **Enable global completion** for your shell. This step is usually done once:
+
+    ```sh
+    activate-global-python-argcomplete
+    ```
+
+3. **Register the script for auto-completion**. Add the following line to your shell's configuration file (e.g., `.bashrc`, `.zshrc`):
+
+    ```sh
+    eval "$(register-python-argcomplete struct)"
+    ```
+
+4. **Reload your shell configuration**:
+
+    ```sh
+    source ~/.bashrc  # or source ~/.zshrc for Zsh users
+    ```
+
+After completing these steps, you should have auto-completion enabled for the `struct` script. You can test it by typing part of a command and pressing `Tab` to see the available options.
+
+```sh
+struct <Tab>
+```
+
 ## 📜 License
 
 This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

contribs/documentation-template.yaml

@@ -1,7 +1,7 @@
 structure:
   - README.md:
       content: |
-        # {{% project_name %}}
+        # {{@ project_name @}}
 
         Brief description of the project.
 
@@ -18,7 +18,7 @@ structure:
         Guidelines for contributing to the project.
   - CONTRIBUTING.md:
       content: |
-        # Contributing to {{% project_name %}}
+        # Contributing to {{@ project_name @}}
 
         ## How to Contribute
         Guidelines for how to contribute to the project.

contribs/kubernetes-manifests.yaml

@@ -4,22 +4,22 @@ structure:
         apiVersion: apps/v1
         kind: Deployment
         metadata:
-          name: {{% deployment_name | stringify %}}
+          name: {{@ deployment_name | stringify @}}
           labels:
-            app: {{% app_name | stringify %}}
+            app: {{@ app_name | stringify @}}
         spec:
           replicas: 2
           selector:
             matchLabels:
-              app: {{% app_name | stringify %}}
+              app: {{@ app_name | stringify @}}
           template:
             metadata:
               labels:
-                app: {{% app_name | stringify %}}
+                app: {{@ app_name | stringify @}}
             spec:
               containers:
-              - name: {{% app_name | stringify %}}
-                image: {{% image_name %}}:{{% image_tag %}}
+              - name: {{@ app_name | stringify @}}
+                image: {{@ image_name @}}:{{@ image_tag @}}
                 ports:
                 - containerPort: 80
   - service.yaml:
@@ -30,7 +30,7 @@ structure:
           name: example-service
         spec:
           selector:
-            app: {{% app_name | stringify %}}
+            app: {{@ app_name | stringify @}}
           ports:
             - protocol: TCP
               port: 80
@@ -84,18 +84,18 @@ structure:
         ```
 
 variables:
-  app_name:
-    description: "The name of the application."
-    type: string
-    default: "example-app"
-  deployment_name:
-    description: "The name of the deployment"
-    type: string
-    default: "example-app-deployment"
-  image_name:
-    description: "The name of the Docker image."
-    type: string
-  image_tag:
-    description: "The tag of the Docker image."
-    type: string
-    default: "latest"
+  - app_name:
+      description: "The name of the application."
+      type: string
+      default: "example-app"
+  - deployment_name:
+      description: "The name of the deployment"
+      type: string
+      default: "example-app-deployment"
+  - image_name:
+      description: "The name of the Docker image."
+      type: string
+  - image_tag:
+      description: "The tag of the Docker image."
+      type: string
+      default: "latest"

contribs/terraform-app.yaml

@@ -2,7 +2,7 @@ structure:
   - main.tf:
       content: |
         # This is the main Terraform app main file.
-        touch_file: {{% now().strftime('%Y-%m-%d') %}}
+        touch_file: {{@ now().strftime('%Y-%m-%d') @}}
   - variables.tf:
       content: "# This is the Terraform variables file."
   - outputs.tf:

contribs/terraform-module.yaml

@@ -19,12 +19,17 @@ structure:
         }
   - README.md:
       content: |
-        # {{% module_name %}}
+        # {{@ module_name @}}
         This module provisions an EC2 instance on AWS.
         ## Usage
         ```hcl
         module "example" {
-          source = "./path/to/module/{{% module_name | stringify %}}"
+          source = "./path/to/module/{{@ module_name | stringify @}}"
           instance_type = "t2.micro"
         }
         ```
+variables:
+  - module_name:
+      description: "The name of the module."
+      type: string
+      default: "example-module"

requirements.txt

@@ -4,3 +4,4 @@ openai
 python-dotenv
 jinja2
 PyGithub
+argcomplete

struct_module/commands/__init__.py

@@ -1,4 +1,5 @@
 import logging
+from struct_module.completers import log_level_completer
 
 # Base command class
 class Command:
@@ -8,7 +9,7 @@ def __init__(self, parser):
       self.add_common_arguments()
 
     def add_common_arguments(self):
-      self.parser.add_argument('-l', '--log', type=str, default='INFO', help='Set the logging level (DEBUG, INFO, WARNING, ERROR, CRITICAL)')
+      self.parser.add_argument('-l', '--log', type=str, default='INFO', help='Set the logging level (DEBUG, INFO, WARNING, ERROR, CRITICAL)').completer = log_level_completer
       self.parser.add_argument('-c', '--config-file', type=str, help='Path to a configuration file')
       self.parser.add_argument('-i', '--log-file', type=str, help='Path to a log file')
 

struct_module/commands/generate.py

@@ -2,6 +2,7 @@
 import os
 import yaml
 from struct_module.file_item import FileItem
+from struct_module.completers import file_strategy_completer
 
 # Generate command class
 class GenerateCommand(Command):
@@ -13,7 +14,7 @@ def __init__(self, parser):
     parser.add_argument('-d', '--dry-run', action='store_true', help='Perform a dry run without creating any files or directories')
     parser.add_argument('-v', '--vars', type=str, help='Template variables in the format KEY1=value1,KEY2=value2')
     parser.add_argument('-b', '--backup', type=str, help='Path to the backup folder')
-    parser.add_argument('-f', '--file-strategy', type=str, choices=['overwrite', 'skip', 'append', 'rename', 'backup'], default='overwrite', help='Strategy for handling existing files')
+    parser.add_argument('-f', '--file-strategy', type=str, choices=['overwrite', 'skip', 'append', 'rename', 'backup'], default='overwrite', help='Strategy for handling existing files').completer = file_strategy_completer
     parser.add_argument('-p', '--global-system-prompt', type=str, help='Global system prompt for OpenAI')
     parser.set_defaults(func=self.execute)