npm学习笔记

是指任何可以通过Node.js的 require() 来加载的文件或者目录，例如：

1. 一个包含了package.json的目录，package.json中包含main字段
2. 一个包含了index.js的目录
3. 一个JavaScript文件

大部分的npm包都属于模块，因为一般情况下，npm包都是供Node.js程序通过require()来加载的

几乎所有的npm包，都包含多个模块，这是因为其中JS文件可以通过require()来加载

在Node.js程序中，模块还可能指通过require()调用得到的变量：

之所以node_modules目录如此命名，是因为它是用来寻找模块（而不是包） 的，对于文件node_modules/request.js，可以通过上面的require()代码加载

在发布包到仓库之前调用
在进行本地 npm install，不带任何参数时调用

如果你希望在包被使用之前，执行不依赖于目标（安装包的）平台的动作，可以使用该Stage。示例场景包括：

1. 编译CoffeeScript为JavaScript
2. 创建JavaScript文件的最小化版本
3. 下载包需要使用的远程资源

使用该Stage的好处是，目标动作可以在单个地方、一次性的被执行，因此可以降低复杂性和不确定性。使用该Stage还意味着：

1. 你可以将coffee-script声明为devDependency
2. 不需要在包中包含JS压缩器（minifiers）
3. 你不需要在目标系统上调用curl或者wget来下载东西

对公共包进行访问控制：

为仓库添加一个用户：

打印npm安装可执行文件的目标目录：

猜测包的缺陷跟踪URL，并用浏览器打开它：

构建一个包： npm build [<package-folder>] 

该命令是一个底层（Plumbing）的命令，通常你不应该直接调用。它被link或者install子命令调用

如果你需要调用build脚本，可以：

操控包缓存：

管理npm的配置文件：

npm可以从命令行参数、环境变量、npmrc文件读取配置参数，某些情况下还可以从package.json中读取 

减少重复依赖：

该子命令会搜索本地包的依赖树，并尝试像树的根部移动依赖，以便在总体上简化其结构。例如：

在执行该子命令后，会被简化为：

更新包在仓库中的条目，标记某个版本为废弃的：

修改包的分发标签（distribution tags）：

尝试猜测包的文档地址，并在浏览器中打开：

安装一个包：

该子命令用于安装一个包，以及所有该包的依赖。如果包提供了shrinkwrap文件则依赖的安装由shrinkwrap驱动 

下面是三个常用的、互斥的选项：
-S, --save  把安装的包加入到dependencies
-D, --save-dev  把安装的包加入到devDependencies
-O, --save-optional  把安装的包加入到optionalDependencies

当使用上面三个选项之一时，可以指定：
-E, --save-exact  在package.json的dependencies/devDependencies/optionalDependencies中限定使用精确的依赖版本

为一个包的目录创建符号链接：

从全局安装目录中定位到目标包，并在当前目录中创建该包的符号链接

列出已经安装的包： npm ls [[<@scope>/]<pkg> ...] 

可以显示当前工程的依赖树

检查已经过期的包： npm outdated [[<@scope>/]<pkg> ...] 

输出列如下：
wanted   最高的满足package.json需求的包版本
latest   仓库中被标记为latest的包版本
location  在依赖树的何处定位到此包

注意：该子命令默认使用depth为0，因此只有直接依赖的包过期了才会被检测到

管理包的所有者信息：

为一个包创建压缩文件：

压缩文件会被拷贝到当前工作目录，命名为： <name>-<version>.tgz 

打印本地前缀到标准输出——最接近工作目录的、包含package.json的祖代目录

如果指定全局模式，则打印全局安装目录前缀

移除没有使用的依赖： npm prune [[<@scope>/]<pkg>...] [--production] 

该子命令移除没有在父包依赖列表里出现的那些包

如果指定--production，则devDependencies中指定的依赖被移除

发布一个包到仓库：

重新构建一个包： npm rebuild [[<@scope>/<name>]...]  

当你安装了新版本的Node.js，并且需要重新编译所有的C++加载项时，可以使用该命令

重启启动一个包： npm restart [-- <args>]  

该命令会依次执行stop、restart、start脚本，以及相关的pre-*、post-*脚本。具体顺序如下：
prerestart ⇨ prestop ⇨ stop ⇨ poststop ⇨ restart ⇨ prestart ⇨ start ⇨ poststart ⇨ postrestart

打印node_modules目录所在位置到标准输出： npm root [-g] 

