Skip to content

Commit 1be8e95

Browse files
committed
docs: update ignore rules
Adds bun lockfile, and points to the package.json docs as the authoritative list for ignore rules in the cli docs.
1 parent 4bf1901 commit 1be8e95

File tree

3 files changed

+10
-2
lines changed

3 files changed

+10
-2
lines changed

docs/lib/content/commands/npm-publish.md

+3
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,9 @@ See [`developers`](/using-npm/developers) for full details on what's
8383
included in the published package, as well as details on how the package is
8484
built.
8585

86+
See [`package.json`](/configuring-npm/package-json) for more info on
87+
what can and can't be ignored.
88+
8689
### Configuration
8790

8891
<!-- AUTOGENERATED CONFIG DESCRIPTIONS -->

docs/lib/content/configuring-npm/package-json.md

+2
Original file line numberDiff line numberDiff line change
@@ -324,6 +324,7 @@ Some files are always ignored by default:
324324
if you wish it to be published)
325325
* `pnpm-lock.yaml`
326326
* `yarn.lock`
327+
* `bun.lockb`
327328

328329
Most of these ignored files can be included specifically if included in
329330
the `files` globs. Exceptions to this are:
@@ -334,6 +335,7 @@ the `files` globs. Exceptions to this are:
334335
* `package-lock.json`
335336
* `pnpm-lock.yaml`
336337
* `yarn.lock`
338+
* `bun.lockb`
337339

338340
These can not be included.
339341

docs/lib/content/using-npm/developers.md

+5-2
Original file line numberDiff line numberDiff line change
@@ -112,8 +112,8 @@ as `.gitignore` files:
112112
* You can end patterns with a forward slash `/` to specify a directory.
113113
* You can negate a pattern by starting it with an exclamation point `!`.
114114

115-
By default, the following paths and files are ignored, so there's no
116-
need to add them to `.npmignore` explicitly:
115+
By default, some paths and files are ignored, so there's no
116+
need to add them to `.npmignore` explicitly. Some examples are:
117117

118118
* `.*.swp`
119119
* `._*`
@@ -148,6 +148,9 @@ property of `package.json`, which is an array of file or directory names
148148
that should be included in your package. Sometimes manually picking
149149
which items to allow is easier to manage than building a block list.
150150

151+
See [`package.json`](/configuring-npm/package-json) for more info on
152+
what can and can't be ignored.
153+
151154
#### Testing whether your `.npmignore` or `files` config works
152155

153156
If you want to double check that your package will include only the files

0 commit comments

Comments
 (0)