这是indexloc提供的服务,不要输入任何密码
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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 cli/internal/backends/backends.go
Original file line number Diff line number Diff line change
Expand Up @@ -26,5 +26,5 @@ func GetBackend(cwd string, pkg *fs.PackageJSON) (*api.LanguageBackend, error) {
}
}

return nil, errors.New(util.Sprintf("could not determine language / package management backend. Please set the \"packageManager\" property in your package.json (${UNDERLINE}https://nodejs.org/api/packages.html#packagemanager)${RESET}"))
return nil, errors.New(util.Sprintf("could not determine package manager. Please set the \"packageManager\" property in your root package.json (${UNDERLINE}https://nodejs.org/api/packages.html#packagemanager)${RESET} or run `npx @turbo/codemod add-package-manager` in the root of your monorepo."))
}
71 changes: 71 additions & 0 deletions docs/pages/docs/reference/codemods.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
---
title: Turborepo Codemods
---

# Turborepo Codemods

Turborepo provides Codemod transformations and automatic migration scripts to help upgrade your Turborepo codebase when a feature is deprecated.

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.

## Usage

```sh
npx @turbo/codemod <transform> <path>
```

- `transform` - name of transform, see available transforms below.
- `path` - files or directory to transform
- `--dry` - Do a dry-run, no code will be edited
- `--print` - Prints the changed output for comparison

## Turborepo 1.x

### `add-package-manager`

Transforms the root `package.json` so that `packageManager` key as the detected package manager (`yarn`, `npm`, `pnpm`) and version (e.g. `yarn@1.22.17`). This key is now [supported by Node.js](https://nodejs.org/dist/latest-v17.x/docs/api/packages.html#packagemanager) and is used by Turborepo for faster package manager detection (vs. inferring from just the filesystem alone).

For example, for Yarn v1:

```json
// Before
{
"name": "turborepo-basic",
"version": "0.0.0",
"private": true,
"workspaces": [
"apps/*",
"packages/*"
],
...
}
```

```json
// After
{
"name": "turborepo-basic",
"version": "0.0.0",
"private": true,
"packageManager": "yarn@1.22.17",
"workspaces": [
"apps/*",
"packages/*"
],
...
}
```

#### Usage

Go to your project:

```sh
cd path-to-your-turborepo/
```

Run the codemod:

```sh
npx @turbo/codemod add-package-manager
```
3 changes: 2 additions & 1 deletion docs/pages/docs/reference/meta.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
{
"configuration": "Configuration Options",
"command-line-reference": "CLI Usage"
"command-line-reference": "CLI Usage",
"codemods": "Codemods"
}
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@
"private": true,
"workspaces": {
"packages": [
"packages/*",
"docs",
"cli",
"create-turbo"
"create-turbo",
"turbo-codemod"
]
},
"scripts": {
Expand Down
Loading