CLI documentation update from CI
npm CLI robot committed
Dec 6, 2023 at 22:07 UTC
9938718488316b0d71282c46a8379cbd46f1e9e6
7 files changed
+31
-15
content/cli/v10/commands/npm-ls.mdx
+1
-1
@@ -52,7 +52,7 @@ Note: to get a "bottoms up" view of why a given package is included in the tree
52
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:
53
54
```bash
55
-npm@10.2.4 /path/to/npm
55
+npm@10.2.5 /path/to/npm
56
└─┬ init-package-json@0.0.4
57
└── promzard@0.1.5
58
```
content/cli/v10/commands/npm-sbom.mdx
+1
-1
@@ -271,7 +271,7 @@ SBOM format to use when generating SBOMs.
271
- Default: "library"
272
- Type: "library", "application", or "framework"
273
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.
275
276
#### `workspace`
277
content/cli/v10/commands/npm-unpublish.mdx
+3
-1
@@ -53,7 +53,9 @@ This removes a package version from the registry, deleting its entry and removin
53
54
The npm registry will return an error if you are not [logged in](/cli/v10/commands/npm-adduser).
55
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.
59
60
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.
61
content/cli/v10/commands/npm.mdx
+1
-1
@@ -31,7 +31,7 @@ Note: This command is unaware of workspaces.
31
32
### Version
33
34
-10.2.4
34
+10.2.5
35
36
### Description
37
content/cli/v10/configuring-npm/package-json.mdx
+23
-9
@@ -256,23 +256,37 @@ Certain files are always included, regardless of settings:
256
257
`README` & `LICENSE` can have any case and extension.
258
259
-Conversely, some files are always ignored:
259
+Some files are always ignored by default:
260
261
+- `*.orig`
262
+- `.*.swp`
263
+- `.DS_Store`
264
+- `._*`
265
- `.git`
262
-- `CVS`
263
-- `.svn`
266
+- `.npmrc`
267
- `.hg`
268
- `.lock-wscript`
269
+- `.npmrc`
270
+- `.svn`
271
- `.wafpickle-N`
267
-- `.*.swp`
268
-- `.DS_Store`
269
-- `._*`
272
+- `CVS`
273
+- `config.gypi`
274
+- `node_modules`
275
- `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`
283
- `.npmrc`
284
- `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.
290
291
### main
292
content/cli/v10/using-npm/config.mdx
+1
-1
@@ -992,7 +992,7 @@ SBOM format to use when generating SBOMs.
992
- Default: "library"
993
- Type: "library", "application", or "framework"
994
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.
996
997
#### `scope`
998
content/nav.yml
+1
-1
@@ -1324,7 +1324,7 @@
1324
- title: Changelog
1325
url: /cli/v9/using-npm/changelog
1326
description: Changelog notes for each version
1327
- - title: Version 10.2.4
1327
+ - title: Version 10.2.5
1328
shortName: v10
1329
url: /cli/v10
1330
default: true