NPM详解

目录

• NPM 基础
  • NPM 使用介绍
  • 全局安装与本地安装(重要)
  • nrm安装与配置(npm的镜像源管理工具)
• NPM 常用命令详解
  • 常用命令汇总(重要)
  • 空项目创建及已存在项目的复制应用(重要)
  • 框架类的运行与启动(重要)
  • 使用 npm 命令安装模块(重要)
  • package.json
  • 卸载模块
  • 更新模块
  • 搜索模块
  • 创建模块
  • NPM 资源库中注册用户
  • 版本号
  • NPM 常用命令
  • 使用淘宝 NPM 镜像

NPM 基础

NPM 使用介绍

推荐一个NPM基本介绍地址（Alan）：https://www.runoob.com/nodejs/nodejs-npm.html

NPM是随同NodeJS一起安装的包管理工具，能解决NodeJS代码部署上的很多问题，常见的使用场景有以下几种：

• 允许用户从NPM服务器下载别人编写的第三方包到本地使用。
• 允许用户从NPM服务器下载并安装别人编写的命令行程序到本地使用。
• 允许用户将自己编写的包或命令行程序上传到NPM服务器供别人使用。

由于新版的nodejs已经集成了npm，所以之前npm也一并安装好了。同样可以通过输入 "npm -v" 来测试是否成功安装。命令如下，出现版本提示表示安装成功:

$ npm -v
2.3.0

全局安装与本地安装(重要)

npm 的包安装分为本地安装（local）、全局安装（global）两种，从敲的命令行来看，差别只是有没有-g而已，比如

npm install express          # 本地安装
npm install express -g   # 全局安装

如果出现以下错误：

npm err! Error: connect ECONNREFUSED 127.0.0.1:8087 

解决办法为：

$ npm config set proxy null

本地安装

• 1. 将安装包放在 ./node_modules 下（运行 npm 命令时所在的目录），如果没有 node_modules 目录，会在当前执行 npm 命令的目录下生成 node_modules 目录。
• 2. 可以通过 require() 来引入本地安装的包。

全局安装

• 1. 将安装包放在 /usr/local 下或者你 node 的安装目录

     运行如下命令

     npm install -g grunt-cli
     

     然后进入/usr/local/bin目录，就会发现grunt-cli已经被放置在下面了

     casperchenMacBookPro:bin casperchen$ pwd
     /usr/local/bin
     casperchenMacBookPro:bin casperchen$ ll grunt
     lrwxr-xr-x  1 root  admin    39B  8 18 21:43 grunt -> ../lib/node_modules/grunt-cli/bin/grunt
     

     可见，全局模块的真实安装路径在/usr/local/lib/node_modules/下，/usr/local/bin下的可执行文件只是软链接而已

• 2. 可以直接在命令行里使用。

如果你希望具备两者功能，则需要在两个地方安装它或使用 npm link。

-----------------------------------------关于全局安装及本地安装的详解及理解--------------------------------------

#个人理解总结：
	敲的命令行来看，差别只是有没有-g而已
    npm install express          	# 本地安装
 		npm install express -g   			# 全局安装
	#***全局安装***
		可以直接在命令行里使用
      例如像koa-generator、express-generator等脚手架工具，用于创建框架项目的那就建议全局安装
      再或者cnpm 命令也是建议用全局安装
	#***本地安装***
		只能应用于当前项目
			安装常用的 Node.js web框架模块 express或者koa那就建议是本地安装，仅用于当前项目
				npm install express
		#本地安装中还涉及到一个安装生产依赖或者开发依赖
        安装到生产依赖 --save			（需要部署到生产环境中的）
              npm install  <package_name>  --save | -S
              安装到当前项目，并将包信息写入到dependencies
        安装到开发依赖 --save-dev		（仅用于本地开发使用：例如nodemon，热启动工具（该工具也可全局安装））
              npm install  <package_name>  --save-dev | -D
              安装到当前项目 并写入到devDependencies
              devDependencies与dependencies 的区别:
              devDependencies 是本地开发时用的依赖项
              dependencies 是生产环境的依赖项


什么是全局安装、什么是本地安装(或叫局部安装，下文统一叫本地安装) ？
为什么要全局安装？为什么又要本地安装？全局安装和本地安装有什么区别？
什么叫开发依赖、生产依赖？什么又是开发环境、生产环境？
全局安装与本地安装
#一、全局安装：
npm install <pageName> -g//（这里-g是-global的简写）
通过上面的命令行（带-g修饰符）安装某个包，就叫全局安装。通常全局包安装在node目录下的node_modules文件夹。可以通过执行下面几条命令查看node、npm的安装目录和全局包的安装目录。

