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 <git-host>:<git-user>/<repo-name>
npm install <git repo url>
npm install <tarball file>
npm install <tarball url>
npm install <folder>
alias: npm i
common options: [-P|--save-prod|-D|--save-dev|-O|--save-optional] [-E|--save-exact] [-B|--save-bundle] [--no-save] [--dry-run]
详情
此命令安装一个 package ,以及它所依赖的任何 packages 。如果 package 有一个 package-lock 或 shrinkwrap 文件,依赖项的安装将由这个文件驱动。(两个文件同时存在,则 npm-shrinkwrap.json 优先。)
一个 package 是:
a) 一个包含 package.json 文件的文件夹。
b) 一个包含(a)的压缩包。
c) 一个下载(b)的链接
d) 一个将(c)发布到 registry 的 <name>@<version> 。
e) 一个可以指向到(d)的 <name>@<tag> (参考 npm-dist-tag)。
f) 一个可以满足(e)的 "latest" (最新的)tag 的 <name> 。
g) 一个可以解析为 (a)的 <git remote url>
即使你从没有发布过你的 packages ,当你在写一个 node 程序(a),或者你希望它被打包后能安装在其他地方成为一个压缩包(b),你依旧可以从 npm 得到很多好处。
- npm install :
命令 | 含义 |
---|---|
npm install |
在本地 node_modules 文件夹中安装 package.json 中列为依赖项的所有模块。 |
npm install --global |
在全局 node_modules 文件夹中安装 package.json 中列为依赖项的所有模块。 |
npm install --production |
当 NODE_ENV 环境变量为 production ,则不安装 package.json 中 devDependencies 列出的任何模块。 |
- npm install <folder> :
<folder>必须也是一个 package 。
会把 <folder> 安装到当前项目中(这时的 <folder> package 称为 symlink ),<folder>中也可能有自己的依赖,会在自己被 link 之前自动安装好自己的依赖。
如果 <folder> 位于项目的根目录中,则它的依赖项很可能会被提升至顶层的 node_modules中。
- npm install <tarball file> :
安装一个位于系统文件上的 package 。注意:如果你只是想将本地的目录链接到你的当前项目的根目录下,使用 npm link 会更轻松。
压缩包要求:
文件名必须使用 .tar 、.tar.gz 、或 .tgz 作为扩展名。
文件夹层级类似 myTarball.tar/package。
package 中必须有 package.json 文件和 package name 。
npm install ./myTarball.tar
- npm install <tarball url> :
请求压缩包 url ,然后安装。为了和其他命令区分,url 必须以 "http://" 或 "https://"。
例如:
npm install https://github.com/indexzero/forever/tarball/v0.5.6
- npm install [<@scope>/]<name> :
进行一个 <name>@<tag> 的安装,<tag>参考 nam-config 。
在大多数情况下,这将安装 npm registry 中最新(latest)的模块版本。
例如:
npm install sax
默认情况下,npm install 将任何指定的 packages 保存到 dependencies 中,我们可以使用额外的 flags 去控制它们的保存位置和方式:
Flags | 描述 |
---|---|
-P, --save-prod | 默认 |
-D, --save-dev | packages 将 出现在 devDependencies 中。 |
-O, --save-optional | packages 将 出现在 optionalDependencies (可选依赖项) 中。 |
--no-save | 防止保存到 devDependencies 中 |
以上任何命令都是将 packages 保存到 package.json 中,除此之外还有两个额外的可选 flags:
Flags | 描述 |
---|---|
-E, --save-exact | 使 package 版本是确定的,而不是使用 npm 默认 semver 范围。 |
-B, --save-bundle | 保存 package ,也会被添加至 bundleDependencies 中。 |
另外,当你执行完 npm install [<@scope>/]<name> ,本地的 package-lock.json 和 npm-shrinkwrap.json 将会被更新。
<scope> 是可选的。如果有则会从 scope 对应的 registry 中 下载。没有设置 scope 的 registry ,则会从 npm registry 中下载。
如果你要安装的 scoped package 名字中没有加 @ 符号,npm 将会解释为 GitHub 储存库。
注意:会先查找当前目录下的本地的 <folder> 中有无一样的包,没有才去 registry 中查找。
- npm install [<@scope>/]<name>@<tag> :
安装指定 tag 引用的 package 的版本。如果 tag 在 registry 中不存在,则此操作将失败。tag 默认为 latest
例如:
npm install sax@latest
npm install @myorg/package@latest
- npm install [@<scope>/]<name>@<version> :
安装指定版本的 package ,如果指定版本在 registry 中不存在,则报错。
例如:
npm install sax@0.1.1
npm install @myorg/package@1.5.0
接下来是一些从 GitHub 上下载包的命令,这里不做翻译,可以查看原文。
这里介绍一个 flags: --force,-f
,强制 packages 从远端 registry 下载。