✨ add sub-sub components to subsections, add max recursion

- default still on subsection level
- could consider to make subsubsections instead of adding components to subsection

Author: enryH

src/vuegen/__main__.py

@@ -47,6 +47,7 @@ def main():
         output_dir=args.output_directory,
         streamlit_autorun=args.streamlit_autorun,
         quarto_checks=args.quarto_checks,
+        max_depth=args.max_depth,
     )
 
     # Print completion message

src/vuegen/config_manager.py

@@ -13,18 +13,23 @@ class ConfigManager:
     Class for handling metadata of reports from YAML config file and creating report objects.
     """
 
-    def __init__(self, logger: Optional[logging.Logger] = None):
+    def __init__(self, logger: Optional[logging.Logger] = None, max_depth: int = 2):
         """
         Initializes the ConfigManager with a logger.
 
         Parameters
         ----------
         logger : logging.Logger, optional
             A logger instance for the class. If not provided, a default logger will be created.
+        max_depth : int, optional
+            The maximum depth of the directory structure to consider when generating the report
+            config from a directory.
+            The default is 2, which means it will include sections and subsections.
         """
         if logger is None:
             logger, _ = get_logger("report")
         self.logger = logger
+        self.max_depth = max_depth
 
     def _create_title_fromdir(self, file_dirname: str) -> str:
         """
@@ -198,7 +203,7 @@ def _read_description_file(self, folder_path: Path) -> str:
         return ""
 
     def _create_subsect_config_fromdir(
-        self, subsection_dir_path: Path
+        self, subsection_dir_path: Path, level: int = 2
     ) -> Dict[str, Union[str, List[Dict]]]:
         """
         Creates subsection config from a directory.
@@ -217,7 +222,6 @@ def _create_subsect_config_fromdir(
         sorted_files = self._sort_paths_by_numprefix(
             list(subsection_dir_path.iterdir())
         )
-
         components = []
         for file in sorted_files:
             if file.is_file():
@@ -227,9 +231,17 @@ def _create_subsect_config_fromdir(
                     continue
                 # Add component config to list
                 components.append(component_config)
-            # ! if folder go into folder and pull files out?
-            # nesting level already at point 2
-            # loop of components in a folder
+            elif file.is_dir():
+                if level > self.max_depth:
+                    self.logger.warning(
+                        "Subsection nesting level exceeded: %s. Skipping.", file.name
+                    )
+                    continue
+                # components are added to subsection
+                # ! Alternatively, one could add (sub-)sections to the subsection
+                # ? Then one could remove differentiation between sections and subsections
+                nested_components = self._create_subsect_config_fromdir(file, level + 1)
+                components.extend(nested_components["components"])
 
         subsection_config = {
             "title": self._create_title_fromdir(subsection_dir_path.name),

src/vuegen/report_generator.py

@@ -18,6 +18,7 @@ def get_report(
     streamlit_autorun: bool = False,
     quarto_checks: bool = False,
     output_dir: Path = None,
+    max_depth: int = 2,  # section and subsection folders
 ) -> tuple[str, str]:
     """
     Generate and run a report based on the specified engine.
@@ -40,6 +41,10 @@ def get_report(
     output_dir : Path, optional
         The directory where the report folder will be generated.
         If not provided, the current directory will be used.
+    max_depth : int, optional
+        The maximum depth of the directory structure to consider when generating the report.
+        The default is 2, which means it will include sections and subsections. The parater
+        is only used when 'dir_path' is used.
 
     Raises
     ------
@@ -63,7 +68,7 @@ def get_report(
         logger, _ = get_logger("report", folder=_folder)
 
     # Create the config manager object
-    config_manager = ConfigManager(logger)
+    config_manager = ConfigManager(logger, max_depth=max_depth)
 
     if dir_path:
         # Generate configuration from the provided directory

src/vuegen/utils/__init__.py

@@ -246,6 +246,16 @@ def get_parser(prog_name: str, others: dict = {}) -> argparse.Namespace:
         default=False,
         help="Check if Quarto is installed and available for report generation.",
     )
+    parser.add_argument(
+        "-mdep",
+        "--max_depth",
+        type=int,
+        default=2,
+        help=(
+            "Maximum depth for the recursive search of files in the input directory. "
+            "Ignored if a config file is provided."
+        ),
+    )
     # Parse arguments
     return parser