which node   // 查看node的安装目录
which npm   // 查看npm的安装目录
npm root -g // 查看全局包的安装目录
npm list -g --depth 0 //查看全局安装过的包
#二、本地安装:
npm install <pageName> (后面可以加几种修饰符，主要有两种--save-dev和--save)
通过上面的命令行安装某个包，就叫本地安装。包安装在你当前项目文件夹下的node_modules文件夹中。

#三、全局安装的作用:
全局安装的包可提供直接执行的命令(例：gulp -h可以查看gulp定义了什么命令)。 比如gulp全局安装后，可以在命令行上直接执行gulp -v、gulp -h等（原理：全局安装的gulp会将其package.json中的bin命令注入到了全局环境，使得你可以全局执行：gulp xxx命令，这另一个话题了，不深入）。倘若只在本地安装了gulp，未在全局安装gulp，直接执行这些命令会报错。你想要执行相应的命令则可能需要例如：node ./node_modules/gulp/bin/gulp.js -v(查看版本) 这样用一大串命令来执行。因此全局安装就发挥到他的好处了，一个gulp -v就搞定

当然，不是每个包都必须要全局安装的，一般在项目中需要用到该包定义的命令才需要全局安装。比如gulp <taskName>执行gulp任务...等，所以是否需要全局安装取决于我们如何使用这个包。全局安装的就像全局变量有点粗糙，但在某些情况下也是必要的，全局包很重要，但如果不需要，最好避免使用。

#四、可以全局安装，那么直接全局安装到处使用就行了，干嘛还需要本地安装？
如果只是全局安装了而没本地安装，就得require('<pagePath>') 例：引入一个全局的包可能就是requirt('/usr/local/....')通过全局包的路径引入，这样显然十分的不灵活。如果安装了本地包，那么就可以直接require('<pageName>')引入使用。
一个包通常会在不同的项目上会重复用到，如果只全局安装，那么当某个项目需要该包更新版本时，更新后可能就会影响到其他同样引用该包的项目，因此本地安装可以更灵活地在不同的项目使用不同版本的包，并避免全局包污染的问题，
一个经验法则：要用到该包的命令执行任务的就需要全局安装，要通过require引入使用的就需要本地安装（ 但实际开发过程中，我们也不怎么需要考虑某个包是全局安装还是本地安装，因为这一点在该包的官网上一般会明确指出，以上是为了理解全局安装和本地安装）

开发依赖和生产依赖
顺着上面讲到的本地安装，本地安装有两种主要的安装方式：

保存到开发依赖(devDependencies): npm install <pageName> --save-dev
保存到生产依赖(dependencies): npm install <pageName> --save
"开发依赖"顾名思义在开发环境中用到的依赖，"生产依赖"在生产环境中用到的依赖。那么这里又延伸出个问题什么是开发环境、什么是生产环境？

##一、开发环境和生产环境
【开发环境】：指的是你的项目尚且在编码阶段时的环境。你在代码可能还有各种console.log()、注释、格式化等。
【生产环境】：指的是你的项目已经完成编码，并发布上线可供用户浏览的阶段时的环境。代码可能经过了压缩、优化等处理。

这些概念其实并没有一个很明确的定义，接下来我们举例个场景，将"开发环境"、"生产环境"和上面的"开发依赖"、"生产依赖"联系起来就会比较容易理解的了。假如我们在开发过程中使用jQuery。在以往，可能就是把jQuery这个插件下载的本地，再通<script>引入html中。但这有个不方便的地方，我们每次进行一个项目的时候就得手动复制这个jQuery文件到我们的项目中，如果想要换个版本又得官网上下载、随着项目越来越多。用到的插件、库也随之越繁杂...这样会造成自家用的插件管理繁琐的问题。因此就出现了npm(包管理工具)你需要用到什么，直接通过一条命令行就可以将想要的插件下载下来，并直接引入到项目中，目前几乎所有的js插件都能在npm上直接下载。

##二、生产依赖
回到环境和依赖话题，我们下载的jQuery，在开发时参与源码编写，在发布上线的生产环境中也是需要它的。不仅在开发环境编写代码时要依赖它、线上环境也要依赖它，因此将它归类为"生产依赖"，安装时执行npm install jquery --save，它就会被记录在package.json的dependencies。当进行代码打包时，会将这里的jQuery打包入我们的项目代码中。

