Skip to content

Commit 4fe2a66

Browse files
committedFeb 15, 2019
docs(meta): Add links to npm.im/lerna to READMEs that lacked it
1 parent abeb4dc commit 4fe2a66

File tree

26 files changed

+56
-6
lines changed

26 files changed

+56
-6
lines changed
 

‎commands/add/README.md

+2
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
> Add a dependency to matched packages
44
5+
Install [lerna](https://www.npmjs.com/package/lerna) for access to the `lerna` CLI.
6+
57
## Usage
68

79
```sh

‎commands/bootstrap/README.md

+2
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
> Link local packages together and install remaining package dependencies
44
5+
Install [lerna](https://www.npmjs.com/package/lerna) for access to the `lerna` CLI.
6+
57
## Usage
68

79
```sh

‎commands/changed/README.md

+2
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
> List local packages that have changed since the last tagged release
44
5+
Install [lerna](https://www.npmjs.com/package/lerna) for access to the `lerna` CLI.
6+
57
## Usage
68

79
The output of `lerna changed` is a list of packages that would be the subjects of the next `lerna version` or `lerna publish` execution.

‎commands/clean/README.md

+2
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
> Remove the node_modules directory from all packages
44
5+
Install [lerna](https://www.npmjs.com/package/lerna) for access to the `lerna` CLI.
6+
57
## Usage
68

79
```sh

‎commands/create/README.md

+2
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
> Create a new lerna-managed package
44
5+
Install [lerna](https://www.npmjs.com/package/lerna) for access to the `lerna` CLI.
6+
57
## Usage
68

79
```

‎commands/diff/README.md

+2
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
> Diff all packages or a single package since the last release
44
5+
Install [lerna](https://www.npmjs.com/package/lerna) for access to the `lerna` CLI.
6+
57
## Usage
68

79
```sh

‎commands/exec/README.md

+2
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
> Execute an arbitrary command in each package
44
5+
Install [lerna](https://www.npmjs.com/package/lerna) for access to the `lerna` CLI.
6+
57
## Usage
68

79
```sh

‎commands/import/README.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
> Import a package into the monorepo with commit history
44
5+
Install [lerna](https://www.npmjs.com/package/lerna) for access to the `lerna` CLI.
6+
57
## Usage
68

79
```sh
@@ -17,7 +19,7 @@ repo. Each commit is modified to make changes relative to the package
1719
directory. So, for example, the commit that added `package.json` will
1820
instead add `packages/<directory-name>/package.json`.
1921

20-
*Note*: If you're importing an external repository on a new lerna repository, then do remember to have at least one commit.
22+
_Note_: If you're importing an external repository on a new lerna repository, then do remember to have at least one commit.
2123

2224
```bash
2325
# Getting started with Lerna

‎commands/init/README.md

+2
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
> Create a new Lerna repo or upgrade an existing repo to the current version of Lerna
44
5+
Install [lerna](https://www.npmjs.com/package/lerna) for access to the `lerna` CLI.
6+
57
## Usage
68

79
```sh

‎commands/link/README.md

+2
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
> Symlink together all packages that are dependencies of each other
44
5+
Install [lerna](https://www.npmjs.com/package/lerna) for access to the `lerna` CLI.
6+
57
## Usage
68

79
```sh

‎commands/list/README.md

+2
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
> List local packages
44
5+
Install [lerna](https://www.npmjs.com/package/lerna) for access to the `lerna` CLI.
6+
57
## Usage
68

79
The `list` subcommand is aliased to several convenient shorthands (similar to [`npm ls`](https://docs.npmjs.com/cli/ls)):

‎commands/publish/README.md

+2
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
> Publish packages in the current project
44
5+
Install [lerna](https://www.npmjs.com/package/lerna) for access to the `lerna` CLI.
6+
57
## Usage
68

79
```sh

‎commands/run/README.md

+2
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
> Run an npm script in each package that contains that script
44
5+
Install [lerna](https://www.npmjs.com/package/lerna) for access to the `lerna` CLI.
6+
57
## Usage
68

79
```sh

‎core/child-process/README.md

+2
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,5 @@
55
## Usage
66

77
You probably shouldn't.
8+
9+
Install [lerna](https://www.npmjs.com/package/lerna) for access to the `lerna` CLI.

‎core/filter-options/README.md

+2
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
> Options for lerna sub-commands that need filtering
44
5+
Install [lerna](https://www.npmjs.com/package/lerna) for access to the `lerna` CLI.
6+
57
## Options
68

79
### `--scope <glob>`

‎core/lerna/README.md

+4
Original file line numberDiff line numberDiff line change
@@ -15,3 +15,7 @@
1515
## Usage
1616

1717
Check out our documentation [here](https://github.com/lerna/lerna#readme).
18+
19+
```sh
20+
npm i -D lerna
21+
```

‎utils/check-working-tree/README.md

+2
Original file line numberDiff line numberDiff line change
@@ -21,3 +21,5 @@ const options = {
2121
}
2222
})();
2323
```
24+
25+
Install [lerna](https://www.npmjs.com/package/lerna) for access to the `lerna` CLI.

‎utils/describe-ref/README.md

+2
Original file line numberDiff line numberDiff line change
@@ -26,4 +26,6 @@ const result = describe.parse("v1.0.0-5-gdeadbeef");
2626
// { lastTagName, lastVersion, refCount, sha, isDirty }
2727
```
2828

29+
Install [lerna](https://www.npmjs.com/package/lerna) for access to the `lerna` CLI.
30+
2931
[git describe]: https://git-scm.com/docs/git-describe

‎utils/get-packed/README.md

+2-4
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,6 @@
44
55
## Usage
66

7-
```
8-
const getPacked = require('@lerna/get-packed');
7+
You probably shouldn't, at least directly.
98

10-
// TODO: DEMONSTRATE API
11-
```
9+
Install [lerna](https://www.npmjs.com/package/lerna) for access to the `lerna` CLI.

‎utils/has-npm-version/README.md

+2
Original file line numberDiff line numberDiff line change
@@ -20,3 +20,5 @@ const predicate = hasNpmVersion.makePredicate();
2020
// `npm --version` === 6.3.0
2121
hasNpmVersion(">=5"); // => true
2222
```
23+
24+
Install [lerna](https://www.npmjs.com/package/lerna) for access to the `lerna` CLI.

‎utils/listable/README.md

+2
Original file line numberDiff line numberDiff line change
@@ -23,3 +23,5 @@ exports.builder = yargs => {
2323
listable.options(yargs);
2424
};
2525
```
26+
27+
Install [lerna](https://www.npmjs.com/package/lerna) for access to the `lerna` CLI.

‎utils/log-packed/README.md

+2
Original file line numberDiff line numberDiff line change
@@ -15,3 +15,5 @@ execa("npm", ["pack", "--json"]).then(result => {
1515
tarballs.forEach(logPacked);
1616
});
1717
```
18+
19+
Install [lerna](https://www.npmjs.com/package/lerna) for access to the `lerna` CLI.

‎utils/map-to-registry/README.md

+2
Original file line numberDiff line numberDiff line change
@@ -17,3 +17,5 @@ const { uri, auth } = mapToRegistry("my-package", config);
1717
```
1818

1919
`uri` and `auth` are suitable for arguments to [npm-registry-client](https://www.npmjs.com/package/npm-registry-client) instance method parameters.
20+
21+
Install [lerna](https://www.npmjs.com/package/lerna) for access to the `lerna` CLI.

‎utils/npm-conf/README.md

+2
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,5 @@
55
## Usage
66

77
See [npm-conf](https://github.com/kevva/npm-conf#readme)
8+
9+
Install [lerna](https://www.npmjs.com/package/lerna) for access to the `lerna` CLI.

‎utils/pack-directory/README.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,6 @@ This package owes an immense debt of gratitude to [Kat Marchán](https://github.
66

77
## Usage
88

9-
Maybe don't use it, just yet. Here be dragons.
9+
You probably shouldn't, at least directly.
10+
11+
Install [lerna](https://www.npmjs.com/package/lerna) for access to the `lerna` CLI.

‎utils/rimraf-dir/README.md

+2
Original file line numberDiff line numberDiff line change
@@ -11,3 +11,5 @@ rimrafDir("/path/to/directory").then(removedDir => {
1111
console.log("removed", removedDir);
1212
});
1313
```
14+
15+
Install [lerna](https://www.npmjs.com/package/lerna) for access to the `lerna` CLI.

0 commit comments

Comments
 (0)
Please sign in to comment.