generator-jscodeshift

An opinionated yeoman generator for a jscodeshift codemod. This generator scaffolds out a project to get you started writing your codemod in minutes. It handily includes some nice features, such as

1. Jest testing using input/output files
2. Automatic tests for idempotency, to ensure your codemod will not bork your source files if run > 1 time
3. Eslint with prettier plugin to standardize source files

Installation

First, install Yeoman and generator-jscodeshift using npm (we assume you have pre-installed node.js).

npm install -g yo
npm install -g generator-jscodeshift

or yarn

yarn global add yo
yarn global add generator-jscodeshift

Then generate your new project:

yo jscodeshift

Getting To Know Yeoman

• Yeoman has a heart of gold.
• Yeoman is a person with feelings and opinions, but is very easy to work with.
• Yeoman can be too opinionated at times but is easily convinced not to be.
• Feel free to learn more about Yeoman.

Credits

This generator was largely made possible by the excellent work of Robert Jackson when building ember-qunit-codemod.

License

MIT © Steve Calvert