##三、开发依赖
接着，假如我们用gulp对html进行压缩，我们通常会用到一个插件gulp-htmlmin。我们只希望它把html压缩完就ok了，并不希望它融入我们的项目代码中，即只存在于开发环境，因此把他归类为"开发依赖"。安装时执行npm install gulp-htmlmin --save-dev它就会被记录在package.json的devependencies下，当进行代码打包时，不会将这里的gulp-htmlmin插件源码打包入我们的项目代码中

devDependencies只会在开发环境下使用，生产环境不会被打入包内；而dependencies不仅在开发环境中要使用，生产环境也需要使用到。根据以上规则，我们就很容易区分哪些插件是用--save-dev模式安装，哪些用--save模式安装。

nrm安装与配置(npm的镜像源管理工具)

#1.nrm
nrm(npm registry manager )是npm的镜像源管理工具，有时候国外资源太慢，使用这个就可以快速地在 npm 源间切换
#2.安装nrm
在命令行执行命令，npm install -g nrm，全局安装nrm。
#3.使用
执行命令nrm ls查看可选的源。
nrm ls                                                                                                                                   
*npm ---- https://registry.npmjs.org/
cnpm --- http://r.cnpmjs.org/
taobao - http://registry.npm.taobao.org/
eu ----- http://registry.npmjs.eu/
au ----- http://registry.npmjs.org.au/
sl ----- http://npm.strongloop.com/
nj ----- https://registry.nodejitsu.com/
其中，带*的是当前使用的源，上面的输出表明当前源是官方源。
#4.切换
如果要切换到taobao源，执行命令nrm use taobao。
#5.增加
你可以增加定制的源，特别适用于添加企业内部的私有源，执行命令 nrm add <registry> <url>，其中reigstry为源名，url为源的路径。
nrm add registry http://registry.npm.frp.trmap.cn/
#6.删除
执行命令nrm del <registry>删除对应的源。
#7.测试速度
你还可以通过 nrm test 测试相应源的响应时间。
nrm test npm               

NPM 常用命令详解

常用命令汇总(重要)

#版本查看
  $ npm -v       
  2.3.0
#使用淘宝镜像的命令：
	npm install -g cnpm --registry=https://registry.npm.taobao.org
#初始化nodejs项目，生成 package.json 文件
  npm init -y
    -y 直接生成默认的package.json 文件，不需要自定义设置
#局部安装
      npm install <package_name> 
#全局安装 -g
      npm install -g <package_name> 
      安装到全局并不会体现到package.json 里面
#安装到生产依赖 --save
      npm install  <package_name>  --save | -S
      安装到当前项目，并将包信息写入到dependencies
#安装到开发依赖 --save-dev
      npm install  <package_name>  --save-dev | -D
      安装到当前项目 并写入到devDependencies
      devDependencies与dependencies 的区别:
        devDependencies 是本地开发时用的依赖项
        dependencies 是生产环境的依赖项
## 卸载模块
$ npm uninstall express
#卸载后，你可以到 /node_modules/ 目录下查看包是否还存在，或者使用以下命令查看：
$ npm ls
## 更新模块
$ npm update express
## 搜索模块
$ npm search express

空项目创建及已存在项目的复制应用(重要)

#一个空项目——刚开始创建，无package.json
创建模块
    创建模块，package.json 文件是必不可少的。我们可以使用 NPM 生成 package.json 文件，生成的文件包含了基本的结果。
    $ npm init
    以上的信息，你需要根据你自己的情况输入。在最后输入 "yes" 后会生成 package.json 文件。
    
    如果想直接生成默认的package.json 文件，不需要自定义设置，则可以用如下命令直接生成
    $ npm init -y

#一个已存在的项目——其他地方下载，复制到本地，插件均没有安装
    npm install --production，可以看到，npm只帮我们自动安装package.json中dependencies部分的模块；
    如果执行npm install ，则package.json中指定的dependencies和devDependencies都会被自动安装进来。

框架类的运行与启动(重要)

框架类的运行与启动：
    Demo：
         "scripts":  {
                "test": "echo "Error: no test specified" && exit 1",
                "dev": "cross-env NODE_ENV=dev nodemon ./bin/www.js",
                "prd": "cross-env NODE_ENV=production nodemon ./bin/www.js"
            }
        cross-env：设置环境变量插件
        nodemon：Node自动重启工具   nodemon ***.js  类似于node ***.js启动
    npm run dev
    npm run后面跟script中设置的变量名；执行后面的脚本
    npm run是npm run-script的简写，顾名思义就是执行脚本。执行的脚本配置在package.json中的scripts对象。

