uber-web / uber-codemods

Because Code Changes and Evolves

uber-codemods

A collection of code-changing JSCodeshift's for JavaScript.

Install

npm install -g jscodeshift
npm install uber-codemods
jscodeshift -t node_modules/uber-codemods/<codemod-name> <transform-path>

Use the -d option for a dry-run and use -p to print the output for comparison.

Included mods

r-dom-to-react-create-element

Replaces all uses of r-dom with React's createElement(). After this conversion, you can optionally use the create-element-to-jsx codemod to generate jsx.

Usage

jscodeshift -t node_modules/uber-codemods/src/r-dom-to-react-create-element.js <transform-path>

Code Examples

Before

After

replace-require

Replaces all requires and imports of toReplace with replaceWith. Takes two options via the cli. Also replaces sub-paths in your require/import statements.

Usage

jscodeshift -t node_modules/uber-codemods/src/replace-require.js <transform-path> --toReplace="object.omit" --replaceWith="just-omit"

Code Examples

Before

After

replace-require-absolute-path

Replaces all requires and imports of toReplace with the relative path to replaceWith. Takes two options via the cli. The reason this is needed as a separate mod from replace-require is because the relative path to replaceWith changes relative to the current file being evaluated by jscodeshift.

Usage

jscodeshift -t node_modules/uber-codemods/src/replace-require-absolute-path.js <transform-path> --toReplace="object.omit" --replaceWith=$(pwd)/just-omit

xtend-to-spread

Replaces all uses of xtend with the es6 spread operator.

Usage

jscodeshift -t node_modules/uber-codemods/src/xtend-to-spread.js <transform-path>

Code Examples

Before

After

License

MIT © Uber

uber-codemods's Issues

🐛 replace-require data-type failure

It's understood that this comes from an assumption about the data-type of an underlying literal. Assuming it's a string when it's not, there are string operations which are called on the data type. Should be fixable with an additional filter.

 ERR /var/folders/tv/fdtq5cgn6zq4bj1_lzvrhl7h0000gn/T/3848786987-<module-name>-<version>/package/test/tasks/version-assets.js Transformation error
Error: {value: [object Object], parentPath: [object Object], name: init, __childCache: null} does not match type Printable
    at Type.Tp.assert (/Users/dawsonbotsford/.config/yarn/global/node_modules/jscodeshift/node_modules/ast-types/lib/types.js:60:19)
    at genericPrintNoParens (/Users/dawsonbotsford/.config/yarn/global/node_modules/jscodeshift/node_modules/recast/lib/printer.js:219:26)
    at genericPrint (/Users/dawsonbotsford/.config/yarn/global/node_modules/jscodeshift/node_modules/recast/lib/printer.js:164:9)
    at printRootGenerically (/Users/dawsonbotsford/.config/yarn/global/node_modules/jscodeshift/node_modules/recast/lib/printer.js:105:15)
    at maybeReprint (/Users/dawsonbotsford/.config/yarn/global/node_modules/jscodeshift/node_modules/recast/lib/printer.js:97:16)
    at print (/Users/dawsonbotsford/.config/yarn/global/node_modules/jscodeshift/node_modules/recast/lib/printer.js:75:29)
    at exports.printComments (/Users/dawsonbotsford/.config/yarn/global/node_modules/jscodeshift/node_modules/recast/lib/comments.js:324:22)
    at printWithComments (/Users/dawsonbotsford/.config/yarn/global/node_modules/jscodeshift/node_modules/recast/lib/printer.js:61:16)
    at FastPath.call (/Users/dawsonbotsford/.config/yarn/global/node_modules/jscodeshift/node_modules/recast/lib/fast-path.js:113:18)
    at genericPrintNoParens (/Users/dawsonbotsford/.config/yarn/global/node_modules/jscodeshift/node_modules/recast/lib/printer.js:867:18)

replace-require sub-paths

When calling replace-require() for thing -> replaceme on require('thing/sub'), it should create require('replaceme/sub'). Instead, it creates require('thing/sub').