Skip to content

Commit c18c6bd

Browse files
authored
docs: remove filemod + add workflow engine references (#1363)
1 parent c647ebc commit c18c6bd

File tree

2 files changed

+6
-6
lines changed

2 files changed

+6
-6
lines changed

apps/docs/building-codemods/build-package.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ To scaffold a new codemod package, you should:
5353
```
5454
</Step>
5555
<Step title="Update transform file content">
56-
<Card title="For jscodeshift/ts-morph/filemod codemods:">
56+
<Card title="For jscodeshift/ts-morph/workflow codemods:">
5757
Update the content inside the `src/index.ts` file with the content of your codemod's transform file.
5858
</Card>
5959
<Card title="For ast-grep codemods:">

apps/docs/building-codemods/package-requirements.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ The structure of the codemod package can vary based on the codemod engine used.
1313

1414
## Supported codemod engines
1515

16-
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).
16+
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).
1717

1818
## `.codemodrc.json` reference
1919

@@ -38,10 +38,10 @@ The `.codemodrc.json` configuration file includes several metafields that can be
3838
<ResponseField name="engine" type="string" required>
3939
Specifies the engine used to run the codemod.
4040
Can be any of:
41-
- `filemod`
41+
- `ast-grep`
4242
- `jscodeshift`
4343
- `ts-morph`
44-
- `ast-grep`
44+
- `Workflow Engine`
4545
- `piranha` (requires additional `language` field that specifies one of the supported piranha languages:
4646
`java`, `kt`, `go`, `py`, `swift`, `ts`, `tsx`, or `scala`)
4747
- `recipe` (requires additional `names` field, which is an ordered array of codemod names that will be executed)
@@ -124,7 +124,7 @@ The `.codemodrc.json` configuration file includes several metafields that can be
124124
Below, you can find the required codemod package structure for each codemod engine supported by Codemod platform.
125125

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

0 commit comments

Comments
 (0)