Refactor info command (#16)

### Issue

<!-- Please link the GitHub issues related to this PR, if available -->

### Description

<!--
Please explain the changes you made here.

Help your reviewers by guiding them through your key changes,
implementation decisions etc.
You can even include snippets of output or screenshots.

A good, clear description == a faster review :)
-->

### Checklist

- [ ] I have read the [contributing
guidelines](https://github.com/httpdss/struct/blob/main/README.md#contributing).
- [ ] My code follows the code style of this project.
- [ ] I have performed a self-review of my own code.
- [ ] I have added tests that prove my fix is effective or that my
feature works.
- [ ] New and existing unit tests pass locally with my changes.
- [ ] I have updated the documentation accordingly.

### Screenshots (if applicable)
<!-- Add screenshots to illustrate the changes made in the pull request
-->

### Additional Comments
<!-- Add any other context or comments about the pull request here -->

Author: httpdss

.devcontainer/devcontainer.json

@@ -5,14 +5,7 @@
 	// Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
 	"image": "mcr.microsoft.com/devcontainers/python:1-3.12-bullseye",
 	"features": {
-		"ghcr.io/devcontainers/features/python:1": {
-			"installTools": true,
-			"version": "latest"
-		},
-		"ghcr.io/lentzi90/features/yamlfmt:0": {
-			"version": "v0.14.0"
-		},
-		"ghcr.io/gvatsal60/dev-container-features/pre-commit:1": {}
+
 	},
 
 	// Features to add to the dev container. More info: https://containers.dev/features.
@@ -25,7 +18,12 @@
 	"postCreateCommand": "bash ./scripts/devcontainer_start.sh",
 
 	// Configure tool-specific properties.
-	// "customizations": {},
+	"customizations": {
+    "vscode": {
+      "extensions": [
+      ]
+    }
+  },
 
 	// Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
 	"remoteUser": "root"

struct_module/commands/import.py

@@ -0,0 +1,63 @@
+from struct_module.commands import Command
+import os
+import yaml
+
+# Import command class
+# This class is responsible for importing a structure definition given a file path. It will create the structure in the base path provided.
+class ImportCommand(Command):
+  def __init__(self, parser):
+    super().__init__(parser)
+    parser.add_argument('import_from', type=str, help='Directory to import the structure from')
+    parser.add_argument('-o', '--output-path', type=str, help='Path to the output directory', default='.')
+    parser.set_defaults(func=self.execute)
+
+  def execute(self, args):
+    self.logger.info(f"Importing structure from {args.import_from} to {args.output_path}")
+
+    self._import_structure(args)
+
+
+  def _import_structure(self, args):
+    raise NotImplementedError("This method needs to be implemented")
+    # # Check if the import_from directory exists
+    # if not os.path.exists(args.import_from):
+    #   self.logger.error(f"Directory not found: {args.import_from}")
+    #   return
+
+    # # Define the path for the structure.yaml file
+    # structure_definition = os.path.join(args.output_path, 'structure.yaml')
+
+    # # Check if the output_path exists, if not, create it
+    # if not os.path.exists(args.output_path):
+    #   self.logger.warning(f"Output path not found: {args.output_path}, creating it")
+    #   os.makedirs(args.output_path)
+
+    # # Check if the structure.yaml file already exists
+    # if os.path.exists(structure_definition):
+    #   self.logger.warning(f"Structure definition already exists at {structure_definition}")
+    #   # Ask the user if they want to overwrite the existing structure.yaml file
+    #   if input("Do you want to overwrite it? (y/N) ").lower() != 'y':
+    #     return
+
+    # # Initialize the structure dictionary
+    # generated_structure = {
+    #   'structure': [],
+    #   'folders': [],
+    #   'variables': []
+    # }
+
+    # for root, dirs, files in os.walk(args.import_from):
+    #   for file in files:
+    #     self.logger.info(f"Processing file {file}")
+    #     file_path = os.path.join(root, file)
+    #     relative_path = os.path.relpath(file_path, args.import_from)
+    #     generated_structure['structure'].append(
+    #       {
+    #         'path': relative_path,
+    #         'content': open(file_path, 'r').read()
+    #       }
+    #     )
+
+    # with open(structure_definition, 'w') as f:
+    #   self.logger.info(f"Writing structure definition to {structure_definition}")
+    #   yaml.dump(generated_structure, f)

struct_module/commands/info.py

@@ -1,18 +1,54 @@
+import os
+import yaml
+
 from struct_module.commands import Command
-import struct_module
-# Info command class
+
+# Info command class for exposing information about the structure
 class InfoCommand(Command):
     def __init__(self, parser):
       super().__init__(parser)
+      parser.add_argument('structure_definition', type=str, help='Name of the structure definition')
+      parser.add_argument('-s', '--structures-path', type=str, help='Path to structure definitions')
+
       parser.set_defaults(func=self.execute)
 
     def execute(self, args):
-      version = struct_module.__version__
-      print(f"STRUCT {version}")
-      print("")
-      print("Generate project structure from YAML configuration.")
-      print("Commands:")
-      print("  generate    Generate the project structure")
-      print("  validate    Validate the YAML configuration file")
-      print("  info        Show information about the package")
-      print("  list        List available structures")
+      self.logger.info(f"Getting info for structure {args.structure_definition}")
+
+      self._get_info(args)
+
+    def _get_info(self, args):
+      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:
+        if args.structures_path is None:
+          this_file = os.path.dirname(os.path.realpath(__file__))
+          file_path = os.path.join(this_file, "..", "contribs", f"{args.structure_definition}.yaml")
+        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)
+
+      print("📒 Structure definition\n")
+      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', []):
+          for name, content in item.items():
+            print(f"       - {name} ")
+            # indent all lines of content
+            # for line in content.get('content', content.get('file', 'Not defined')).split('\n'):
+            #   print(f"       {line}")
+
+      if config.get('folders'):
+        print(f"   📌 Folders:")
+        for folder in config.get('folders', []):
+          print(f"     - {folder}")
+          # print(f"     - {folder}: {folder.get('struct', 'No structure')}")

struct_module/commands/list.py

@@ -44,6 +44,3 @@ def _list_structures(self, args):
 
     print("\nUse 'struct generate' to generate the structure")
     print("Note: Structures with '+' sign are custom structures")
-
-
-

struct_module/utils.py

@@ -34,4 +34,3 @@ def get_current_repo():
 
 
 project_path = os.path.join(os.path.dirname(os.path.realpath(__file__)), "..")
-