Giter VIP home page Giter VIP logo

commonjs-to-es-module-codemod's Introduction

commonjs-to-es-module-codemod

jscodeshift codemod that convert CommonJS(require/exports) to ES Modules(import/export) for JavaScript/TypeScript

Support

Exports

  • named export: module.exports.foo = foo & exports.foo = foo to export { foo }`
  • named export: module.exports.bar = foo & exports.bar = foo to export { foo as bar }
  • default export: module.exports = foo to export default foo
  • ignore multiple module.exports = x

Imports

  • const foo = require("mod") to import foo from "mod"
  • const { foo } = require("mod") to import { foo } from "mod"
  • const foo = require("mod").foo to import { foo } from "mod"
  • 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

Convert index.js and index.ts to ES modules codes using jscodeshift

# Install jscodeshift
npm install --global jscodeshift
# Transform
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 [email protected]

Related

commonjs-to-es-module-codemod's People

Contributors

albertstill avatar azu avatar buonomo avatar hata6502 avatar villesau avatar

Stargazers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.