Skip to content

Commit

Permalink
CLI documentation update from CI
Browse files Browse the repository at this point in the history
  • Loading branch information
npm-cli-bot committed Jan 24, 2024
1 parent 8f405a2 commit 13d0083
Show file tree
Hide file tree
Showing 8 changed files with 55 additions and 8 deletions.
2 changes: 1 addition & 1 deletion content/cli/v10/commands/npm-config.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ npm config set key=value [key=value...]
npm set key=value [key=value...]
```
Sets each of the config keys to the value provided.
Sets each of the config keys to the value provided. Modifies the user configuration file unless [`location`](/cli/v10/commands/npm-config#location) is passed.
If value is omitted, the key will be removed from your config file entirely.
Expand Down
2 changes: 1 addition & 1 deletion content/cli/v10/commands/npm-ls.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ Note: to get a "bottoms up" view of why a given package is included in the tree
Positional arguments are `name@version-range` identifiers, which will limit the results to only the paths to the packages named. Note that nested packages will _also_ show the paths to the specified packages. For example, running `npm ls promzard` in npm's source tree will show:

```bash
npm@10.3.0 /path/to/npm
npm@10.4.0 /path/to/npm
└─┬ [email protected]
└── [email protected]
```
Expand Down
6 changes: 3 additions & 3 deletions content/cli/v10/commands/npm-update.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ If the `-g` flag is specified, this command will update globally installed packa

If no package name is specified, all packages in the specified location (global or local) will be updated.

Note that by default `npm update` will not update the semver values of direct dependencies in your project `package.json`, if you want to also update values in `package.json` you can run: `npm update --save` (or add the `save=true` option to a [configuration file](/cli/v10/configuring-npm/npmrc) to make that the default behavior).
Note that by default `npm update` will not update the semver values of direct dependencies in your project `package.json`. If you want to also update values in `package.json` you can run: `npm update --save` (or add the `save=true` option to a [configuration file](/cli/v10/configuring-npm/npmrc) to make that the default behavior).

### Example

Expand Down Expand Up @@ -98,7 +98,7 @@ However, if `app`'s `package.json` contains:
}
```

In this case, running `npm update` will install `[email protected]`. Even though the `latest` tag points to `1.2.2`, this version do not satisfy `~1.1.1`, which is equivalent to `>=1.1.1 <1.2.0`. So the highest-sorting version that satisfies `~1.1.1` is used, which is `1.1.2`.
In this case, running `npm update` will install `[email protected]`. Even though the `latest` tag points to `1.2.2`, this version does not satisfy `~1.1.1`, which is equivalent to `>=1.1.1 <1.2.0`. So the highest-sorting version that satisfies `~1.1.1` is used, which is `1.1.2`.

#### Caret Dependencies below 1.0.0

