[docs] Update the readme blueprint for local usage #78
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
…ng a codemod locally We recently had an engineer who was not familiar with npx and could not figure out how to run a new codemod locally. I've updated the blueprint to make it clear to new users how to run a codemod locally before publishing.
rwjblue
reviewed
Mar 10, 2020
commands/global/new.js
Outdated
| @@ -37,6 +38,11 @@ module.exports.handler = async function handler(options) { | |||
| ${projectName} <TRANSFORM NAME> path/of/files/ or/some**/*glob.js | |||
| \`\`\` | |||
|
|
|||
| ## Local Usage | |||
| \`\`\` | |||
| npx ${process.cwd()}/${projectName}${cliPath} <TRANSFORM NAME> path/of/files/ or/some**/*glob.js | |||
There was a problem hiding this comment.
Do we even need npx here? I think this could be:
Suggested change
| npx ${process.cwd()}/${projectName}${cliPath} <TRANSFORM NAME> path/of/files/ or/some**/*glob.js | |
| node ./bin/cli.js <TRANSFORM NAME> path/of/files/ or/some**/*glob.js |
There was a problem hiding this comment.
You're right we don't need npx here, I was using it for consistency with the other examples but using node is probably better for local invocation.
I've made this change in the latest commit.
…ng a codemod locally We recently had an engineer who was not familiar with npx and could not figure out how to run a new codemod locally. I've updated the blueprint to make it clear to new users how to run a codemod locally before publishing.
…ng a codemod locally We recently had an engineer who was not familiar with npx and could not figure out how to run a new codemod locally. I've updated the blueprint to make it clear to new users how to run a codemod locally before publishing.
rwjblue
approved these changes
Mar 29, 2020
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.
We recently had an engineer who was not familiar with npx and could not figure out
how to run a new codemod locally.
I've updated the blueprint to make it clear to new users how to run a codemod locally before
publishing.