Skip to content

Commit

Permalink
feat(README): update to include all flags
Browse files Browse the repository at this point in the history
  • Loading branch information
adamviktora committed Aug 20, 2024
1 parent c42de7e commit be11187
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions packages/pf-codemods/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,12 @@ Requires Node.js >= 10.
npx @patternfly/pf-codemods ./path-to-src
```

Note: when updating from PatternFly 5 to 6, add the `--v6` flag.

```sh
npx @patternfly/pf-codemods --v6 ./path-to-src
```

Giving node more RAM can help for large codebases.

```sh
Expand All @@ -37,6 +43,9 @@ Options:
--exclude <rules> Run recommended rules EXCLUDING this comma-seperated list
--fix Whether to run fixer
--format <format> What eslint report format to use (default: "stylish")
--no-cache Disables eslint caching
--v4 Run v3 to v4 codemods
--v6 Run v5 to v6 codemods
-h, --help display help for command
```

Expand Down

0 comments on commit be11187

Please sign in to comment.