jscodeshift

Minor Changes

• e5fe5be: Bumps recast to resolve a bug where JSX elements are wrapped in two pairs of parenthesis

Patch Changes

• 8f60fbf: Enable async tranformers in test utils. All notable changes to this project will be documented in this file.

[17.1.1] 2024-10-31

Fixed

• Republished with temp dependency properly removed (#638, thanks @trivikr for reporting)

[17.1.0] 2024-10-30

Added

• pkg.pr.new will now be used to build an npm pakage for each commit to the repo, allowing you to more easily test changes or use new features before an official release is cut. (#622, @Aslemammad)

Changed

• Replaced temp library with tmp (#633, @r4zendev)

Fixed

• Removed old docs command from package.json since the new docs are in the website folder, which has instructions in its README.

[17.0.0] 2024-08-06

We needed to go from v0.x to a major release, and it may as well happen now. jscodeshift has been around for nine years though, so going to v1.0.0 didn't feel quite right. I've instead promoted the minor version number to a major version number, similar to what React did when it went from 0.14 to 15.0.

Fixed

• Node.js 16 is now explicitly specified as the minimum required version. It was already required due to some dependencies requiring it, but this makes it explicit (#607, @trivikr)

Added

• A new jscodeshift website has launched, thanks to the team at Codemod. (#592, @mohab-sameh with some tweaks by @morinokami)
• Added collection functions for import declarations, including finding imports and inserting new imports (#617, @danieldelcore)

Changed

• Enabled TypeScript importAttributes (#585, @benasher44) and decoratorAutoAccessors (#594, @syi0808) plugins
• Removed or replaced various outdated and unused dependencies (#601, #605, #609, #613, @trivikr)
• Started using Corepack to manage Yarn version (#599, @trivikr)

Fixed

• Removed old babel-core dependency that was unused but caused security scanners to flag vulnerabilities.

Added

• Added a --gitignore flag to avoid transforming any files listed in .gitignore (#508, @ElonVolo)

Changed

• Updated various dependencies to latest version (#588, @ElonVolo)

Fixed

• Process all supported extensions by default (#584, @trivikr)

Changed

• Upgraded to recast 0.23.3 (#564, @ashsearle)
• Enable @babel/plugin-proposal-private-methods in worker (#568, @sibelius)
• Upgraded Babel packages (#570, @dartess)

Fixed

• Respect extensions cli option when filtering individual files (#562, @robcmills)
• Fixed unit test after #562 broke them (#575, @ElonVolo)

Changed

• Upgraded to recast 0.23.1 (#544, @ryanrhee)
• Make @babel/preset-env optional (#480, @SimenB)

Fixed

• Force LF line ending in bin/jscodeshift.sh (#555, @jakeboone02)
• Use transform's exported parser in testUitls (#528, @CrispyBacon12)
• Ensure jscodeshift doesn't load Babel config file (#460, @raon0211)

Added

• Added a defineSnapshotTestFromFixture test util (#471, @shriuken)
• Added renameTo filters for Babel 6+ node types (#412 and #504, @elonvolo and @henryqdineen)
• Added childNodesOfType to JSX traversal methods (#415, @j13huang)

Changed

• Bumped dependency versions
• Allow arguments in --help to be listed in an order other than alphabetically, so they can instead be grouped thematically (#507, @elonvolo)
• Allow the j shortcut in test utils (#515, @no23reason)

Changed

• Switched from colors to chalk to mitigate a security vulnerability in colors@1.4.1.

Full Changelog: https://github.com/facebook/jscodeshift/compare/0.13.0...0.13.1

Added

• Added a --fail-on-error flag to return a 1 error code when errors were found (#416, @marcodejongh)
• Created template.asyncExpression (#405, @jedwards1211)

Changed

• Removed lodash dependency from tsx parser (#432, @JHilker and @robyoder)

Changed

• Allow transform to be a Promise (#237, @rektide)
• Support newer TypeScript syntax by upgrading to newer Babel parser (#410, @wdoug and @mfeckie)

Changed

• Updated recast to latest

Changed

• Updated flow-parser to latest, and enabled Flow Enums parsing by default when using Flow parser

Changed

• Dropped support for Node versions 6 and 8

Added

• Added jest snapshot utils (#297, @dogoku)

Changed

• Moved from BSD to MIT license

Fixed

• No longer throw an error when calling jscodeshift on a non-existent path (#334, @threepointone)
• Preserve the original file extension in remote files (#317, @samselikoff)

Changed

• Allow writing tests in TypeScript (#308)
• Better handling of .gitingore files: Ignore comments and support \r\n line breaks (#306)

Fixed

• Don't throw an error when jscodeshift processes an empty set of files (#295, @skovhus).
• renameTo should not rename class properties (#296, @henryqdineen).
• Custom/unknown CLI parameters are parsed as JSON, just like nomnom used to do.

Changed

• @babel/register/@babel/preset-env is configured to not transpile any language features that the running Node process supports. That means if you use features in your transform code supported by the Node version you are running, they will be left as is. Most of ES2015 is actually supported since Node v6.
• Do not transpile object rest/spread in transform code if supported by running Node version.

Fixed

• Presets and plugins passed to @babel/register are now properly named and loaded.

Added

• Tranform files can be written in Typescript. If the file extension of the transform file is .ts or .tsx, @babel/preset-typescript is used to convert them. This requires the --babel option to be set (which it is by default). ( #287 , @brieb )

Changed

• The preset and plugins for converting the transform file itself via babeljs have been updated to work with babel v7. This included removing babel-preset-es2015 and babel-preset-stage-1 in favor of @babel/preset-env. Only @babel/proposal-class-properties and @babel/proposal-object-rest-spread are enabled as experimental features. If you want to use other's in your transform file, please create a PR.

Fixed

• Typescript parses use @babel/parser instead of Babylon ( #291, @elliottsj )

Bumped

• micromatch => v3.1.10, which doesn't (indirectly) depend on randomatic < v3 anymore (see #292).

A bunch of changes to get jscodeshift in a better shape. This is minor version update because important dependencies and parser configurations have changed.

---

New

• New CLI option --parser-config: This option accepts a path to a JSON file and overrides the default options for flow or babylon. This allows you to tweak parser settings (e.g. legacy decorators). (46d250f)
• New CLI option --stdin: If provided, the list of files/directories is read from stdin. This makes it easier to pass large lists of files. (b6eaa0a)
• New API in transforms: api.report lets you print arbitrary text to stdout. Useful if another tools consumes jscodeshift's stdout. (c902a00) Example:

// In the transform
api.report('some data');

// in stdout
 REP path/to/file.js some data

• Support for Typescript source code, via babylon ( #286 ; @brieb). Use --parser=ts or --parser=tsx.

Improvements

• Updated babylon to v7 adding support for newer flow features (#282 , @wanderley )
• Updated recast to v0.16, which includes a bunch of printing improvments (#289 , @majapw )
• Enable more features in babylon and flow (#278 , @mjesun ; #281 , @jbrown215 )
• Improve handling of large lists of files (62b12ad, 9c83c39)

Fixes

• JSXElements's hasAttributes method understands value-less Boolean attributes (#277 , @artemruts )
• More reliable printing to stdout (62b12ad)

Internal

• Replaces deprecated nomnom with own implementation (a2becc5)
• Remove direct dependency on lodash (4701096)

New

• Bump recast and babylon to support JSX fragments (#239)
• Add dynamicImport plugin to babylon parser. (#208)
• Allow specifying a testName for inline tests (#218)
• Add some() and every() methods for Collection (#216)

Fixed/Improved

• Fix error handling for http (#242)
• Perf: replace async with neo-async (#241)
• Fix renameTo renaming React component prop name unexpectedly (#220)
• Fix renameTo not taking property shorthands into account (#211)

New

@TheSavior added the possibility to define tests inline, without having to create separate files for input and output:

const transform = require('../myTransform');
defineInlineTest(transform, {}, 'input', 'expected output');

#204

Fixes

• Printing issues by bumping recast and babylon versions ( #200 , #201 @xixixao)
• Bug with template.expression when a literal with no interpolation was used ( #196, @jsnajdr)

Internally

• Drop usage of es6-promise ( #189, @wtgtybhertgeghgtwtg)

---

Thank you @xixixao, @jsnajdr and @wtgtybhertgeghgtwtg for contributing!

Fixes

• Write changes to files atomically (#156, @alangpierce)
• Fix placeholder holder associate in template builders (#163, @robz)

New

• Collections now have a .length property which is equivalent to .size() (#151, @DrewML)

• You can now reference jscodeshift as j directly from the transform's API options. I.e. you can write

  export default function transformer(file, { j }) {
    return j(file.source).toSource();
  }
  

  instead of

  export default function transformer(file, api) {
    const j = api.jscodeshift;
  
    return j(file.source).toSource();
  }
  

  or

  export default function transformer(file, {jscodeshift: j}) {
    return j(file.source).toSource();
  }
  

  (#153, @vjeux)

Improved

• Experimental settings have been enabled for the flow parser, so it is now be able to process files that use e.g. public class fields (a2e4a3a)

New

• .editorconfig file ( #142 , @DrewML )

Changed

• Better error message when using .get on an empty collection ( #140 , @DrewML )
• jscodeshift now depends on recast v0.11.11 which adds better support for new flow type constructs.

Fixes

• Use all CPUs if only one is available ( #137, @daedalus28 )
• Don't error if error stack trace is not available ( #134, 20422bda773a257662d7d6b52010a31aa4e5b39f )

New

• Return value of Runner.run includes elapsed time and stats collected via stats method ( #128, @iamdustan).
• jscodeshift --version also prints the used recast version ( #131, @keyanzhang)

Fixes

• renameTo ignores Identifiers that are not variable references ( #125, Robby Nevels)
• Transformers / codemods can use experimental features ( >= stage 1) and flow type annotations again (28eb51508dca2aa70f9a454d3247ee2e08fcf4ae). This was a regressions.

Fixed

• testUtils supports custom parsers (e5fb37d0c43475fa20181dd542a3a250680138df)
• testUtils also passes a stub for the stats method to the transformer (e5fb37d0c43475fa20181dd542a3a250680138df)

Fixed

• Fixed stats output in dry run. Thanks @gaearon for noticing.

Fixed

• Fixes an issue with using jscodeshift inside jest unit tests ( #122 )

Fixed: jscodeshift installation

Seems like npm cannot handle local files (#120) :-/

New: Choose your parser

Problem: jscodeshift uses Babel v5 to parse source files. Since Babel v5 doesn't get updated anymore, jscodeshift is unable to parse files that contain more modern flow type annotation.

To solve this, jscodeshift now supports three parsers, babel v5, babylon and flow, and even allows you to pass your own. Babel v5 still stays the default parser, but we will likely use another parser (babylon or flow) as default in the future. Having the option to pass a custom parser allows us to experiment which works best with jscodeshift/recast.

How to choose a parser

CLI

--parser allows you specify one of the built-in parsers from the command line: --parser=babelv5, --parser=babylon, --parser=flow.

API

jscodeshift now accepts a second argument that is directly passed to recast's parse method. This allows you to load your own parser, as long as it is compatible with recast:

jscodeshift(source, {parser: require('myParser')})

Transformer

The value of the parser export of the transformer is used as parser. The value can either be the name of one of the built-in parsers (babel, babylon, flow) or an object that can be directly passed to recast.parse.

Examples:

export const parser = 'flow';
// or
export {default as parser} from 'myParser';

This allows transformers to specify their own parser (as long as it is compatible with ESTree / recast), making them a bit more independent from jscodeshift's internals.

---

jscodeshift --version now also lists the versions of the built-in parsers

$ jscodeshift --version
jscodeshift: 0.3.21
 - babel: 5.8.38
 - babylon: 6.8.1
 - flow: 0.26.0

Reinstalling jscodeshift is probably the simplest way for now to update the built-in parsers.

New

• --ignore-pattern and --ignore-file command line arguments, which allow you to specify paths to ignore when using jscodeshift to traverse over a dictionary ( #107 , @chrisdarroch )

• jscodeshift.use which you can pass a plugin too. A plugin would a function that accepts a jscodeshift instance and calls registerMethods on it. This allows plugins to be decoupled form jscodeshift. In addition, if .use is called with the same plugin multiple times, subsequent calls are ignored.

  Example:

  function myPlugin(jscodeshift) {
    jscodeshift.registerMethods({
      myExtension() { ... },
    }, jscodeshift.Identifier);
  }
  
  jscodeshift.use(myPlugin);
  

  ( #108 , @jamestalmage )

• Better registerMethods method! Until now, it was impossible to register two methods with the same name, even if it was attached to different types (and therefore, conceptually, different collections). @jamestalmage changed this in #110 and and now it's possible to register such methods if the types are not super- or sub-types.

  Example:

  jscodeshift.registerMethods({
    rename() { ... },
  }, j.Identifier);
  
  jscodeshift.registerMethods({
    rename() { ... },
  }, j.VariableDeclarator);
  

• Unit tests for transforms: @Daniel15 added helper methods to make writing unit tests easier ( #104 ) . See the readme and the example for more information.

  This results in a directory structure like this:

    /MyTransform.js
    /__tests__/MyTransform-test.js
    /__testfixtures__/MyTransform.input.js
    /__testfixtures__/MyTransform.output.js
  

  To define a test, use defineTest from the testUtils module:

    jest.autoMockOff();
    const defineTest = require('jscodeshift/dist/testUtils').defineTest;
    defineTest(__dirname, 'MyTransform');
  

Fixes

• Fixed hanging worker processes under certain conditions (we weren't able to find out the exact reasons but it looks like it involves processing at least 75 files) ( #102 ).
• Added missing line breaks to CLI output.

Internals

• Switched to jest 0.9.2.

Fixes

Fixed log output ( #101 )

Fixes

Both jscodeshift -t ... foo and jscodeshift -t ... foo/ work now ( #100 )

Fixes

• Installation issue (missing module)
• Typo (process.std vs process.stdout)

New

@iamdustan added supported for passing URLs to -t to load transforms remotely ( #94, #95 )

jscodeshift -t http://path/to/script.js

Note: That script cannot have any external dependencies, it has to be entirely self-contained.

Fixes

• Fix run-in-band ( #96, @zertosh )

Improvements

@avikchaudhuri improved invalid symlink handling ( #92 ) and worker performance ( #93 )!

Fixes

Ignore local .babelrc files. This fixes issues with running jscodeshift on code that was in a project that uses Babel. ( #85 ). Thanks to @sviridov!

Fixes

Fixed filtering for .closest method ( #83). Thanks @juliankrispel!

New

The --slient / -s option suppresses logging to the console ( #79 , #60 ).

New

--run-in-band option makes jscodeshift execute all transformations in the main process instead of splitting up over multiple workers. Useful for debugging. (#71, @zertosh)

Fixes

• Fixed promise (chain) returned by .run (#69). The code used to perform an invalid operation which let the promise fail always.

Improvements

• jscodeshift.match and many methods that accept an object as second argument for filtering / pattern matching (e.g. .find) now also accept functions / objects containing functions. This allows you to write more complex filters more easily.

  Example:

  j(source)
  .find(j.VariableDeclarator, {id: node => node.name === 'foo' || node.name === 'bar'})
  

finds all VariableDeclarators whose identifier is either named "foo" or "bar".

Internal changes

jscodeshift switched to jest v0.5.10, which means that tests will only run in Node v4+. jscodeshift will likely continue to function in older Node versions though.

New

• .run returns a promise that is resolved once all workers are done
• .at accepts negative indexes to get a collection of a node from the end of the current collection

Fixes

.remove now returns the collection itself

Fixes

• Fix .closest not correctly applying filter argument (#41)

Fixes

• File extension filter only applies to files in traversed directories, not to directly passed files
• Enforce latest recast version that fixes some printing issues
• Remove esprima-fb dependency

Changes

• Depend on babel-core instead of babel

Fixes

• No worker spawned when using --cpu option.