Skip to content

Commit e19a2f5

Browse files
committed
docs: document special meaning of registry.npmjs.com
This behavior has been present in npm for a while, but I haven't found where it's documented. This is my attempt at documenting the behavior based on my understanding of it. I think a SME should contribute to this so the documentation is correct. npm/feedback#544 #3783 https://github.com/npm/arborist/blob/478871bf0a44a8ec516b9057585b8707e60b0349/lib/arborist/reify.js#L687-L693
1 parent 2c74190 commit e19a2f5

File tree

2 files changed

+11
-2
lines changed

2 files changed

+11
-2
lines changed

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

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,8 @@ Package descriptors have the following fields:
138138
the case of packages fetched from the registry, this will be a url to a
139139
tarball. In the case of git dependencies, this will be the full git url
140140
with commit sha. In the case of link dependencies, this will be the
141-
location of the link target.
141+
location of the link target. `registry.npmjs.org` is a magic value meaning
142+
"the currently configured registry".
142143

143144
* integrity: A `sha512` or `sha1` [Standard Subresource
144145
Integrity](https://w3c.github.io/webappsec/specs/subresourceintegrity/)
@@ -201,7 +202,8 @@ Dependency objects have the following fields:
201202

202203
* resolved: For registry sources this is path of the tarball relative to
203204
the registry URL. If the tarball URL isn't on the same server as the
204-
registry URL then this is a complete URL.
205+
registry URL then this is a complete URL. `registry.npmjs.org` is a magic
206+
value meaning "the currently configured registry".
205207

206208
* bundled: If true, this is the bundled dependency and will be installed
207209
by the parent module. When installing, this module will be extracted

docs/content/using-npm/registry.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,13 @@ The registry URL used is determined by the scope of the package (see
3030
supplied by the `registry` config parameter. See [`npm config`](/commands/npm-config),
3131
[`npmrc`](/configuring-npm/npmrc), and [`config`](/using-npm/config) for more on managing npm's configuration.
3232

33+
When the default registry is used in a package-lock or shrinkwrap is has the
34+
special meaning of "the currently configured registry". If you create a lock
35+
file while using the default registry you can switch to another registry and
36+
npm will install packages from the new registry, but if you create a lock
37+
file while using a custom registry packages will be installed from that
38+
registry even after you change to another registry.
39+
3340
### Does npm send any information about me back to the registry?
3441

3542
Yes.

0 commit comments

Comments
 (0)