@codemod-utils/cli v2.0.2
@codemod-utils/cli
CLI to create a codemod project
Usage
Step 1. Use npx
to run @codemod-utils/cli
.
npx @codemod-utils/cli <your-codemod-name> [options]
This will create a folder named <your-codemod-name>
.
Step 2. 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
Arguments
You must pass the name of your codemod.
npx @codemod-utils/cli ember-codemod-v1-to-v2
By default, @codemod-utils/cli
only installs @codemod-utils/files
and @codemod-utils/tests
. If you need more, pass --addon
and list the package names.
npx @codemod-utils/cli --addon blueprints json
The options are:
Pass --root
to run the codemod somewhere else (i.e. not in the current directory).
npx @codemod-utils/cli --root <path/to/your/project>
By default, @codemod-utils/cli
creates a TypeScript project to help you maintain and extend the codemod. To create a JavaScript project, set --typescript
to false
.
npx @codemod-utils/cli --typescript false
Compatibility
- Node.js v18 or above
Contributing
See the Contributing guide for details.
License
This project is licensed under the MIT License.
10 months ago
10 months ago
10 months ago
12 months ago
11 months ago
1 year ago
11 months ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago