DS-408: Convert yeoman to plop alternative #2274
Merged
Conversation
This file contains 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
github-actions
bot
added
the
type: feature
colbytcook
temporarily deployed
to
feature/DS-408-Convert-Yeoman-to-Plop-alternative--branch-preview
adamszalapski
requested review from
cjwhitedev,
colbytcook,
danielamorse,
MarcinMr and
mikemai2awesome
colbytcook
temporarily deployed
to
feature/DS-408-Convert-Yeoman-to-Plop-alternative--branch-preview
adamszalapski
changed the title
colbytcook
temporarily deployed
to
feature/DS-408-Convert-Yeoman-to-Plop-alternative--branch-preview
colbytcook
approved these changes
Jul 28, 2021
danielamorse
reviewed
Aug 5, 2021
There was a problem hiding this comment.
@adamszalapski this is great 🎉 I thought we'd never get around to it.
I especially like:
plopseems much simpler thanyo- Well-organized "helpers"
- Testing coverage
- User input validation, e.g. "Don't include underscores"
- Uses the latest Jest test templates
One question: if you try to run yarn start immediately after creating a component/element you'll see an error:
Error: Cannot find module '@bolt/components-foo/package.json'
I think this is because yarn doesn't know about the new package yet, even though it has been added as a dependency. Running yarn fixes it. Should we automatically run yarn on create or just leave that up to the user? Do you know of another way to register the new package?
Approved once we decide on this question^
Update: I'm merging as is. We can discuss the yarn question later on.
| const boltPackageJsonPath = resolve.sync('@bolt/starter-kit/package.json') | ||
| const boltPackageJson = require(boltPackageJsonPath); | ||
|
|
||
| const updateBoltPackage = (packageName, writePath) => { |
…rnative # Conflicts: # packages/generators/yeoman-create-component/CHANGELOG.md # packages/generators/yeoman-create-component/package.json
danielamorse
deleted the
feature/DS-408-Convert-Yeoman-to-Plop-alternative
branch
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.
Jira
https://pegadigitalit.atlassian.net/browse/DS-408
Summary
Rewriting the component generator from yeoman to plop and adding the element generator.
Details
The previous yeoman generator is removed. In his place, we added a plop generator that is easier to use and more developer-friendly. Except we rewrite the component generator we add elements generator.
How to test
yarn setup.yarn ccto generate component and check if all the files are generated correctly.yarn jest packages/generators/bolt-generator/__tests__/component/bolt-generator.jsand check if all tests passed.yarn ceto generate element and check if all the files are generated correctly.yarn jest packages/generators/bolt-generator/__tests__/element/bolt-generator.jsand check if all tests passed.We need only two acceptations but I want you all to check this code.