使用 npm 命令安装模块(重要)

#npm 安装包命令
    1、局部安装
      npm install <package_name> 
      说明 安装到当前项目
      npm 5x 以后 这个命令等同于npm install --save <package_name> 同时也是会同样写入到依赖 dependencies
    2、 全局安装 -g
      npm install -g <package_name> 
      安装到全局并不会体现到package.json 里面
    3、安装到生产依赖 --save
      npm install  <package_name>  --save | -S
      安装到当前项目，并将包信息写入到dependencies
    4、安装到开发依赖 --save-dev
      npm install  <package_name>  --save-dev | -D
      安装到当前项目 并写入到devDependencies
      devDependencies与dependencies 的区别:
      devDependencies 是本地开发时用的依赖项
			dependencies 是生产环境的依赖项
# --save的理解	
		node --save可以省略掉手动修改package.json的步骤
    当你为你的模块安装一个依赖模块时，正常情况下你得先安装他们（在模块根目录下npm install module-name），然后连同版本号手动将他们添加到模块配置文件package.json中的依赖里（dependencies）。

    -save和save-dev可以省掉你手动修改package.json文件的步骤。
    npm install module-name -save 自动把模块和版本号添加到dependencies部分
    npm install module-name -save-dev 自动把模块和版本号添加到devdependencies部分

    通过这些命令，我们会得到一个新的package.json。然后再做一个试验就懂得了区别：删除node_modules目录，然后执行 npm install --production，可以看到，npm只帮我们自动安装package.json中dependencies部分的模块；如果执行npm install ，则package.json中指定的dependencies和devDependencies都会被自动安装进来。
# npm i和npm install的区别
   最近人用npm i来直接安装模块，但是有会报错，用npm install就不会报错，刚开始百思不得其解，它俩明明是同一个东西
   后来查npm的帮助指令发现还是没区别，npm i仅仅是npm install的简写：
    实际使用的区别点主要如下(windows下)： 
        1. 用npm i安装的模块无法用npm uninstall删除，用npm uninstall i才卸载掉 
        2. npm i会帮助检测与当前node版本最匹配的npm包版本号，并匹配出来相互依赖的npm包应该提升的版本号 
        3. 部分npm包在当前node版本下无法使用，必须使用建议版本 
        4. 安装报错时intall肯定会出现npm-debug.log 文件，npm i不一定

# npm -i 与npm install -s与-d的区别
    npm i module_name  -S   = >  npm install module_name --save    写入到 dependencies 对象
    npm i module_name  -D   = >  npm install module_name --save-dev   写入到 devDependencies 对象
        i 是install 的简写
        -S就是--save的简写
        -D就是--save-dev 
    这样安装的包的名称及版本号就会存在package.json的devDependencies这个里面，而--save会将包的名称及版本号放在dependencies里面。

#那 package.json 文件里面的 devDependencies  和 dependencies 对象有什么区别呢？
        devDependencies  里面的插件只用于开发环境，不用于生产环境，而 dependencies  是需要发布到生产环境的。

#安装依赖包
    npm install 
    会将package.json 里面的devDependencies和dependencies下的所有包都会下载到项目的node_modules文件夹下(没有的改文件夹会新建一个)
    只安装生产依赖
    npm install --production
    
#接下来我们使用全局方式安装 express
    $ npm install express -g
    安装过程输出如下内容，第一行输出了模块的版本号及安装位置。
#查看安装信息
    你可以使用以下命令来查看所有全局安装的模块：
    $ npm list -g
#如果要查看某个模块的版本号，可以使用命令如下：
    $ npm list grunt 
    
#如果你遇到了使用 npm 安 装node_modules 总是提示报错：报错: npm resource busy or locked.....。
    可以先删除以前安装的 node_modules :
    npm cache clean
    npm install

package.json

#使用 package.json
    package.json 位于模块的目录下，用于定义包的属性。
    接下来让我们来看下 express 包的 package.json 文件，位于 node_modules/express/package.json
#Package.json 属性说明
    name - 包名。
    version - 包的版本号。
    description - 包的描述。
    homepage - 包的官网 url 。
    author - 包的作者姓名。
    contributors - 包的其他贡献者姓名。
    dependencies - 依赖包列表。如果依赖包没有安装，npm 会自动将依赖包安装在 node_module 目录下。
    repository - 包代码存放的地方的类型，可以是 git 或 svn，git 可在 Github 上。
    main - main 字段指定了程序的主入口文件，require('moduleName') 就会加载这个文件。这个字段的默认值是模块根目录下面的 index.js。
    keywords - 关键字

