⚠️ This repository is deprecated and no longer maintained.

Please Note: This repository was migrated to a monorepo called codemod.

Codemod.com's Codemod Engine Node

Codemod.com gives you multiple ways to discover, run & share supported codemods and code automation recipes.

Installation

npm i codemod

Global installation (recommended)

npm i -g codemod

Usage

Running a codemod

codemod [framework/version/codemod-name]

Example (running Next.js app router receipe codemod)

codemod next/13/app-router-recipe

List available codemods

The list command can be used to list all codemods available in the Codemod Registry.

codemod list

Sync registry

The syncRegistry command can be used to sync local codemods with the public Codemod Registry.

codemod syncRegistry

Generate codemod from file diff

The learn command can be used to send the diff of the latest edited file to the Codemod Studio and have it automatically build an explainable and debuggable codemod.

After running this command, if any git diff exists, codemod will use the diff as before/after snippets in the Codemod Studio.

codemod learn

Options

• --include
• --exclude
• --targetPath
• --sourcePath
• --codemodEngine
• --fileLimit
• --usePrettier
• --useCache
• --useJson
• --threadCount
• --dryRun
• --telemetryDisable

Contribution

We'd love for you to contribute to the Codemod Engine and the Codemod Registry. Please note that once you create a pull request, you will be asked to sign our Contributor License Agreement.

We're always excited to support codemods for more frameworks and libraries. Contributing allows us to make codemods more accessible to more framework builders, developers, and more.

Telemetry 🔭

We collect anonymous usage data to improve our product. Collected data cannot be linked to individual users. We do not store personal data/code.

For more details and samples of collected data see our telemetry compliance considerations doc.