运行任意的包脚本：

这里的command是定义在package.json的scripts属性中的一个键

在仓库中搜索指定的包：

锁定依赖的版本： npm shrinkwrap 

该子命令锁定包的依赖的版本，当包被安装时，其依赖的精确版本会被安装

默认情况下，npm install会递归的安装目标包package.json中指定的依赖项，选择满足依赖semver的最新版本。但是有些时候需要避免此行为

该子命令会生成一个 npm-shrinkwrap.json 文件，其中记录依赖的精确版本

标记你最喜欢的包：

管理团队和团队成员：

测试一个包：

该子命令执行package.json中的test脚本

删除一个包：

从仓库中删除一个包： npm unpublish [<@scope>/]<pkg>[@<version>] 

通常不应该删除已经发布的包版本，因为其它用户可能依赖它。可以使用deprecate命令代替

更新一个包： npm update [-g] [<pkg>...] 

该命令会更新所有指定的包到尽可能新（semver允许的）的版本

该命令也会安装缺失的软件包，如果指定--dev则devDependencies中的依赖也被处理

显示当前用户名： npm whoami [--registry <registry>] 

该命令显示username配置参数

包的名称，该字段与version一起，唯一的标识一个包。该字段必须：

1. 不大于214字符
2. 不能以点号、下划线开头
3. 新创建的包，包名不得包含大写字母
4. 不得包含URL不安全字符

此包的缺陷跟踪地址、电子邮件地址，格式：

工程中需要包含在包中的目录、文件列表

如果不指定此字段，可以使用.npmignore、.gitignore设置排除规则

文件package.json、README、CHANGELOG、LICENSE、LICENCE总是包含

文件.git、.svn等总是排除

可以指定一个或者多个需要安装到PATH下的可执行文件，示例：

设置此包的CVS仓库：

一个字典，指定在包的生命周期的不同阶段需要被执行的脚本

如果包的根目录下存在一个server.js文件，则默认值为：

如果包的根目录下存在一个binding.gyp文件，则默认值为：

指定包的依赖项。这些依赖项必须随着当前包一起安装

一个字典，键为依赖的包的名称，值为包的版本：
version    精确版本
>version  最小版本（不包含）
>=version 最小版本
<version 最大版本（不包含）
<=version 最大版本
~version  允许BUG修复版本变动
^version  允许兼容版本变动
1.2.x  允许1.2下任意BUG修复版本
*  允许所有版本，""等价于"*"
version1 - version2  在两个版本之间（包含）
range1 || range2   匹配range1或者range2
tag  匹配标记了tag的版本

当前包的一个依赖，此依赖也会安装该包的用户所依赖。假设当前包是grunt插件，则它依赖于grunt，而此插件的用户也必然依赖于grunt。使用该配置，可以声明插件所要求的宿主包的版本

如果当前包依赖于request 2.x的同时依赖于some-other-library，而some-other-library依赖于request 1.x，则当前包安装后的依赖树如下：

感谢模块化机制，通常情况下这不会造成问题， some-other-library使用自己的1.9.9版本，对当前包不会造成冲突。但是在使用插件时，会出现问题，这与插件的运行方式有关

从npm 3.x开始peerDependencies不会自动安装，出现如下警告：

指定兼容的Node.js引擎、npm版本：

指定支持的操作系统，示例：

指定支持的CPU架构，示例：

默认Infinity，再次访问仓库检查之前，缓存有效的最大时间

注意：除非调用 npm cache clean 否则缓存不会消失，缓存仅仅影响GET请求

默认false，有多种效果：

1. 生命周期脚本执行失败，不影响构建进程
2. 不使用缓存

是否在全局模式下运行，全局模式下，包被安装到prefix目录而不是当前目录：

1. 包被安装到{prefix}/lib/node_modules
2. 可执行文件被链接到{prefix}/bin
3. Man手册被连接到{prefix}/share/man

默认warn，设置日志级别："silent", "error", "warn", "http", "info", "verbose", "silly"

日志被输出到当前目录的npm-debug.log文件中

设置全局安装目录的前缀

如果在命令行参数中指定，用于强制非全局命令在指定的目录中运行

默认false，设置为true则运行在产品模式：

1. 不带任何参数运行npm install时devDependencies不会在顶级安装
2. 为生命周期脚本设置NODE_ENV="production"

默认^，在保存到package.json的某个依赖列表时，被依赖包的版本使用的Semver前缀