Expand All @@ -110,7 +110,7 @@ Suppose `app` has a caret dependency on a version below `1.0.0`, for example:
}
```

`npm update` will install `[email protected]`, because there are no other versions which satisfy `^0.2.0`.
`npm update` will install `[email protected]`.

If the dependence were on `^0.4.0`:

Expand Down
2 changes: 1 addition & 1 deletion content/cli/v10/commands/npm.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Note: This command is unaware of workspaces.

### Version

10.3.0
10.4.0

### Description

Expand Down
2 changes: 1 addition & 1 deletion content/cli/v10/configuring-npm/package-json.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -600,7 +600,7 @@ in which case they will be normalized to a relative path and added to your `pack
}
```

This feature is helpful for local offline development and creating tests that require npm installing where you don't want to hit an external server, but should not be used when publishing packages to the public registry.
This feature is helpful for local offline development and creating tests that require npm installing where you don't want to hit an external server, but should not be used when publishing your package to the public registry.
_note_: Packages linked by local path will not have their own dependencies installed when `npm install` is ran in this case. You must run `npm install` from inside the local path itself.
Expand Down
45 changes: 45 additions & 0 deletions content/cli/v10/using-npm/changelog.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,51 @@ redirect_from:
- /using-npm/changelog
---

## [10.4.0](https://github.com/npm/cli/compare/v10.3.0...v10.4.0) (2024-01-24)

### Features

- [`35a098c`](https://github.com/npm/cli/commit/35a098cc54ef208c53e7329bfb65a7e5656c559b) [#7175](https://github.com/npm/cli/pull/7175) display tree diff on `--long` (@wraithgar)
- [`dffca29`](https://github.com/npm/cli/commit/dffca29f0690be82692eaa44a1dd02a0807a70ae) [#7174](https://github.com/npm/cli/pull/7174) format: print `--dry-run` diffs in table format (#7174) (@ritaaktay)
- [`6d5f9ac`](https://github.com/npm/cli/commit/6d5f9acd0dc7f755a9ef4d27e1dac7076ec7e469) [#7133](https://github.com/npm/cli/pull/7133) dedupe - display difference when `--dry-run` is enabled (#7133) (@Blaumaus)

### Bug Fixes

- [`ec06f77`](https://github.com/npm/cli/commit/ec06f7712bbdc3b38c546593e9970962fee127ed) [#7175](https://github.com/npm/cli/pull/7175) inline diff table code w/ summary code (@wraithgar)
- [`d4ebfba`](https://github.com/npm/cli/commit/d4ebfba91991423b52edf5f9431424faa6618073) [#7157](https://github.com/npm/cli/pull/7157) use util.stripVTControlCharacters instead of strip-ansi (@wraithgar)
- [`81c95c7`](https://github.com/npm/cli/commit/81c95c7de71b40831ad46356d75ed56b20c66372) [#7063](https://github.com/npm/cli/pull/7063) don't reset update notifier duration on every check (#7063) (@wraithgar)

### Documentation

- [`2b7eaad`](https://github.com/npm/cli/commit/2b7eaade0620b3ea69e8b0b21335ed25af082351) [#7168](https://github.com/npm/cli/pull/7168) package-json: Reword warning about publishing local dependencies (#7168) (@DanKaplanSES)
- [`67ab0f7`](https://github.com/npm/cli/commit/67ab0f745ad182fa8250cc1da53b618df2e0d95a) [#7142](https://github.com/npm/cli/pull/7142) update: Replace comma with period in run on sentence (#7142) (@DanKaplanSES)
- [`05c69dc`](https://github.com/npm/cli/commit/05c69dc7ac70d27f1ec1d58ea0dd7111770fd0aa) [#7150](https://github.com/npm/cli/pull/7150) config: State default configuration file affected by `npm config set` (#7150) (@DanKaplanSES)
- [`44f4518`](https://github.com/npm/cli/commit/44f45187ef8ee20c373e89407f3c32708bef9f0f) [#7149](https://github.com/npm/cli/pull/7149) Link to the config command in the npm configuration description (#7149) (@DanKaplanSES)
- [`dd5699f`](https://github.com/npm/cli/commit/dd5699f7f0dcf9e5ad1c5549f3eaacaa1715f8eb) [#7152](https://github.com/npm/cli/pull/7152) update: Fix a typo and remove unneeded statement (#7152) (@DanKaplanSES)

### Dependencies

- [`ec77e81`](https://github.com/npm/cli/commit/ec77e81f5ecc3603bb7c9963f860a8c46f6a61ec) [#7124](https://github.com/npm/cli/pull/7124) `[email protected]`
- [`e32189c`](https://github.com/npm/cli/commit/e32189c768181d58ab72825d67307a3a653652ac) [#7173](https://github.com/npm/cli/pull/7173) deduplicate tree
- [`b7af4d9`](https://github.com/npm/cli/commit/b7af4d9bb96a86abee6a745b4a756b84d54d6e79) [#7173](https://github.com/npm/cli/pull/7173) `[email protected]`
- [`6883743`](https://github.com/npm/cli/commit/68837432c0b78bf7a4382a443f35ce2484449952) [#7173](https://github.com/npm/cli/pull/7173) `@npmcli/[email protected]`
- [`739634d`](https://github.com/npm/cli/commit/739634d76168f438934f1f8287618dabe2f3b968) [#7157](https://github.com/npm/cli/pull/7157) remove strip-ansi
- [`162c82e`](https://github.com/npm/cli/commit/162c82e845d410ede643466f9f8af78a312296cc) [#7148](https://github.com/npm/cli/pull/7148) `[email protected]` (#7148) (@bdehamer)
- [`a50b03b`](https://github.com/npm/cli/commit/a50b03b10046cf769cd328df96adcf292db5c067) [#7141](https://github.com/npm/cli/pull/7141) `[email protected]` (#7141) (@bdehamer)
- [`f696b51`](https://github.com/npm/cli/commit/f696b517a39bea1be0f7116983a5b4c8ed6f01b7) [#7132](https://github.com/npm/cli/pull/7132) `@sigstore/[email protected]` (#7132) (@bdehamer)
- [workspace](https://github.com/npm/cli/releases/tag/arborist-v7.3.1): `@npmcli/[email protected]`
- [workspace](https://github.com/npm/cli/releases/tag/libnpmdiff-v6.0.6): `[email protected]`
- [workspace](https://github.com/npm/cli/releases/tag/libnpmexec-v7.0.7): `[email protected]`
- [workspace](https://github.com/npm/cli/releases/tag/libnpmfund-v5.0.4): `[email protected]`
- [workspace](https://github.com/npm/cli/releases/tag/libnpmpack-v6.0.6): `[email protected]`
- [workspace](https://github.com/npm/cli/releases/tag/libnpmpublish-v9.0.4): `[email protected]`

### Chores

- [`a82ccc5`](https://github.com/npm/cli/commit/a82ccc5f97a60698fb0ee413347a621d0662f493) [#7173](https://github.com/npm/cli/pull/7173) `[email protected]` (@wraithgar)
- [`dcaa99c`](https://github.com/npm/cli/commit/dcaa99c5138ad20a3210a8396772177aa1fa33da) [#7173](https://github.com/npm/cli/pull/7173) fix exec test (@wraithgar)
- [`0d96080`](https://github.com/npm/cli/commit/0d96080fa8c08b5eb77bbd6ae64111379fa24465) [#7162](https://github.com/npm/cli/pull/7162) release: do not exclude docs directory from CLI release commits (#7162) (@lukekarrys)

## [10.3.0](https://github.com/npm/cli/compare/v10.2.5...v10.3.0) (2024-01-10)

### Features
Expand Down
2 changes: 2 additions & 0 deletions content/cli/v10/using-npm/config.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ redirect_from:

### Description

This article details npm configuration in general. To learn about the `config` command, see [`npm config`](/cli/v10/commands/npm-config).

npm gets its configuration values from the following sources, sorted by priority:

#### Command Line Flags
Expand Down
2 changes: 1 addition & 1 deletion content/nav.yml
Original file line number Diff line number Diff line change
Expand Up @@ -1324,7 +1324,7 @@
- title: Changelog
url: /cli/v9/using-npm/changelog
description: Changelog notes for each version
- title: Version 10.3.0
- title: Version 10.4.0
shortName: v10
url: /cli/v10
default: true
Expand Down

0 comments on commit 13d0083

Please sign in to comment.