/CodeshiftCommunity

Community-owned global registry and documentation hub for codemods. Write & run codemods, share them with your friends!

Primary LanguageTypeScriptMIT LicenseMIT

CodeshiftCommunity

CodeshiftCommunity Logo

CodeshiftCommunity is a community-owned global registry and documentation hub for codemods. Providing library maintainers & users with facilities to help write, test, publish and consume codemods in a structured, standardized and familiar way.

Inspired and built on Facebook's jscodeshift

💬 Join our community on Discord

Features

  • 🔭 Explore an extensive list of codemods contributed by the community.
  • 🚛 Create, test and publish codemods for your users.
  • ⚡️ Use our helpers & testing utilities to make writing codemods a breeze.
  • 📖 Up-skill your engineering team using our guides & resources.

Getting started

Registry

The registry contains all community contributed codemods, hosted and published directly from the CodeshiftCommunity repository.

Source for these packages are located in the /community folder.

CLI

Downloading and running codemods as well as initialising and maintaining codemod packages can all be done via the Codeshift CLI (@codeshift/cli).

Please see the docs for more information and examples

We recommend running the CLI with $ npx to ensure you always have the latest version.

$ npx @codeshift/cli --packages mylib@1.0.0 /project/src

But it can also be installed globally:

$ npm install -g @codeshift/cli or yarn global add @codeshift/cli

and run with:

$ codeshift or $ codeshift-cli