commonjs-to-es-module-codemod
v0.5.7
Published
jscodeshift codemod that convert CommonJS(require/exports) to ES Modules(import/export) for JavaScript/TypeScript
Downloads
1,491
Maintainers
Readme
commonjs-to-es-module-codemod
jscodeshift codemod that convert CommonJS(require/exports) to ES Modules(import/export) for JavaScript/TypeScript
Support Patterns
Exports
- [x] named export:
module.exports.foo = foo
&exports.foo = foo
toexport { foo }
- [x] named export:
module.exports.bar = foo
&exports.bar = foo
toexport { foo as bar }
- [x] default export:
module.exports = foo
toexport default foo
- [x] ignore multiple
module.exports = x
Imports
- [x]
require("mod")
toimport "mod"
- [x]
const foo = require("mod")
toimport foo from "mod"
- [x]
const { foo } = require("mod")
toimport { foo } from "mod"
- [x]
const foo = require("mod").foo
toimport { foo } from "mod"
- [x]
const bar = require("mod").foo
toimport { foo as bar } from "mod"
- [ ]
const o = { foo: require("foo") }
toimport foo from "mod"; const o = { foo }
Usage
commonjs-to-es-module-codemod
is published on npm.
You can convert index.js
and index.ts
to ES Modules using jscodeshift and unpkg.
# Install jscodeshift
npm install --global jscodeshift
# Transform using latest version
LATEST_VERSION=$(npm view commonjs-to-es-module-codemod version)
jscodeshift -t "https://unpkg.com/commonjs-to-es-module-codemod@${LATEST_VERSION}/dist/index.js" "index.js"
# Transform TypeScript
jscodeshift -t "https://unpkg.com/commonjs-to-es-module-codemod@${LATEST_VERSION}/dist/index.js" --extensions ts "index.ts"
Convert src/*.js
:
LATEST_VERSION=$(npm view commonjs-to-es-module-codemod version)
find src -name "*.js" | xargs jscodeshift -t "https://unpkg.com/commonjs-to-es-module-codemod@${LATEST_VERSION}/dist/index.js"
Tests
yarn test
Contributing
- Fork it!
- Create your feature branch:
git checkout -b my-new-feature
- Commit your changes:
git commit -am 'Add some feature'
- Push to the branch:
git push origin my-new-feature
- Submit a pull request :D
License
MIT © azu
It includes BuonOmo/CommonJS-to-ES6-codemod.
MIT © Ulysse Buonomo [email protected]