[FEATURE] Add config option for custom name choices#3
Merged
ahoendgen merged 2 commits intoJan 23, 2023
Merged
Conversation
This was referenced Feb 23, 2022
2ebb8c6 to
2f30949
Compare
Contributor
Author
|
@ahoendgen let me know what you think of this PR. This and the others (#4 #5) have been really useful for our workflow and we hope they can help other people who use your tool. I'm happy to make any changes you need to these. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Proposal
The current plop generator uses standard naming conventions from atomic design as the name suggests.
In our workflow, we're using NextJS which includes a
pagesdirectory at the root of the project (which is not rename-able) used for page routes. To avoid confusion we wanted to modify that topage-components.To do this we added an option to customize the atomic name choices. This has the added benefit of letting a group use atomic design principles while being creative with how what they're called.
Usage
The project defaults to using the original atomic names, and the config is not required to exist.
To customize the name choices, add the following option to the plopfile
atomicGeneratorconfig with whichever custom names you'd like to use:Goal is to add an option to customize the name choices in the prompt and directories used.