Skip to content

Add Folder Handling and Logging Enhancements#12

Merged
httpdss merged 1 commit into
mainfrom
folders-definition
Sep 21, 2024
Merged

Add Folder Handling and Logging Enhancements#12
httpdss merged 1 commit into
mainfrom
folders-definition

Conversation

@httpdss
Copy link
Copy Markdown
Owner

@httpdss httpdss commented Sep 21, 2024

Overview

This PR introduces folder structure support in the generate and validate commands, along with improved logging functionality using colorlog for better debugging and runtime insights.

Changes

  • Folder Structure Support:
    • The generate.py script now supports creating folder structures from YAML definitions.
    • Added validation for the folder structure in validate.py, ensuring folders are correctly defined and contain a valid struct key.
  • Logging Enhancements:
    • New logging configuration file logging_config.py introduced, integrating colorlog for color-coded log output.
    • Refactored log levels in various parts of the code, changing some info logs to debug where appropriate for better verbosity control.
  • Dependency Update:
    • Added colorlog to requirements.txt to support colored logging.

Justification

The ability to define folder structures in YAML is critical for handling more complex project setups, especially for projects relying on modular directory layouts. Enhanced logging is essential for improving the traceability and debuggability of the tool's operations.

Impact

  • Teams will now be able to define and validate folder structures more easily within the configuration files.
  • Logging improvements will make debugging easier and more informative, particularly during dry runs and when setting up folder hierarchies.
  • The addition of colorlog may require updating environments to include the new dependency.

@httpdss httpdss self-assigned this Sep 21, 2024
@httpdss httpdss changed the title feat: Enhance template system with interactive input and custom Jinja… Add Folder Handling and Logging Enhancements Sep 21, 2024
@httpdss httpdss marked this pull request as ready for review September 21, 2024 15:00
@httpdss httpdss merged commit eee0e8f into main Sep 21, 2024
@httpdss httpdss deleted the folders-definition branch September 21, 2024 15:01
@httpdss httpdss linked an issue Sep 21, 2024 that may be closed by this pull request
@httpdss
Copy link
Copy Markdown
Owner Author

httpdss commented Sep 21, 2024

closes #2

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

1 participant