Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jamiemason/codemods

A collection of transforms for use with JSCodeshift
https://github.com/jamiemason/codemods

add-react-import astexplorer automated-refactoring code-transformation codemod codemods default-props jscodeshift named-exports named-imports prop-types proptypes refactoring sort-jsx sort-objects

Last synced: 11 days ago
JSON representation

A collection of transforms for use with JSCodeshift

Awesome Lists containing this project

README 

        
# codemods



> A collection of transforms for use with

> [facebook/jscodeshift](https://github.com/facebook/jscodeshift).



[![Follow JamieMason on GitHub](https://img.shields.io/github/followers/JamieMason.svg?style=social&label=Follow)](https://github.com/JamieMason)

[![Follow fold_left on Twitter](https://img.shields.io/twitter/follow/fold_left.svg?style=social&label=Follow)](https://twitter.com/fold_left)



* [🌩 Installation](#-installation)

* [🕹 Usage](#-usage)

* [⚙️ Contributing](#️-contributing)

* [📝 API](#-api)

  * [use-string-literal-props](#use-string-literal-props)

  * [add-react-import](#add-react-import)

  * [import-from-root](#import-from-root)

  * [remove-react-prop-types](#remove-react-prop-types)

  * [remove-react-default-props](#remove-react-default-props)

  * [sort-jsx-props](#sort-jsx-props)

  * [sort-object-props](#sort-object-props)

  * [use-named-exports](#use-named-exports)

  * [use-named-imports](#use-named-imports)

* [❓ Quick Intro To Making A Codemod](#-quick-intro-to-making-a-codemod)

* [🙋🏾‍♀️ Getting Help](#️-getting-help)



## 🌩 Installation



```sh

git clone https://github.com/JamieMason/codemods.git

cd codemods

yarn install

```



## 🕹 Usage



```

# yarn

yarn name-of-the-transform 



# npm

npm run name-of-the-transform -- 



# jscodeshift

jscodeshift -t ./transforms/name-of-the-transform.js 

```



## ⚙️ Contributing



Transforms can be created at `./transforms/.js` and tested by

adding example input files at

`./test/fixtures//.input.js` with the

corresponding expected output alongside it at

`./test/fixtures//.output.js`.



All fixtures are discovered and tested when running `yarn test`.



## 📝 API



### use-string-literal-props



Convert JSX props which are expressions for a string literal, into just a string literal.



```jsx

/* INPUT */

const SomeComponent = () => (

  

);



/* OUTPUT */

const SomeComponent = () => (

  

);

```



### add-react-import



Import React if it is missing from a file which uses JSX.



```jsx

/* INPUT */

export const Component = () => 



/* OUTPUT */

import React from "react";

export const Component = () => 


```



### import-from-root



Rewrite deep imports to import from a packages' root index.



> Set the Environment Variable `IMPORT_FROM_ROOT` to apply this transform only

> to packages whose name starts with that string:

> `IMPORT_FROM_ROOT=some-package yarn import-from-root `



```js

/* INPUT */

import { foo } from "some-package/foo/bar/baz";



/* OUTPUT */

import { foo } from "some-package";

```



### remove-react-prop-types



Remove use of React PropTypes.



```jsx

/* INPUT */

import React from 'react'

import PropTypes from 'prop-types'



export const Greet = ({ name }) => Hi {name}

Greet.propTypes = { name: PropTypes.string }

/* OUTPUT */

import React from 'react'



export const Greet = ({ name }) => Hi {name}

```



### remove-react-default-props



Remove use of React defaultProps.



```jsx

/* INPUT */

import React from 'react'



export const Greet = ({ name }) => Hi {name}

Greet.defaultProps = { name: 'Stranger' }

/* OUTPUT */

import React from 'react'



export const Greet = ({ name }) => Hi {name}

```



### sort-jsx-props



Sort props of JSX Components alphabetically.



```jsx

/* INPUT */



/* OUTPUT */



```



### sort-object-props



Sort members of Object Literals alphabetically.



```js

/* INPUT */

const players = { messi: true, bergkamp: true, ginola: true };



/* OUTPUT */

const players = { bergkamp: true, ginola: true, messi: true };

```



### use-named-exports



Naively convert a default export to a named export using the name of the file,

which may clash with other variable names in the file. This codemod would need

following up on with ESLint and some manual fixes.



```js

/* INPUT */

// ~/Dev/repo/src/apps/health/server.js

export default mount("/health", app);



/* OUTPUT */

// ~/Dev/repo/src/apps/health/server.js

export const server = mount("/health", app);

```



### use-named-imports



Naively convert a default import to a named import using the original name,

which may not match what the module is actually exporting. This codemod would

need following up on with ESLint and some manual fixes.



```js

/* INPUT */

import masthead from "@sky-uk/koa-masthead";



/* OUTPUT */

import { masthead } from "@sky-uk/koa-masthead";

```



## ❓ Quick Intro To Making A Codemod



1. Open [ASTExplorer][astexplorer] with the Parser set to `esprima` and

   Transform set to `jscodeshift`.

2. Paste some **Source** in the Top-Left Panel which you want to Transform.

3. Edit your **Codemod** in the Bottom-Left Panel.



There will be 4 Panels:



| Panel        | Purpose                                                        |

| :----------- | :------------------------------------------------------------- |

| Top-Left     | **Source** you want to transform                               |

| Top-Right    | The **AST** of your **Source**                                 |

| Bottom-Left  | Your **Codemod** Script                                        |

| Bottom-Right | The **Result** of applying your **Codemod** to your **Source** |



The [docs for jscodeshift](https://github.com/facebook/jscodeshift) aren't

enough and you will need to refer to ast-type [definitions] to know what is

available. Using [VariableDeclaration][variabledeclaration] as an example, you

can find all variable declarations using the PascalCase `j.VariableDeclaration`



```js

j(file.source).find(j.VariableDeclaration);

```



and create new variable declarations using the camelCase `j.variableDeclarator`.



```js

j.variableDeclaration("const", [

  j.variableDeclarator(j.identifier(fileName), exportedValue)

]);

```



The [VariableDeclaration][variabledeclaration] definition shows what `fields` it

takes, which are the arguments the `j.variableDeclarator` function takes, which

are an `Identifier` (a variable with a name but no value), or a

`VariableDeclarator` (a variable with a name as well as a value assigned).



If we look up the definition of [VariableDeclarator][variabledeclarator] we see

it takes two arguments called `id` and `init`. The `id` is an identifier

`j.identifier('varName')` and `init` is a value to initialise the variable with,

which should be the AST of whatever value you want to assign. For a simple

literal value, that would be `j.literal('hello')`.



Putting that all together you have a Hello World Codemod of:



```js

export default (file, api) => {

  const j = api.jscodeshift;



  // Have a look in the console at what APIs are available

  console.log({

    jscodeshiftAPI: j,

    fileAPI: j(file.source)

  });



  return j(file.source)

    .find(j.Program)

    .forEach(path => {

      // Unwrap the AST node from this wrapper

      const emptyFile = path.value;



      // add a comment

      const singleLineComment = j.commentLine(" Hello World");

      const varName = j.identifier("hello");

      emptyFile.comments = [singleLineComment];



      // add a const

      const literalString = j.literal("world");

      const nameValuePair = j.variableDeclarator(varName, literalString);

      const constVarStatement = j.variableDeclaration("const", [nameValuePair]);

      emptyFile.body = [constVarStatement];

    })

    .toSource();

};

```



Good luck!



## 🙋🏾‍♀️ Getting Help



- Get help with issues by creating a

  [Bug Report](https://github.com/JamieMason/codemods/issues/new?template=bug_report.md).

- Discuss ideas by opening a

  [Feature Request](https://github.com/JamieMason/codemods/issues/new?template=feature_request.md).



[astexplorer]:

  https://astexplorer.net/#/gist/47f549f753f541aff11c492c89ae82fa/e56b2df09a8e868c86139bc39ea631a0a725cbf6

[definitions]: https://github.com/benjamn/ast-types/tree/master/def

[variabledeclaration]:

  https://github.com/benjamn/ast-types/blob/v0.11.7/def/esprima.js#L9-L13

[variabledeclarator]:

  https://github.com/benjamn/ast-types/blob/a7eaba5ecc79a58acb469cbbf9fe7603cec9f57e/def/core.js#L190-L194