Quickstart

1. Run CLI

Change the directory to a place where you like to keep projects. Run @codemod-utils/cli to scaffold your codemod.

pnpx @codemod-utils/cli <your-codemod-name> [options]

This will create a folder named your-codemod-name.

Add utilities

By default, @codemod-utils/cli only installs the core packages: @codemod-utils/files and @codemod-utils/tests. Every codemod will need them.

If your codemod needs more, pass --addon and list the package name (without the prefix @codemod-utils/).

pnpx @codemod-utils/cli --addon blueprints package-json

Possible values for --addon are:

• ast-javascript
• ast-template
• ast-template-tag
• blueprints
• ember
• package-json
• threads

2. Make the initial commit

Change to the codemod directory, then run these scripts in sequence:

# Install dependencies
pnpm install

# Commit changes
git init
git add .
git commit -m "Initial commit"

# Push changes (to a new repo)
git remote add origin git@github.com:<your-github-handle>/<your-repo-name>.git
git branch -M main
git push -u origin main

3. Start coding

TIP

As you write code, run lint and test to check your code.

# Lint files
pnpm lint
pnpm lint:fix

# Test files
pnpm test

Try running these scripts now. They should pass out of the box.

Not sure how to start? I recommend following the main tutorial first. You can also check out existing codemods in Made with codemod-utils.