卸载模块

我们可以使用以下命令来卸载 Node.js 模块。

$ npm uninstall express

卸载后，你可以到 /node_modules/ 目录下查看包是否还存在，或者使用以下命令查看：

$ npm ls

---

更新模块

我们可以使用以下命令更新模块：

$ npm update express

---

搜索模块

使用以下来搜索模块：

$ npm search express

---

创建模块

创建模块，package.json 文件是必不可少的。我们可以使用 NPM 生成 package.json 文件，生成的文件包含了基本的结果。

$ npm init
This utility will walk you through creating a package.json file.
It only covers the most common items, and tries to guess sensible defaults.

See `npm help json` for definitive documentation on these fields
and exactly what they do.

Use `npm install <pkg> --save` afterwards to install a package and
save it as a dependency in the package.json file.

Press ^C at any time to quit.
name: (node_modules) runoob                   # 模块名
version: (1.0.0) 
description: Node.js 测试模块(www.runoob.com)  # 描述
entry point: (index.js) 
test command: make test
git repository: https://github.com/runoob/runoob.git  # Github 地址
keywords: 
author: 
license: (ISC) 
About to write to ……/node_modules/package.json:      # 生成地址

{
  "name": "runoob",
  "version": "1.0.0",
  "description": "Node.js 测试模块(www.runoob.com)",
  ……
}


Is this ok? (yes) yes

以上的信息，你需要根据你自己的情况输入。在最后输入 "yes" 后会生成 package.json 文件。

---

NPM 资源库中注册用户

接下来我们可以使用以下命令在 npm 资源库中注册用户（使用邮箱注册）：
    $ npm adduser
    Username: mcmohd
    Password:
    Email: (this IS public) mcmohd@gmail.com
接下来我们就用以下命令来发布模块：
    $ npm publish
    如果你以上的步骤都操作正确，你就可以跟其他模块一样使用 npm 来安装。

版本号

使用NPM下载和发布代码时都会接触到版本号。NPM使用语义版本号来管理代码，这里简单介绍一下。

语义版本号分为X.Y.Z三位，分别代表主版本号、次版本号和补丁版本号。当代码变更时，版本号按以下原则更新。

• 如果只是修复bug，需要更新Z位。
• 如果是新增了功能，但是向下兼容，需要更新Y位。
• 如果有大变动，向下不兼容，需要更新X位。

版本号有了这个保证后，在申明第三方包依赖时，除了可依赖于一个固定版本号外，还可依赖于某个范围的版本号。例如"argv": "0.0.x"表示依赖于0.0.x系列的最新版argv。

NPM支持的所有版本号范围指定方式可以查看官方文档。

---

NPM 常用命令

除了本章介绍的部分外，NPM还提供了很多功能，package.json里也有很多其它有用的字段。

除了可以在npmjs.org/doc/查看官方文档外，这里再介绍一些NPM常用命令。

NPM提供了很多命令，例如install和publish，使用npm help可查看所有命令。

• NPM提供了很多命令，例如install和publish，使用npm help可查看所有命令。
• 使用npm help 可查看某条命令的详细帮助，例如npm help install。
• 在package.json所在目录下使用npm install . -g可先在本地安装当前命令行程序，可用于发布前的本地测试。
• 使用npm update 可以把当前目录下node_modules子目录里边的对应模块更新至最新版本。
• 使用npm update -g可以把全局安装的对应命令行程序更新至最新版。
• 使用npm cache clear可以清空NPM本地缓存，用于对付使用相同版本号发布新版本代码的人。
• 使用npm unpublish @可以撤销发布自己发布过的某个版本代码。

---

使用淘宝 NPM 镜像

大家都知道国内直接使用 npm 的官方镜像是非常慢的，这里推荐使用淘宝 NPM 镜像。

淘宝 NPM 镜像是一个完整 npmjs.org 镜像，你可以用此代替官方版本(只读)，同步频率目前为 10分钟 一次以保证尽量与官方服务同步。

你可以使用淘宝定制的 cnpm (gzip 压缩支持) 命令行工具代替默认的 npm:

$ npm install -g cnpm --registry=https://registry.npm.taobao.org

这样就可以使用 cnpm 命令来安装模块了：

$ cnpm install [name]