commonjs-to-es-module-codemod

0.5.7 • Public • Published

commonjs-to-es-module-codemod Actions Status: test

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 to export { foo }
  • [x] named export: module.exports.bar = foo & exports.bar = foo to export { foo as bar }
  • [x] default export: module.exports = foo to export default foo
  • [x] ignore multiple module.exports = x

Imports

  • [x] require("mod") to import "mod"
  • [x] const foo = require("mod") to import foo from "mod"
  • [x] const { foo } = require("mod") to import { foo } from "mod"
  • [x] const foo = require("mod").foo to import { foo } from "mod"
  • [x] const bar = require("mod").foo to import { foo as bar } from "mod"
  • [ ] const o = { foo: require("foo") } to import 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

  1. Fork it!
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -am 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request :D

License

MIT © azu

It includes BuonOmo/CommonJS-to-ES6-codemod.

MIT © Ulysse Buonomo buonomo.ulysse@gmail.com

Related

Package Sidebar

Install

npm i commonjs-to-es-module-codemod

Weekly Downloads

65

Version

0.5.7

License

MIT

Unpacked Size

136 kB

Total Files

11

Last publish

Collaborators

  • azu