npm-install

概要

npm install (with no args, in package dir)
npm install [<@scope>/]<name>
npm install [<@scope>/]<name>@<tag>
npm install [<@scope>/]<name>@<version>
npm install [<@scope>/]<name>@<version range>
npm install <alias>@npm:<name>
npm install <git-host>:<git-user>/<repo-name>
npm install <git repo url>
npm install <tarball file>
npm install <tarball url>
npm install <folder>
aliases: npm i, npm add
common options: [-P|--save-prod|-D|--save-dev|-O|--save-optional] [-E|--save-exact] [-B|--save-bundle] [--no-save] [--dry-run]

描述

此命令安装一个包，以及它所依赖的任何包。 如果包有 package-lock 或 shrinkwrap 文件，依赖的安装将由它驱动，如果两个文件都存在，则 npm-shrinkwrap.json 优先。 见 package-lock.json 和 npm shrinkwrap。

一个 package 是：

• a) 包含由 package.json 文件描述的程序的文件夹
• b) 一个 gzipped tarball，包含 (a)
• c) 解析为 (b) 的 url
• d) 在注册表上发布的 <name>@<version>（参见 registry），带有 (c)
• e) 指向 (d) 的 <name>@<tag>（见 npm dist-tag）
• f) 具有满足 (e) 的 "latest" 标签的 <name>
• g) 解决为 (a) 的 <git remote url>

即使你从不发布你的包，如果你只是想写一个 node 程序（a），你仍然可以获得使用 npm 的很多好处，也许你还想在打包后能够轻松地安装它成一个 tarball (b)。

• npm install（在包目录中，无参数）：

  在本地 node_modules 文件夹中安装依赖。

  在全局模式下（即，将 -g 或 --global 附加到命令中），它将当前包上下文（即当前工作目录）安装为全局包。

  默认情况下，npm install 将安装 package.json 中列为依赖的所有模块。

  使用 --production 标志（或者当 NODE_ENV 环境变量设置为 production 时），npm 将不会安装 devDependencies 中列出的模块。 当 NODE_ENV 环境变量设置为 production 时，要安装 dependencies 和 devDependencies 中列出的所有模块，你可以使用 --production=false。

  注意： 在向项目添加依赖时，--production 标志没有特殊含义。

• npm install <folder>：

  将目录中的包安装为当前项目中的符号链接。 它的依赖将在链接之前安装。 如果 <folder> 位于项目的根目录中，则它的依赖可能会像其他类型的依赖一样被提升到顶层 node_modules。

• npm install <tarball file>：

  安装位于文件系统上的包。 注意： 如果你只想将一个 dev 目录链接到你的 npm 根目录，你可以使用 npm link 更容易地做到这一点。

  压缩包要求：

  • 文件名必须使用 .tar、.tar.gz 或 .tgz 作为扩展名。

  • 包内容应位于 tarball 内的子文件夹中（通常称为 package/）。 npm 在安装包时剥离一个目录层（运行 tar x --strip-components=1 的等效项）。

  • 包必须包含具有 name 和 version 属性的 package.json 文件。

    示例：

    npm install ./package.tgz

• npm install <tarball url>：

  获取 tarball url，然后安装它。 为了区分此选项和其他选项，参数必须以 "http://" 或 "https://" 开头

  示例：

  npm 安装 https://github.com/indexzero/forever/tarball/v0.5.6

• npm install [<@scope>/]<name>：

  进行 <name>@<tag> 安装，其中 <tag> 是 "tag" 配置。 （参见 config。配置的默认值为 latest。）

  在大多数情况下，这将在 npm 注册表上安装标记为 latest 的模块版本。

  示例：

  npm 安装萨克斯

• npm install <alias>@npm:<name>：

  在自定义别名下安装包。 允许同名包的多个版本并排，更方便地导入具有其他长的包的名称，并使用 git forks 替换或分叉的 npm 包作为替换。 别名仅适用于你的项目，不会重命名传递依赖中的包。 别名应遵循 validate-npm-package-name 中规定的命名约定。

  例子：

  npm 安装我的反应@npm：反应 npm 安装 jquery2@npm：jquery@2 npm 安装 jquery3@npm:jquery@3 npm 安装 npa@npm：npm-package-arg

