jscodeshift 0.3.26

jscodeshift is a toolkit designed specifically for running codemods across multiple JavaScript or TypeScript files. Essentially, it aids in bulk modification of JavaScript code. Two key features that jscodeshift delivers include a runner, which executes the provided transformation for each file passed to it and a wrapper around Recast, thereby facilitating AST-to-AST code transformation.

Using jscodeshift is simple. A global installation through npm is required first:

$ npm install -g jscodeshift

Once installed, you can run the jscodeshift runner via the CLI with multiple options for customization. For instance, to run a transform, you use the -t or --transform option followed by the path to the transform file:

$ jscodeshift -t myTransform.js path-to-your-source-files

If you want to run jscodeshift programmatically in a JS file, the following code can be used as an example:

const {run: jscodeshift} = require('jscodeshift/src/Runner');
const path = require('node:path');

const transformPath = path.resolve('transform.js')
const paths = ['foo.js', 'bar.js'];
const options = {
  dry: true,
  print: true,
  verbose: 1,
  // other options...
};

const response = await jscodeshift(transformPath, paths, options);
console.log(response);

In this code example, transformPath is the path to your JavaScript code transformation script, paths is an array of file paths you want to transform, and options is a object for optional parameters.

The documentation for jscodeshift can be found on the project's GitHub page here. The README in the repository provides a comprehensive guide to using jscodeshift, including installation, CLI usage, JS usage, and the jscodeshift API. Users can also find a guide on extending jscodeshift with their own functionalities. Local documentation server can be run using npm run docs and viewed using npx http-server ./docs.