diff options
| author | 2023-04-28 01:36:44 +0800 | |
|---|---|---|
| committer | 2023-04-28 01:36:44 +0800 | |
| commit | dd84b9d64fb98746a230cd24233ff50a562c39c9 (patch) | |
| tree | b583261ef00b3afe72ec4d6dacb31e57779a6faf /packages/turbo-codemod/README.md | |
| parent | 0b46fcd72ac34382387b2bcf9095233efbcc52f4 (diff) | |
| download | HydroRoll-dd84b9d64fb98746a230cd24233ff50a562c39c9.tar.gz HydroRoll-dd84b9d64fb98746a230cd24233ff50a562c39c9.zip | |
Diffstat (limited to 'packages/turbo-codemod/README.md')
| -rw-r--r-- | packages/turbo-codemod/README.md | 55 |
1 files changed, 55 insertions, 0 deletions
diff --git a/packages/turbo-codemod/README.md b/packages/turbo-codemod/README.md new file mode 100644 index 0000000..5545561 --- /dev/null +++ b/packages/turbo-codemod/README.md @@ -0,0 +1,55 @@ +# Turborepo Codemods + +Turborepo provides Codemod transformations to help upgrade your Turborepo codebase. + +Codemods are transformations that run on your codebase programmatically. This allows for a large amount of changes to be applied without having to manually go through every file. + +## Commands + +### `migrate` + +Updates your Turborepo codebase to the specified version of Turborepo (defaults to the latest), running any required codemods, and installing the new version of Turborepo. + +``` +Usage: @turbo/codemod migrate|update [options] [path] + +Migrate a project to the latest version of Turborepo + +Arguments: + path Directory where the transforms should be applied + +Options: + --from <version> Specify the version to migrate from (default: current version) + --to <version> Specify the version to migrate to (default: latest) + --install Install new version of turbo after migration (default: true) + --force Bypass Git safety checks and forcibly run codemods (default: false) + --dry Dry run (no changes are made to files) (default: false) + --print Print transformed files to your terminal (default: false) + -h, --help display help for command +``` + +### `transform` (default) + +Runs a single codemod on your codebase. This is the default command, and can be omitted. + +``` +Usage: @turbo/codemod transform [options] [transform] [path] + @turbo/codemod [options] [transform] [path] + +Apply a single code transformation to a project + +Arguments: + transform The transformer to run + path Directory where the transforms should be applied + +Options: + --force Bypass Git safety checks and forcibly run codemods (default: false) + --list List all available transforms (default: false) + --dry Dry run (no changes are made to files) (default: false) + --print Print transformed files to your terminal (default: false) + -h, --help display help for command +``` + +## Developing + +To add a new transformer, run `pnpm add-transformer`, or [view the complete guide](./src/transforms/README.md). |
