Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

[6.x] Add folder based starter kit modules#11104

Draft
jesseleite wants to merge 32 commits into6.x from
starter-kit-module-folders
Draft

[6.x] Add folder based starter kit modules #11104
jesseleite wants to merge 32 commits into6.x from
starter-kit-module-folders

Conversation

@jesseleite
Copy link
Contributor

@jesseleite jesseleite commented Nov 11, 2024
edited
Loading

This PR adds folder based starter kit modules.

For example, you can extract a whole module config to a folder...

modules:
 seo: '@import' # import from modules/seo/module.yaml
 js:
 options:
 vue: '@import' # import from modules/js/vue/module.yaml
 react: '@import' # import from modules/js/react/module.yaml

Or control prompt flow config in your starter-kit.yaml, but import the rest from a module folder...

modules:
 seo:
 prompt: 'Would you like some awesome SEO with that!?'
 # implicitly imports from modules/seo/module.yaml
 js:
 prompt: 'Would you care for some JS?'
 skip_option: 'No, thank you!'
 options:
 vue:
 label: 'VueJS'
 # implicitly imports from modules/js/vue/module.yaml
 react:
 label: 'ReactJS'
 # implicitly imports from modules/js/react/module.yaml

The installer will implicitly attempt to import from a module.yaml config within your modules folder, again following the same hierarchy defined in your parent starter-kit.yaml config. These configs are merged when imported, with the parent config taking precedence.

I've also separated out module instantiation logic from the installer's prompt & filtering logic, for the purpose of some dev helper commands that @JohnathonKoster and I might be working on together 👀, to make flipping between modules during testing an easier thing 😎

Todo:

  • Separate out instantiation from prompting & filtering and provide flatten() & installableFiles() helpers
  • Add support for folder based modules
    • To installer
    • To exporter
  • Add test coverage
    • To installer
    • To exporter
  • Docs PR Starter kit modules updates docs#1541

aerni and robdekort reacted with heart emoji
@duncanmcclean duncanmcclean changed the title (削除) [5.x] Add folder based starter kit modules (削除ここまで) (追記) [6.x] Add folder based starter kit modules (追記ここまで) Jan 28, 2026
@duncanmcclean duncanmcclean changed the base branch from 5.x to 6.x January 28, 2026 17:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

AltStyle によって変換されたページ (->オリジナル) /