Skip to content

Commit 9938718

Browse files
committed
CLI documentation update from CI
1 parent 0d4d59e commit 9938718

File tree

7 files changed

+31
-15
lines changed

7 files changed

+31
-15
lines changed

content/cli/v10/commands/npm-ls.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ Note: to get a "bottoms up" view of why a given package is included in the tree
5252
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:
5353

5454
```bash
55-
npm@10.2.4 /path/to/npm
55+
npm@10.2.5 /path/to/npm
5656
└─┬ init-package-json@0.0.4
5757
└── promzard@0.1.5
5858
```

content/cli/v10/commands/npm-sbom.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -271,7 +271,7 @@ SBOM format to use when generating SBOMs.
271271
- Default: "library"
272272
- Type: "library", "application", or "framework"
273273

274-
The type of package described by the generated SBOM. For SPDX, this is the value for the `primaryPackagePurpose` fieled. For CycloneDX, this is the value for the `type` field.
274+
The type of package described by the generated SBOM. For SPDX, this is the value for the `primaryPackagePurpose` field. For CycloneDX, this is the value for the `type` field.
275275

276276
#### `workspace`
277277

content/cli/v10/commands/npm-unpublish.mdx

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,9 @@ This removes a package version from the registry, deleting its entry and removin
5353

5454
The npm registry will return an error if you are not [logged in](/cli/v10/commands/npm-adduser).
5555

56-
If you do not specify a version or if you remove all of a package's versions then the registry will remove the root package entry entirely.
56+
If you do not specify a package name at all, the name and version to be unpublished will be pulled from the project in the current directory.
57+
58+
If you specify a package name but do not specify a version or if you remove all of a package's versions then the registry will remove the root package entry entirely.
5759

5860
Even if you unpublish a package version, that specific name and version combination can never be reused. In order to publish the package again, you must use a new version number. If you unpublish the entire package, you may not publish any new versions of that package until 24 hours have passed.
5961

content/cli/v10/commands/npm.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Note: This command is unaware of workspaces.
3131

3232
### Version
3333

34-
10.2.4
34+
10.2.5
3535

3636
### Description
3737

content/cli/v10/configuring-npm/package-json.mdx

Lines changed: 23 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -256,23 +256,37 @@ Certain files are always included, regardless of settings:
256256

257257
`README` & `LICENSE` can have any case and extension.
258258

259-
Conversely, some files are always ignored:
259+
Some files are always ignored by default:
260260

261+
- `*.orig`
262+
- `.*.swp`
263+
- `.DS_Store`
264+
- `._*`
261265
- `.git`
262-
- `CVS`
263-
- `.svn`
266+
- `.npmrc`
264267
- `.hg`
265268
- `.lock-wscript`
269+
- `.npmrc`
270+
- `.svn`
266271
- `.wafpickle-N`
267-
- `.*.swp`
268-
- `.DS_Store`
269-
- `._*`
272+
- `CVS`
273+
- `config.gypi`
274+
- `node_modules`
270275
- `npm-debug.log`
276+
- `package-lock.json` (use [`npm-shrinkwrap.json`](/cli/v10/configuring-npm/npm-shrinkwrap-json) if you wish it to be published)
277+
- `pnpm-lock.yaml`
278+
- `yarn.lock`
279+
280+
Most of these ignored files can be included specifically if included in the `files` globs. Exceptions to this are:
281+
282+
- `.git`
271283
- `.npmrc`
272284
- `node_modules`
273-
- `config.gypi`
274-
- `*.orig`
275-
- `package-lock.json` (use [`npm-shrinkwrap.json`](/cli/v10/configuring-npm/npm-shrinkwrap-json) if you wish it to be published)
285+
- `package-lock.json`
286+
- `pnpm-lock.yaml`
287+
- `yarn.lock`
288+
289+
These can not be included.
276290

277291
### main
278292

content/cli/v10/using-npm/config.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -992,7 +992,7 @@ SBOM format to use when generating SBOMs.
992992
- Default: "library"
993993
- Type: "library", "application", or "framework"
994994

995-
The type of package described by the generated SBOM. For SPDX, this is the value for the `primaryPackagePurpose` fieled. For CycloneDX, this is the value for the `type` field.
995+
The type of package described by the generated SBOM. For SPDX, this is the value for the `primaryPackagePurpose` field. For CycloneDX, this is the value for the `type` field.
996996

997997
#### `scope`
998998

content/nav.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1324,7 +1324,7 @@
13241324
- title: Changelog
13251325
url: /cli/v9/using-npm/changelog
13261326
description: Changelog notes for each version
1327-
- title: Version 10.2.4
1327+
- title: Version 10.2.5
13281328
shortName: v10
13291329
url: /cli/v10
13301330
default: true

0 commit comments

Comments
 (0)