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 Nov 15, 2023
1 parent 2c6e3cc commit 82d1945
Show file tree
Hide file tree
Showing 10 changed files with 60 additions and 8 deletions.
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
[email protected].3 /path/to/npm
[email protected].4 /path/to/npm
└─┬ [email protected]
└── [email protected]
```
Expand Down
2 changes: 1 addition & 1 deletion content/cli/v10/commands/npm-prune.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ This command removes "extraneous" packages. If a package name is provided, then

Extraneous packages are those present in the `node_modules` folder that are not listed as any package's dependency list.

If the `--production` flag is specified or the `NODE_ENV` environment variable is set to `production`, this command will remove the packages specified in your `devDependencies`. Setting `--no-production` will negate `NODE_ENV` being set to `production`.
If the `--omit=dev` flag is specified or the `NODE_ENV` environment variable is set to `production`, this command will remove the packages specified in your `devDependencies`.

If the `--dry-run` flag is used then no changes will actually be made.

Expand Down
6 changes: 6 additions & 0 deletions content/cli/v10/commands/npm-view.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,12 @@ Field names can be specified after the package descriptor. For example, to show
npm view [email protected] dependencies
```

By default, `npm view` shows data about the current project context (by looking for a `package.json`). To show field data for the current project use a file path (i.e. `.`):

```bash
npm view . dependencies
```

You can view child fields by separating them with a period. To view the git repository URL for the latest version of `npm`, you would run the following command:

```bash
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.2.3
10.2.4

### Description

Expand Down
30 changes: 30 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,36 @@ redirect_from:
- /using-npm/changelog
---

## [10.2.4](https://github.com/npm/cli/compare/v10.2.3...v10.2.4) (2023-11-14)

### Bug Fixes

- [`cd291e7`](https://github.com/npm/cli/commit/cd291e7aa52e56fc45f8245e67c77e0ed3711b07) [#6995](https://github.com/npm/cli/pull/6995) refactor search formatting code (#6995) (@wraithgar)
- [`f3a7380`](https://github.com/npm/cli/commit/f3a7380a45323dbf6c74015e418de3963fb11a69) [#6973](https://github.com/npm/cli/pull/6973) look in workspace for exec commands (#6973) (@wraithgar)
- [`d11496b`](https://github.com/npm/cli/commit/d11496b26dfee5957e7e2a1b328f346b2aca9348) [#6977](https://github.com/npm/cli/pull/6977) pkg: properly output in workspace mode (#6977) (@wraithgar)
- [`0f70088`](https://github.com/npm/cli/commit/0f7008851f1c250405e8dc326f15d535e8fc1eae) [#6969](https://github.com/npm/cli/pull/6969) correctly handle object licenses in SBOM generation (#6969) (@jamietanna)
- [`dce3b08`](https://github.com/npm/cli/commit/dce3b0896ba81b2109fea42ab32edd8a3193324c) [#6951](https://github.com/npm/cli/pull/6951) properly catch missing url opener error (#6951) (@wraithgar)

### Documentation

- [`a38836c`](https://github.com/npm/cli/commit/a38836ce9d703f5012ff4d4a8a4e3b9a9aedc025) [#6616](https://github.com/npm/cli/pull/6616) add path usage for view command (#6616) (@RobinKnipe)
- [`da18e4f`](https://github.com/npm/cli/commit/da18e4f9baa180beeb325a384759a26a19ac2919) [#6987](https://github.com/npm/cli/pull/6987) update npm-prune description (#6987) (@Eomm)

### Dependencies

- [`e9ec2f7`](https://github.com/npm/cli/commit/e9ec2f7005e7326d9a819978b251cf0a05062538) [#6994](https://github.com/npm/cli/pull/6994) `[email protected]`
- [`faf9eff`](https://github.com/npm/cli/commit/faf9efffb7bfe6efde6e53830cb054b34c3a6ea3) [#6994](https://github.com/npm/cli/pull/6994) `[email protected]`
- [`b00e780`](https://github.com/npm/cli/commit/b00e7808e370513e79ca31c261958377984e7444) [#6994](https://github.com/npm/cli/pull/6994) `@sigstore/[email protected]`
- [`4613774`](https://github.com/npm/cli/commit/461377426d998ed79400501b09e1ee67c32bee23) [#6994](https://github.com/npm/cli/pull/6994) hoisting newer deps in favor of older ones
- [`54c4f7b`](https://github.com/npm/cli/commit/54c4f7b8705b2c9d5b8bc5bb846f4e7863735b7e) [#6994](https://github.com/npm/cli/pull/6994) `[email protected]`
- [`8c5882f`](https://github.com/npm/cli/commit/8c5882f3eed305bbd3514d7143f9d92e9577e1b9) [#6994](https://github.com/npm/cli/pull/6994) `[email protected]`
- [`cd0c649`](https://github.com/npm/cli/commit/cd0c649ec2b421b59012854e61788a11a77194f2) [#6994](https://github.com/npm/cli/pull/6994) `[email protected]`
- [`a0a58b7`](https://github.com/npm/cli/commit/a0a58b735c418d8555a06890b63098c68f53106e) [#6994](https://github.com/npm/cli/pull/6994) `@sigstore/[email protected]`
- [`b3a53c6`](https://github.com/npm/cli/commit/b3a53c6ab5fd933fc7f8258c155ed31be834393e) [#6949](https://github.com/npm/cli/pull/6949) `[email protected]` (#6949)
- [Workspace](https://github.com/npm/cli/releases/tag/config-v8.0.2): `@npmcli/[email protected]`
- [Workspace](https://github.com/npm/cli/releases/tag/libnpmexec-v7.0.4): `[email protected]`
- [Workspace](https://github.com/npm/cli/releases/tag/libnpmpublish-v9.0.2): `[email protected]`

## [10.2.3](https://github.com/npm/cli/compare/v10.2.2...v10.2.3) (2023-11-02)

### Dependencies
Expand Down
2 changes: 1 addition & 1 deletion content/cli/v9/commands/npm-ls.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,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
[email protected].1 /path/to/npm
[email protected].2 /path/to/npm
└─┬ [email protected]
└── [email protected]
```
Expand Down
2 changes: 1 addition & 1 deletion content/cli/v9/commands/npm-prune.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ This command removes "extraneous" packages. If a package name is provided, then

