Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

UPDATE: Scaffolding Functionality #4237

Open
8 tasks
salmad3 opened this issue Jul 3, 2024 · 0 comments
Open
8 tasks

UPDATE: Scaffolding Functionality #4237

salmad3 opened this issue Jul 3, 2024 · 0 comments
Labels
component:scaffold Feature, enhancement, or refactor related to scaffolding. epic type:refactor

Comments

@salmad3
Copy link
Member

salmad3 commented Jul 3, 2024

Context:

Several areas within the scaffolding functionality would benefit from a refactor to enhance maintainability, consistency, and efficiency.

Acceptance Criteria:

Create a new issue from the checklist once picked up and planning to take ownership. We'll scope out specifics in the new issue.

  • Upgrade to a Better Template Engine

    Evaluate the current templating approach used in scaffolding logic and consider adopting a more flexible and powerful template engine to handle complex tasks more efficiently.

  • Remove Placeholders

    Eliminate the use of placeholders while maintaining necessary messaging.
    Factorize code in templates folder #976

  • Modularize Scaffolding Logic

    Scaffolding logic is scattered across multiple files and may be tightly coupled.

  • Improve CLI Scaffolding Consistency

    CLI command definitions and flag handling may be inconsistent across different scaffolding commands.

  • Create an API for Scaffolding Features

    There is no common logic or abstraction for Extensions to access scaffolding features.

  • Improve Scaffolding Error Handling & Validation

    Error handling and validation are inconsistent and may sometimes be insufficient.

  • Improve Caching Mechanism for Scaffolding Outputs

    Scaffolding outputs can be better utilized by implementing more effective storage and reuse strategies.

  • Address Relevant and Related Issues in META: Scaffolding Enhancements  #3051

Notes:

Please feel free to edit and add to criteria.

@salmad3 salmad3 added type:refactor component:scaffold Feature, enhancement, or refactor related to scaffolding. epic labels Jul 3, 2024
@salmad3 salmad3 changed the title Scaffolding Improvements Refactor Scaffolding Functionality Jul 3, 2024
@salmad3 salmad3 changed the title Refactor Scaffolding Functionality UPDATE: Scaffolding Functionality Jul 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component:scaffold Feature, enhancement, or refactor related to scaffolding. epic type:refactor
Projects
Status: Todo
Development

No branches or pull requests

1 participant