fix(codemod): Pass codemod options to jscodeshift script #2137
Conversation
|
|
| .options({ | ||
| 'ignore-config': { | ||
| type: 'string', | ||
| describe: 'Ignore files if they match patterns sourced from a configuration file (e.g. a .gitignore)', | ||
| default: '', | ||
| }, | ||
| 'ignore-pattern': { | ||
| type: 'string', | ||
| describe: 'Ignore files that match a provided glob expression (e.g. **/dist/**)', | ||
| default: '**/node_modules/**', | ||
| }, | ||
| verbose: { | ||
| type: 'number', | ||
| describe: 'Show more information about the transform process', | ||
| default: 0, | ||
| choices: [0, 1, 2] | ||
| }, | ||
| }) |
There was a problem hiding this comment.
Putting these options here allows them to be available for all our codemod scripts.
There was a problem hiding this comment.
Options are pulls from the jscodeshift docs: https://github.com/facebook/jscodeshift#usage-cli
alanbsmith
added
ready for review
Passing run #5521 ↗︎
Details:
This comment has been generated by cypress-bot as a result of this project's GitHub integration settings. |
|||||||||||||||
| ``` | ||
|
|
||
| > Note: These codemods only work on .js, .jsx, .ts, and .tsx extensions. You may need to make some manual changes in other file types (.json, .mdx, .md, etc.). | ||
| > Note: These codemods only work on .js, .jsx, .ts, and .tsx extensions. You may need to make some | ||
| > manual changes in other file types (.json, .mdx, .md, etc.). |
There was a problem hiding this comment.
why is in highlighted differently here?
There was a problem hiding this comment.
That's GitHub trying to syntax highlight correctly and making a mistake. It thinks it's a keyword.
|
should this go into support as well? |
|
It could go to support, but I'm mostly wanting these improvement for folks who still need to move to v8 (and eventually v9). Most consumers are on v7 already. |
alanbsmith
added
approved
Summary
Fixes: #2136
The codemod was ignoring valid JSCodeshift options that are helpful to optimize the script. This patch allows
--ignore-pattern,--ignore-config, and--verboseto be passed through. I also set the codemod to ignorenode_modulesdirectories by default and updated the docs.Release Category
Codemods
Checklist
ready for reviewhas been added to PRFor the Reviewer
Where Should the Reviewer Start?
Areas for Feedback? (optional)
Testing Manually
There's not a great way to test this manually, but if the codemod tests pass, it works. I added the output of running this updated script in another consumer repo to show that it works as expected.
Screenshots or GIFs (if applicable)
Thank You Gif (optional)