Add List Command and Enhance Structure Definition in Generate Command (#8)

#### Overview:
This pull request introduces a new command to list available structures
and enhances the `generate` command by improving how structure
definitions are handled.

#### Changes:
- **New `list` command**: 
- Introduces a `ListCommand` that lists available structure definitions
from the `contribs` directory.
  - Files ending with `.yaml` are sorted and displayed.
  
- **Enhancements to `generate` command**:
  - Refactors the `yaml_file` argument to `structure_definition`.
- Adds support for structure definition paths and checks for file
existence.
- A new optional argument `--structures-path` allows specifying a custom
directory for structure definitions.

- **Integration in main module**:
  - The new `list` command is added to the main CLI interface.

#### Justification:
These changes improve the usability of the `generate` command by
allowing more flexible paths for structure definitions and add a helpful
listing command for structure files.

#### Impact:
- The new `list` command provides an easier way for users to find
available structure definitions.
- The refactored `generate` command ensures better error handling when
structure files are not found.

Author: httpdss

struct_module/commands/generate.py

@@ -7,8 +7,9 @@
 class GenerateCommand(Command):
   def __init__(self, parser):
     super().__init__(parser)
-    parser.add_argument('yaml_file', type=str, help='Path to the YAML configuration file')
+    parser.add_argument('structure_definition', type=str, help='Path to the YAML configuration file')
     parser.add_argument('base_path', type=str, help='Base path where the structure will be created')
+    parser.add_argument('-s', '--structures-path', type=str, help='Path to structure definitions', default='contribs')
     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')
@@ -17,7 +18,7 @@ def __init__(self, parser):
     parser.set_defaults(func=self.execute)
 
   def execute(self, args):
-    self.logger.info(f"Generating structure at {args.base_path} with config {args.yaml_file}")
+    self.logger.info(f"Generating structure at {args.base_path} with config {args.structure_definition}")
 
     if args.backup and not os.path.exists(args.backup):
       os.makedirs(args.backup)
@@ -30,8 +31,17 @@ def execute(self, args):
 
 
   def _create_structure(self, args):
-    with open(args.yaml_file, 'r') as f:
-      config = yaml.safe_load(f)
+    if args.structure_definition.startswith("file://") and args.structure_definition.endswith(".yaml"):
+      with open(args.structure_definition[7:], 'r') as f:
+        config = yaml.safe_load(f)
+    else:
+      file_path = os.path.join(args.structures_path, f"{args.structure_definition}.yaml")
+      # show error if file is not found
+      if not os.path.exists(file_path):
+        self.logger.error(f"File not found: {file_path}")
+        return
+      with open(file_path, 'r') as f:
+        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', [])

struct_module/commands/list.py

@@ -0,0 +1,21 @@
+from struct_module.commands import Command
+import os
+import yaml
+from struct_module.file_item import FileItem
+
+# List command class
+class ListCommand(Command):
+  def __init__(self, parser):
+    super().__init__(parser)
+    parser.set_defaults(func=self.execute)
+
+  def execute(self, args):
+    self.logger.info(f"Listing available structures")
+    self._list_structures()
+
+  def _list_structures(self):
+    print("Listing available structures")
+    sorted_list = [structure for structure in os.listdir('contribs') if structure.endswith('.yaml')]
+    sorted_list.sort()
+    for structure in sorted_list:
+      print(f" - {structure[:-5]}")

struct_module/main.py

@@ -5,6 +5,7 @@
 from struct_module.commands.generate import GenerateCommand
 from struct_module.commands.info import InfoCommand
 from struct_module.commands.validate import ValidateCommand
+from struct_module.commands.list import ListCommand
 
 
 
@@ -23,6 +24,7 @@ def main():
     InfoCommand(subparsers.add_parser('info', help='Show information about the package'))
     ValidateCommand(subparsers.add_parser('validate', help='Validate the YAML configuration file'))
     GenerateCommand(subparsers.add_parser('generate', help='Generate the project structure'))
+    ListCommand(subparsers.add_parser('list', help='List available structures'))
 
     args = parser.parse_args()