默认情况下，`npm install` 将任何指定的包保存到 `dependencies` 中。
此外，你可以使用一些额外的标志来控制它们的保存位置和方式：
* `-P, --save-prod`： 包将出现在你的 `dependencies` 中。 这是默认值，除非存在 `-D` 或 `-O`。
* `-D, --save-dev`： 包将出现在你的 `devDependencies` 中。
* `-O, --save-optional`： 包将出现在你的 `optionalDependencies` 中。
* `--no-save`： 防止保存到 `dependencies`。
当使用上述任何选项将依赖保存到 package.json 时，还有两个额外的可选标志：
* `-E, --save-exact`： 保存的依赖将使用精确的版本进行配置，而不是使用 npm 的默认 semver 范围运算符。
* `-B, --save-bundle`： 保存的依赖也将添加到你的 `bundleDependencies` 列表中。
此外，如果你有 `npm-shrinkwrap.json` 或 `package-lock.json`，那么它也会被更新。
`<scope>` 是可选的。 该包将从与指定范围关联的注册表中下载。 如果没有注册表与给定范围关联，则假定为默认注册表。 见 [`scope`](/cli/v6/using-npm/scope)。
注意： 如果你不在范围名称中包含 @ 符号，npm 会将其解释为 GitHub 存储库，请参见下文。 范围名称后还必须跟一个斜杠。
例子：
```bash
npm install sax
npm install githubname/reponame
npm install @myorg/privatepackage
npm install node-tap --save-dev
npm install dtrace-provider --save-optional
npm install readable-stream --save-exact
npm install ansi-regex --save-bundle
```
**注意**： 如果当前工作目录中有一个名为 `<name>` 的文件或文件夹，那么它将尝试安装它，如果它无效，则仅尝试按名称获取包。

• npm install [<@scope>/]<name>@<tag>：

  安装指定标签引用的包的版本。 如果该包的注册表数据中不存在该标记，则此操作将失败。

  示例：

  npm install sax@latest
  npm install @myorg/mypackage@latest

• npm install [<@scope>/]<name>@<version>：

  安装指定版本的包。 如果版本尚未发布到注册表，这将失败。

  示例：

  npm install sax@0.1.1
  npm install @myorg/privatepackage@1.5.0

• npm install [<@scope>/]<name>@<version range>：

  安装与指定版本范围匹配的包版本。 这将遵循 package.json 中描述的解决依赖的相同规则。

  请注意，大多数版本范围必须放在引号中，以便你的 shell 将其视为单个参数。

  示例：

  npm install sax@">=0.1.0 <0.2.0"
  npm install @myorg/privatepackage@">=0.1.0 <0.2.0"

• npm install <git remote url>：

  从托管的 git 提供程序安装包，并使用 git 克隆它。 对于完整的 git 远程 URL，只会尝试该 URL。

  <protocol>://[<user>[:<password>]@]<hostname>[:<port>][:][/]<path>[#<commit-ish> | #semver:<semver>]

  <protocol> 是 git、git+ssh、git+http、git+https 或 git+file 之一。

  如果提供了 #<commit-ish>，它将用于准确克隆该提交。 如果 commit-ish 的格式为 #semver:<semver>，<semver> 可以是任何有效的 semver 范围或确切版本，npm 将在远程存储库中查找与该范围匹配的任何标记或引用，就像它查找注册表依赖一样。 如果既没有指定 #<commit-ish> 也没有指定 #semver:<semver>，则使用存储库的默认分支。

  如果存储库使用子模块，这些子模块也将被克隆。

  如果正在安装的包中包含 prepare 脚本，则会安装它的 dependencies 和 devDependencies，并在打包和安装包之前运行准备脚本。

  以下 git 环境变量被 npm 识别，并在运行 git 时添加到环境中：

  • GIT_ASKPASS

  • GIT_EXEC_PATH

  • GIT_PROXY_COMMAND

  • GIT_SSH

  • GIT_SSH_COMMAND

  • GIT_SSL_CAINFO

  • GIT_SSL_NO_VERIFY

    有关详细信息，请参阅 git 手册页。

    例子：

    npm install git+ssh://git@github.com:npm/cli.git#v1.0.27
    npm install git+ssh://git@github.com:npm/cli#semver:^5.0
    npm install git+https://isaacs@github.com/npm/cli.git
    npm install git://github.com/npm/cli.git#v1.0.27
    GIT_SSH_COMMAND='ssh -i ~/.ssh/custom_ident' npm install git+ssh://git@github.com:npm/cli.git

