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

Jump to bottom

docs: remove filemod + add workflow engine references #1363

Merged
merged 1 commit into from
Oct 23, 2024
Merged

docs: remove filemod + add workflow engine references #1363

Show file tree
Hide file tree
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
2 changes: 1 addition & 1 deletion apps/docs/building-codemods/build-package.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ To scaffold a new codemod package, you should:
```
</Step>
<Step title="Update transform file content">
<Card title="For jscodeshift/ts-morph/filemod codemods:">
<Card title="For jscodeshift/ts-morph/workflow codemods:">
Update the content inside the `src/index.ts` file with the content of your codemod's transform file.
</Card>
<Card title="For ast-grep codemods:">
Expand Down
10 changes: 5 additions & 5 deletions apps/docs/building-codemods/package-requirements.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ The structure of the codemod package can vary based on the codemod engine used.

## Supported codemod engines

Codemod platform currently supports the following codemod engines: [`ast-grep`](https://github.com/ast-grep/ast-grep), [`filemod`](https://github.com/codemod-com/codemod/tree/main/packages/filemod), [`jscodeshift`](https://github.com/facebook/jscodeshift), [`ts-morph`](https://github.com/dsherret/ts-morph), and [`piranha`](https://github.com/uber/piranha).
Codemod platform currently supports the following codemod engines: [`ast-grep`](https://github.com/ast-grep/ast-grep), [`jscodeshift`](https://github.com/facebook/jscodeshift), [`ts-morph`](https://github.com/dsherret/ts-morph), [`Workflow Engine`](/deploying-codemods/workflow-engine), and [`piranha`](https://github.com/uber/piranha).

## `.codemodrc.json` reference

Expand All @@ -38,10 +38,10 @@ The `.codemodrc.json` configuration file includes several metafields that can be
<ResponseField name="engine" type="string" required>
Specifies the engine used to run the codemod.
Can be any of:
- `filemod`
- `ast-grep`
- `jscodeshift`
- `ts-morph`
- `ast-grep`
- `Workflow Engine`
- `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)
Expand Down Expand Up @@ -124,7 +124,7 @@ The `.codemodrc.json` configuration file includes several metafields that can be
Below, you can find the required codemod package structure for each codemod engine supported by Codemod platform.

<Tabs>
<Tab title="jscodeshift, ts-morph, and filemod">
<Tab title="jscodeshift and ts-morph">
```bash
├── dist
│ ├── index.cjs # built codemod file. when someone runs your codemod, this file will be executed.
Expand All @@ -145,7 +145,7 @@ Below, you can find the required codemod package structure for each codemod engi
"private": false,
"name": "framework/version/codemod-name",
"description": "example codemod description",
"engine": "jscodeshift/ts-morph/filemod",
"engine": "jscodeshift/ts-morph/workflow",
"meta": {
"tags": ["framework", "migration", "etc"],
"git": "https://github.com/user/repo"
Expand Down
Loading