Wrapped globSync and extracted blueprintRoot #24
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
ijlee2
force-pushed
the
refactor-wrap-glob
branch
from
6c1053b to
80985cd
Compare
ijlee2
added
enhance: documentation
ijlee2
commented
Mar 10, 2023
| @@ -30,7 +30,6 @@ function getPublicAssets(options) { | |||
|
|
|||
| const filePaths = findFiles('public/**/*', { | |||
| cwd: projectRoot, | |||
| matchFilesOnly: true, | |||
There was a problem hiding this comment.
So far, we always looked for files (and never directories).
ijlee2
commented
Mar 10, 2023
|
|
||
| test('utils | blueprints | blueprint-root', function () { | ||
| assert.strictEqual( | ||
| blueprintRoot.endsWith('src/blueprints/ember-addon'), |
There was a problem hiding this comment.
Given that the value of blueprintRoot depends on where the codemod is installed locally, the assertion using endsWith may be the strongest assertion that we can make (without leaking the implementation details in the test).
ijlee2
commented
Mar 10, 2023
Comment on lines
-94
to
-98
| if (!packageName) { | ||
| throw new SyntaxError( | ||
| `ERROR: In package.json, the package name \`${addonPackage.name}\` is not valid.` | ||
| ); | ||
| } |
There was a problem hiding this comment.
In ember-codemod-pod-to-octane, I realized that it's not a good idea to perform validation inside this function (concerns weren't separated well).
ijlee2
commented
Mar 10, 2023
Comment on lines
+111
to
+113
| /* | ||
| This object has an order dependency. The `default` key must appear last. | ||
| */ |
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.
Background
In #20, updating
globfromv8tov9involved fixing breaking changes. Fortunately, the fix wasn't difficult because I had usedglob.sync(now namedglobSync) in only two (2) different ways.Nonetheless,
globSyncis used in several files, each with a unique context (i.e. the steps are different from one another). To help onboard new contributors, we should wrapglobSyncand minimize the API that we need.What changed?
I took care of a few technical risks:
findFiles, which wrapsglobSyncand minimizes the API.unionize, which creates the brace expansion thatglobunderstands.blueprintRoot. The value depends on wherenpxinstalls the codemod on the end-developer's machine.findFilesandblueprintRoot.