Skip to content

Commit

Permalink
chore: update docs (#3520)
Browse files Browse the repository at this point in the history
  • Loading branch information
JamesHenry committed Jan 31, 2023
1 parent 86f8021 commit 116c62c
Show file tree
Hide file tree
Showing 17 changed files with 19 additions and 19 deletions.
2 changes: 1 addition & 1 deletion libs/commands/add/README.md
@@ -1,4 +1,4 @@
# `@lerna/add`
# `lerna add`

> Add a dependency to matched packages
Expand Down
2 changes: 1 addition & 1 deletion libs/commands/bootstrap/README.md
@@ -1,4 +1,4 @@
# `@lerna/bootstrap`
# `lerna bootstrap`

> Link local packages together and install remaining package dependencies
Expand Down
2 changes: 1 addition & 1 deletion libs/commands/changed/README.md
@@ -1,4 +1,4 @@
# `@lerna/changed`
# `lerna changed`

> List local packages that have changed since the last tagged release
Expand Down
2 changes: 1 addition & 1 deletion libs/commands/clean/README.md
@@ -1,4 +1,4 @@
# `@lerna/clean`
# `lerna clean`

> Remove the node_modules directory from all packages
Expand Down
2 changes: 1 addition & 1 deletion libs/commands/create/README.md
@@ -1,4 +1,4 @@
# `@lerna/create`
# `lerna create`

> Create a new lerna-managed package
Expand Down
2 changes: 1 addition & 1 deletion libs/commands/diff/README.md
@@ -1,4 +1,4 @@
# `@lerna/diff`
# `lerna diff`

> Diff all packages or a single package since the last release
Expand Down
2 changes: 1 addition & 1 deletion libs/commands/exec/README.md
@@ -1,4 +1,4 @@
# `@lerna/exec`
# `lerna exec`

> Execute an arbitrary command in each package
Expand Down
2 changes: 1 addition & 1 deletion libs/commands/import/README.md
@@ -1,4 +1,4 @@
# `@lerna/import`
# `lerna import`

> Import a package into the monorepo with commit history
Expand Down
2 changes: 1 addition & 1 deletion libs/commands/init/README.md
@@ -1,4 +1,4 @@
# `@lerna/init`
# `lerna init`

> Create a new Lerna repo or upgrade an existing repo to the current version of Lerna
Expand Down
2 changes: 1 addition & 1 deletion libs/commands/link/README.md
@@ -1,4 +1,4 @@
# `@lerna/link`
# `lerna link`

> Symlink together all packages that are dependencies of each other
Expand Down
2 changes: 1 addition & 1 deletion libs/commands/publish/README.md
@@ -1,4 +1,4 @@
# `@lerna/publish`
# `lerna publish`

> Publish packages in the current project
Expand Down
2 changes: 1 addition & 1 deletion libs/commands/run/README.md
@@ -1,4 +1,4 @@
# `@lerna/run`
# `lerna run`

> Run an npm script in each package that contains that script
Expand Down
2 changes: 1 addition & 1 deletion libs/commands/version/README.md
@@ -1,4 +1,4 @@
# `@lerna/version`
# `lerna version`

> Bump version of packages changed since the last release
Expand Down
2 changes: 1 addition & 1 deletion packages/child-process/README.md
@@ -1,4 +1,4 @@
# `@lerna/child-process`
# `lerna child-process`

> Lerna's internal child_process wrapper
Expand Down
6 changes: 3 additions & 3 deletions website/docs/api-reference/commands.md
Expand Up @@ -21,9 +21,9 @@ type: reference
- [`lerna link`](https://github.com/lerna/lerna/tree/main/libs/commands/link#readme)
- [`lerna create`](https://github.com/lerna/lerna/tree/main/libs/commands/create#readme)
- [`lerna info`](https://github.com/lerna/lerna/tree/main/libs/commands/info#readme)
- [`lerna add-caching`](https://github.com/lerna/lerna/tree/main/packages/lerna/commands/add-caching#readme)
- [`lerna repair`](https://github.com/lerna/lerna/tree/main/packages/lerna/commands/repair#readme)
- [`lerna watch`](https://github.com/lerna/lerna/tree/main/packages/lerna/commands/watch#readme)
- [`lerna add-caching`](https://github.com/lerna/lerna/tree/main/packages/lerna/src/commands/add-caching#readme)
- [`lerna repair`](https://github.com/lerna/lerna/tree/main/packages/lerna/src/commands/repair#readme)
- [`lerna watch`](https://github.com/lerna/lerna/tree/main/packages/lerna/src/commands/watch#readme)

## Filter Options

Expand Down
2 changes: 1 addition & 1 deletion website/docs/features/version-and-publish.md
Expand Up @@ -52,7 +52,7 @@ lerna info Assuming all packages changed
Note that by passing `--no-private` we exclude all packages that are marked `private` in their `package.json` file.
:::

Lerna detects the current packages, identifies the current version and proposes the next one to choose. Note, you can also pass a semver bump directly like `lerna version 1.0.0`. More on the [version docs details](https://github.com/lerna/lerna/tree/main/commands/version#readme). Once a given version is chosen, Lerna updates the `package.json` with the version number, commits the change, adds a corresponding version tag (e.g. `v1.0.0`) and pushes the commit and the tag to the remote repository.
Lerna detects the current packages, identifies the current version and proposes the next one to choose. Note, you can also pass a semver bump directly like `lerna version 1.0.0`. More on the [version docs details](https://github.com/lerna/lerna/tree/main/libs/commands/version#readme). Once a given version is chosen, Lerna updates the `package.json` with the version number, commits the change, adds a corresponding version tag (e.g. `v1.0.0`) and pushes the commit and the tag to the remote repository.

```json title="packages/footer/package.json"
{
Expand Down
2 changes: 1 addition & 1 deletion website/docs/features/workspace-watching.md
Expand Up @@ -46,7 +46,7 @@ Watch a single package and its dependencies, running the "build" script on any o
$ lerna watch --scope="my-package-1" --include-dependencies -- lerna run build --scope=\$LERNA_PACKAGE_NAME
```

For more advanced filtering, see the [filter options](https://github.com/lerna/lerna/tree/main/core/filter-options#lernafilter-options) documentation. For more available options, see the [`lerna watch`](https://github.com/lerna/lerna/tree/main/core/lerna/commands/watch#lerna-watch) documentation.
For more advanced filtering, see the [filter options](https://lerna.js.org/docs/api-reference/commands#filter-options) documentation. For more available options, see the [`lerna watch`](https://github.com/lerna/lerna/tree/main/packages/lerna/src/commands/watch#lerna-watch) documentation.

## Watch Environment Variables

Expand Down

0 comments on commit 116c62c

Please sign in to comment.