jscodeshift scripts designed to migrate OpenSphere code toward ES6 modules, by performing abstract syntax tree (AST) transforms on JavaScript.
This project is configured using the config package. Scripts and transforms use config/default.json and tests use config/test.json.
If you need to override specific options, please create config/dev.json and add your overrides there. This file will be merged into the base config. For more details on how config files are merged, see the package documentation.
To generate stats on module usage within all dependencies in the configured deps file, use the yarn stats script.
This script will process the loaded deps file and output per-package stats to .build/module-stats-packages.csv and per-directory stats to .build/module-stats-dirs.csv. Stats include the number of ES6 modules, goog modules, and legacy files in each package/directory.
To exclude specific packages from the stats output, set the stats.ignoredPackages config property.
Run a transform against a project's source:
yarn run shift -t src/transforms/<transform>.js <input>
The input parameter can either be a single file, or a directory. Directories will be searched recursively for JavaScript files and all files will be modified.
By default, jscodeshift will modify input files in-place. To skip changing files and output the result of changes to the console:
yarn run dryrun -t src/transforms/<transform>.js <input>
All modified sources will be dumped in full to the console, so it's highly recommended to only do this on individual files instead of entire directories.
jscodeshift is largely a wrapper around recast. The jscodeshift repo has some API documentation available and links to a few other resources, but to some extent learning to use it will require browsing their code and a bit of Googling. Below are some resources that may be useful in this process.
- AST Explorer: Shows the abstract syntax tree of your code, and supports running jscodeshift transforms directly and displaying the result. Set the parser (
</>button) toesprima, the parser used byrecast. - awesome-jscodeshift: Compilation of
jscodeshiftresources. - List of API calls: The closest thing to an API I could find for creating AST objects with JSCS.
Use yarn test to run unit tests for transforms.
For details on how to write unit tests for transforms, please see the Unit Testing docs for jscodeshift.
To inspect transforms, add a debugger statement wherever you would like to set a breakpoint. Load chrome://inspect, click Open dedicated DevTools for Node, then run:
yarn run inspect -t <transform> <test file>
The Node process will automatically attach and break on the first line. Run the process and it will hit your first debugger statement. From there you can set breakpoints normally within Dev Tools.
To generate a listing of Closure Library usage in a source directory:
SRC_DIR=<root dir> yarn run usage
This will create .build/goog-usage, with a list of goog.* references and their ref counts.