Extraneous packages are those present in the `node_modules` folder that are not listed as any package's dependency list.

If the `--production` flag is specified or the `NODE_ENV` environment variable is set to `production`, this command will remove the packages specified in your `devDependencies`. Setting `--no-production` will negate `NODE_ENV` being set to `production`.
If the `--omit=dev` flag is specified or the `NODE_ENV` environment variable is set to `production`, this command will remove the packages specified in your `devDependencies`.

If the `--dry-run` flag is used then no changes will actually be made.

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

### Version

9.9.1
9.9.2

### Description

Expand Down
16 changes: 16 additions & 0 deletions content/cli/v9/using-npm/changelog.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,22 @@ redirect_from:
- /cli/v9/misc/changelog
---

## [9.9.2](https://github.com/npm/cli/compare/v9.9.1...v9.9.2) (2023-11-14)

### Bug Fixes

- [`4c9a5e1`](https://github.com/npm/cli/commit/4c9a5e15cdb7195a0781d765997eab49ef759d36) [#6993](https://github.com/npm/cli/pull/6993) look in workspace for exec commands (#6993) (@wraithgar)
- [`bb6f496`](https://github.com/npm/cli/commit/bb6f4960caebfefa81bfb82bbee2a54ff2b3a8b4) [#6992](https://github.com/npm/cli/pull/6992) correctly handle object licenses in SBOM generation (#6992) (@bdehamer, @jamietanna)
- [`10db3ca`](https://github.com/npm/cli/commit/10db3ca830408721c3d1ed108a4f04d9135a0598) [#6990](https://github.com/npm/cli/pull/6990) pkg: properly output in workspace mode (#6990) (@wraithgar)

### Documentation

- [`6ab06d7`](https://github.com/npm/cli/commit/6ab06d7a86614abb9b296feb85864e86f178f97e) [#6985](https://github.com/npm/cli/pull/6985) update npm-prune description (#6985) (@Eomm)

### Dependencies

- [Workspace](https://github.com/npm/cli/releases/tag/libnpmpublish-v7.5.1): `[email protected]`

## [9.9.1](https://github.com/npm/cli/compare/v9.9.0...v9.9.1) (2023-10-30)

### Bug Fixes
Expand Down
4 changes: 2 additions & 2 deletions content/nav.yml
Original file line number Diff line number Diff line change
Expand Up @@ -1054,7 +1054,7 @@
- title: Changelog
url: /cli/v8/using-npm/changelog
description: Changelog notes for each version
- title: Version 9.9.1
- title: Version 9.9.2
shortName: v9
url: /cli/v9
default: false
Expand Down Expand Up @@ -1324,7 +1324,7 @@
- title: Changelog
url: /cli/v9/using-npm/changelog
description: Changelog notes for each version
- title: Version 10.2.3
- title: Version 10.2.4
shortName: v10
url: /cli/v10
default: true
Expand Down

1 comment on commit 82d1945

@yehiaelmatrwy189
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you

Please sign in to comment.