Publishing Codemods

You can easily share your codemods with thousands of people around the world by adding them to the Codemod Registry. Once added, they will automatically integrate with Codemod platform. This simplifies codemod discovery and distribution, and offers a better running codemods experience.

Publishing codemods to the registry is especially useful for framework/library builders. With features like shareable codemod deep links and Codemod CLI & IDE extenion, your users can adopt your latest releases with one click, straight from your migration doc.

Supported codemod engines

Codemod platform currently supports the following codemod engines: ast-grep, filemod, jscodeshift, ts-morph, and piranha.

Required codemod package structure

To make your codemod package compatible with Codemod platform, it needs to have a .codemodrc.json configuration file in the project root.

├── dist
│   ├── index.cjs # this is the default path for the built codemod file. when someone runs your codemod, this file will be executed.
├── src
│   ├── index.ts # this is the default path for the codemod's entry point file.
│   ├── ...
├── .codemodrc.json # contains the codemod configuration
└── README.md # must contain a short description and examples, such as in the example at the bottom of this page

name

string

required

Specifies the slugified name of the codemod published to the codemod registry.

version

string

required

Specifies the current codemod version. Should follow the SemVer scheme.

The version field must be bumped every time the codemod is published.

private

boolean

default: "false"

Can be used to set the codemod visibility to private.

By default, when a codemod is published without a namespace, visibility will be set as public. If a codemod is published under a namespace, such as @codemod/my-codemod, visibility will be set as private.

engine

string

required

Specifies the engine used to run the codemod. Can be any of:

filemod
jscodeshift
ts-morph
ast-grep
piranha (requires additional language field that specifies one of the supported piranha languages: java, kt, go, py, swift, ts, tsx, or scala)
recipe (requires additional names field, which is an ordered array of codemod names that will be executed)

include

glob pattern array

Can be used to override the default glob pattern for files that will be processed by the codemod.

applicability

object

The applicability field is an object with from and to keys that are both arrays of tuples. This field can be used to specify the dependencies and versions this codemod is made for. This field is also used to check if the codemod is compatible with the project it will run over.

Each tuple consists of three elements:

a library name
a comparison operator (<, >, <=, >=, =)
a version number (SemVer compatible)

deps

array of strings

Can be used to specify dependencies to be installed after successful a codemod run. You can also specify a package to be removed by prepending it with a - sign. Each dependency should be a string in one of the following formats:

package-name@version
-package-name
package-name

arguments

array of objects

If your codemod requires arguments, you can specify them in this field.

Example of a valid configuration file:

.codemodrc.json

  {
    "name": "my-unique-codemod-name",
    "version": "1.0.0",
    "private": false,
    "engine": "filemod",
    "include": ["**/*.js"],
    "applicability": {
      "from": [["react", ">", "17.0.0"], ["react", "<", "17.1.9"]],
      "to": [["react", "=", "18.0.0"]]
    },
    "deps": ["-jest", "vitest@2.0.0"],
    "arguments": [
      {
        "name": "arg1",
        "description": "Arg number one",
        "kind": "string",
        "required": false
      },
      {
        "name": "arg2",
        "description": "Some other arg",
        "kind": "number",
        "required": true
      }
    ],
    "meta": {
      "tags": ["react", "migration"],
      "git": "https://github.com/codemod-com/codemod"
    },
    "build": {
      "input": "src/index.ts",
      "output": "dist/index.cjs"
    }
  }

README.md

## Description

This codemod does X, Y, and Z.

## Examples

### Before

// some code

### After

// some code

## Other links

- [Link to the GitHub repository](https://github.com/codemod-com/codemod)

Publish with Codemod CLI

Once your codemod package is compatible with Codemod platform, you can use Codemod CLI to publish a local codemod to the codemod registry.

codemod login

You will be redirected to the Codemod platform login page. Upon successful login, our CLI will automatically authenticate you.

Build your local project

This will build a JavaScript project using esbuild and create a dist directory in your project root. If your codemod is not using a JavaScript engine, you can skip this step.

If your local project is not already built, you can build it using codemod CLI:

codemod build

Publish your codemod

Publish your codemod by using the following command inside your project’s directory:

codemod publish

Introduction

Building Codemods

Codemod Registry

Running codemods

Quick Links

Other Resources

Supported codemod engines

Required codemod package structure

Example of a valid configuration file:

Publish with Codemod CLI

Introduction

Building Codemods

Codemod Registry

Running codemods

Quick Links

Other Resources

​Supported codemod engines

​Required codemod package structure

Example of a valid configuration file:

​Publish with Codemod CLI

Supported codemod engines

Required codemod package structure

Publish with Codemod CLI