Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add some docs on how to generate template codemods #118

Merged
merged 1 commit into from
Oct 14, 2020
Merged

Add some docs on how to generate template codemods #118

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,11 @@ ready to help you manage your codemods.
Once you have a project, you can generate a new codemod:

```
codemod-cli generate codemod <name of codemod>
codemod-cli generate codemod <name of codemod> // jscodeshift js codemod
codemod-cli generate codemod <name of codemod> -t=hbs // ember-template-recast hbs codemod
```

This will setup a new jscodeshift codemod within your project at `transforms/<name of codemod>/index.js`
This will setup a new codemod within your project at `transforms/<name of codemod>/index.js`
along with a test harness, README, fixture directory, and an initial set of input/output fixtures.

Once you have tweaked your codemod and its fixtures to your liking, it is time to run your tests:
Expand Down