diff options
author | Rebecca Turner <me@re-becca.org> | 2017-06-29 05:58:29 +0300 |
---|---|---|
committer | Kat Marchán <kzm@sykosomatic.org> | 2017-07-06 00:58:36 +0300 |
commit | 4f45ba222e2ac6dbe6d696cb7a8e678bbda7c839 (patch) | |
tree | 46f0fdec677fdba55b7335d149837993d7833797 | |
parent | dfa037ffc6ab44f444a4a7cf04111da9ca5a4443 (diff) |
spec/package-lock: Document requires
PR-URL: https://github.com/npm/npm/pull/17508
Credit: @iarna
Reviewed-By: @zkat
-rw-r--r-- | doc/spec/package-lock.md | 16 |
1 files changed, 14 insertions, 2 deletions
diff --git a/doc/spec/package-lock.md b/doc/spec/package-lock.md index 858364352..3f5d5d3ea 100644 --- a/doc/spec/package-lock.md +++ b/doc/spec/package-lock.md @@ -36,7 +36,11 @@ property match that environment variable. ### dependencies -A mapping of package name to dependency object. Dependency objects have the +These are the modules installed in the `node_modules`. Some of these are +dependencies some of these are transitive dependencies (that is, +dependencies of our dependencies). + +This is a mapping of package name to dependency object. Dependency objects have the following properties: #### version *(changed)* @@ -108,9 +112,17 @@ on the current platform. This is a record of what specifier was used to originally install this package. This should not be included in new `package-lock.json` files. +#### requires + +This is a mapping of module name to version. This is a list of everything +this module requires, regardless of where it will be installed. The version +should match via normal matching rules a dependency either in our +`dependencies` or in a level higher than us. + #### dependencies -The dependencies of this dependency, exactly as at the top level. +Exactly like `dependencies` at the top level, this is a list of modules to +isntall in the `node_modules` of this module. ## Generating |