Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/5to6/5to6-codemod
A collection of codemods that allow you to transform your js code from ES5 to ES6.
https://github.com/5to6/5to6-codemod
Last synced: 3 months ago
JSON representation
A collection of codemods that allow you to transform your js code from ES5 to ES6.
- Host: GitHub
- URL: https://github.com/5to6/5to6-codemod
- Owner: 5to6
- Created: 2015-12-22T17:29:04.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2023-01-03T18:55:01.000Z (over 1 year ago)
- Last Synced: 2024-03-11T01:53:32.027Z (3 months ago)
- Language: JavaScript
- Homepage: https://medium.com/@cpojer/effective-javascript-codemods-5a6686bb46fb
- Size: 592 KB
- Stars: 300
- Watchers: 7
- Forks: 40
- Open Issues: 25
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Lists
- awesome-jscodeshift - 5to6-codemod - A collection of codemods that allow you to transform your js code from ES5 to ES6. (Table of Contents / Codemods)
- awesome - 5to6/5to6-codemod - A collection of codemods that allow you to transform your js code from ES5 to ES6. (JavaScript)
- awesome-codemods - 5to6-codemod - A collection of codemods that allow you to transform your js code from ES5 to ES6. (JavaScript)
- awesome-stars - 5to6/5to6-codemod - A collection of codemods that allow you to transform your js code from ES5 to ES6. (others)
- awesome-github-star - 5to6-codemod
- awesome-stars - 5to6-codemod
README
[](https://travis-ci.org/5to6/5to6-codemod)
[](https://github.com/5to6/5to6-codemod)
[](https://www.npmjs.com/package/5to6-codemod)
[](https://www.npmjs.com/package/5to6-codemod)
# 5to6-codemod
A collection of [codemods](https://medium.com/@cpojer/effective-javascript-codemods-5a6686bb46fb) that allow you to transform your JavaScript code from ES5 to ES6 using [jscodeshift](https://github.com/facebook/jscodeshift).
## Usage
1. `npm install -g jscodeshift`
2. `npm install 5to6-codemod`
3. `jscodeshift -t node_modules/5to6-codemod/transforms/[transform].js [files]`
4. Review changes via `git diff`. Keep what you want, throw it out if you don't. Magic!
## Option flags
When executing codemods, you can configure options like so:
`jscodeshift -t node_modules/5to6-codemod/transforms/[transform].js [files] --key=value`
### Recast options
Our transforms will automatically distinguish and pass through Recast config keys via [jscodeshift](https://github.com/facebook/jscodeshift#passing-options-to-recast). Official documentation for Recast's configuration can be found [here](https://github.com/benjamn/recast/blob/4899a70d4b9aeec9c599065be3338464b7047767/lib/options.js#L1). We currently support the following Recast keys:
- `esprima`
- `inputSourceMap`
- `lineTerminator`
- `quote`
- `range`
- `reuseWhitespace`
- `sourceFileName`
- `sourceMapName`
- `sourceRoot`
- `tabWidth`
- `tolerant`
- `trailingComma`
- `useTabs`
- `wrapColumn`
## Transforms
- `amd` - Transforms AMD style modules to ES6 `import`/`export`
- `cjs` - Transforms CommonJS style `require()` calls to ES6 `import` statements
- This transformation accepts the following option flags:
- `hoist`: Enables hoisting require statements to the top
- `no-strict` - Removes "use strict" statements
- `exports` - Move CommonJS style `module.exports` statements to ES6 `export` statements
- `named-export-generation` - Adds named exports corresponding to default export object keys. Only valid for ES6 modules exporting an object as the default export.
- `let` - Replace all `var` calls to use `let`
- `simple-arrow` - Replace all function expressions with a body of a sole return statement into arrow functions
## Known issues
* Can't automagically figure out when you want to use `import * as varName`.
* End-of-line comments also missing in many situations
* `simple-arrow` loses comments in the function expression body