• npm install <githubname>/<githubrepo>[#<commit-ish>]：

• npm install github:<githubname>/<githubrepo>[#<commit-ish>]：

  通过尝试使用 git 克隆它，在 https://github.com/githubname/githubrepo 安装包。

  如果提供了 #<commit-ish>，它将用于准确克隆该提交。 如果 commit-ish 的格式为 #semver:<semver>，<semver> 可以是任何有效的 semver 范围或确切版本，npm 将在远程存储库中查找与该范围匹配的任何标记或引用，就像它查找注册表依赖一样。 如果既没有指定 #<commit-ish> 也没有指定 #semver:<semver>，则使用 master。

  与常规 git 依赖一样，如果包有 prepare 脚本，则将在包完成安装之前安装 dependencies 和 devDependencies。

  例子：

  npm install mygithubuser/myproject
  npm install github:mygithubuser/myproject

• npm install gist:[<githubname>/]<gistID>[#<commit-ish>|#semver:<semver>]：

  通过尝试使用 git 克隆它，在 https://gist.github.com/gistID 安装包。 与 gist 关联的 GitHub 用户名是可选的，不会保存在 package.json 中。

  与常规 git 依赖一样，如果包有 prepare 脚本，则将在包完成安装之前安装 dependencies 和 devDependencies。

  示例：

  npm install gist:101a11beef

• npm install bitbucket:<bitbucketname>/<bitbucketrepo>[#<commit-ish>]：

  通过尝试使用 git 克隆它，在 https://bitbucket.org/bitbucketname/bitbucketrepo 安装包。

  如果提供了 #<commit-ish>，它将用于准确克隆该提交。 如果 commit-ish 的格式为 #semver:<semver>，<semver> 可以是任何有效的 semver 范围或确切版本，npm 将在远程存储库中查找与该范围匹配的任何标记或引用，就像它查找注册表依赖一样。 如果既没有指定 #<commit-ish> 也没有指定 #semver:<semver>，则使用 master。

  与常规 git 依赖一样，如果包有 prepare 脚本，则将在包完成安装之前安装 dependencies 和 devDependencies。

  示例：

  npm install bitbucket:mybitbucketuser/myproject

• npm install gitlab:<gitlabname>/<gitlabrepo>[#<commit-ish>]：

  通过尝试使用 git 克隆它，在 https://gitlab.com/gitlabname/gitlabrepo 安装包。

  如果提供了 #<commit-ish>，它将用于准确克隆该提交。 如果 commit-ish 的格式为 #semver:<semver>，<semver> 可以是任何有效的 semver 范围或确切版本，npm 将在远程存储库中查找与该范围匹配的任何标记或引用，就像它查找注册表依赖一样。 如果既没有指定 #<commit-ish> 也没有指定 #semver:<semver>，则使用 master。

  与常规 git 依赖一样，如果包有 prepare 脚本，则将在包完成安装之前安装 dependencies 和 devDependencies。

  示例：

  npm install gitlab:mygitlabuser/myproject
  npm install gitlab:myusr/myproj#semver:^5.0

你可以组合多个参数，甚至多种类型的参数。 例如：

npm install sax@">=0.1.0 <0.2.0" bench supervisor

--tag 参数将适用于所有指定的安装目标。 如果存在具有给定名称的标记，则标记的版本优先于较新的版本。

--dry-run 参数将以通常的方式报告在没有实际安装任何东西的情况下安装会完成的工作。

--package-lock-only 参数只会更新 package-lock.json，而不是检查 node_modules 和下载依赖。

-f 或 --force 参数将强制 npm 获取远程资源，即使磁盘上存在本地副本。

npm install sax --force

--no-fund 参数将隐藏在每次安装结束时显示的消息，该消息确认正在寻找资金的依赖数量。 见 npm-fund(1)

-g 或 --global 参数将导致 npm 在全局而不是本地安装包。 见 文件夹。

--global-style 参数将导致 npm 以与全局 node_modules 文件夹相同的布局将包安装到本地 node_modules 文件夹中。 只有你的直接依赖将显示在 node_modules 中，并且它们所依赖的所有内容都将展平在它们的 node_modules 文件夹中。 这显然会消除一些数据去重。

--ignore-scripts 参数将导致 npm 不执行 package.json 中定义的任何脚本。 见 scripts。

--legacy-bundling 参数将导致 npm 安装包，以便 1.4 之前的 npm 版本（例如 node 0.8 中包含的版本）可以安装包。 这消除了所有自动数据去重。

在某些情况下，--link 参数将导致 npm 将全局安装链接到本地​​空间。

--no-bin-links 参数将阻止 npm 为包可能包含的任何二进制文件创建符号链接。

--no-optional 参数将阻止安装可选依赖。

--no-shrinkwrap 参数，它将忽略可用的包锁定或收缩封装文件并使用 package.json 代替。

--no-package-lock 参数将阻止 npm 创建 package-lock.json 文件。 当使用 package-lock 禁用的 npm 运行时，安装时不会自动修剪你的 node 模块。

--nodedir=/path/to/node/source 参数将允许 npm 找到 node 源代码，以便 npm 可以编译原生模块。

--only={prod[uction]|dev[elopment]} 参数将导致仅安装 devDependencies 或仅安装非 devDependencies，而不管 NODE_ENV。

--no-audit 参数可用于禁用向配置的注册表发送审计报告。 有关发送内容的详细信息，请参见 npm-audit。

见 config。 许多配置参数对安装有一些影响，因为这是 npm 所做的大部分工作。

算法

为了安装一个包，npm 使用以下算法：

load the existing node_modules tree from disk
clone the tree
fetch the package.json and assorted metadata and add it to the clone
walk the clone and add any missing dependencies
  dependencies will be added as close to the top as is possible
  without breaking any other modules
compare the original tree with the cloned tree and make a list of
actions to take to convert one to the other
execute all of the actions, deepest first
  kinds of actions are install, update, remove and move

对于这个 package{dep} 结构： A{B,C}, B{C}, C{D}，这个算法产生：

A
+-- B
+-- C
+-- D

也就是说，从 B 到 C 的依赖通过 A 已经导致 C 安装在更高级别的事实来满足。 D 仍然安装在顶层，因为它没有任何冲突。

对于 A{B,C}, B{C,D@1}, C{D@2}，此算法产生：

A
+-- B
+-- C
   `-- D@2
+-- D@1

因为 B 的 D@1 将安装在顶层，所以 C 现在必须为自己私下安装 D@2。 该算法是确定性的，但如果请求以不同顺序安装两个依赖，则可能会生成不同的树。

有关 npm 创建的特定文件夹结构的更详细说明，请参阅 文件夹。

npm 安装算法的限制

npm 将拒绝安装与当前包同名的任何包。 这可以用 --force 标志覆盖，但在大多数情况下，可以简单地通过更改本地包名称来解决。

有一些非常罕见和病态的边缘情况，其中一个循环可能导致 npm 尝试安装一个永无止境的包树。 这是最简单的情况：

A -> B -> A' -> B' -> A -> B -> A' -> B' -> A -> ...

其中 A 是某个包的版本，A' 是同一包的不同版本。 因为 B 依赖于与树中已经存在的版本不同的 A 版本，所以它必须安装一个单独的副本。 A' 也是一样，必须安装 B'。 由于 B' 依赖于 A 的原始版本，该版本已被覆盖，因此循环陷入无限倒退。

为了避免这种情况，npm flat-out 拒绝安装任何已经存在于包文件夹祖级树中的任何 name@version。 更正确但更复杂的解决方案是将现有版本符号链接到新位置。 如果这影响了实际用例，将对其进行调查。

也可以看看

• npm folders
• npm update
• npm audit
• npm fund
• npm link
• npm rebuild
• npm scripts
• npm build
• npm config
• npmrc
• npm registry
• npm dist-tag
• npm uninstall
• npm shrinkwrap
• package.json