NPM 使用介绍

NPM 使用介绍

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

  • 允许用户从NPM服务器下载别人编写的第三方包到本地使用。
  • 允许用户从NPM服务器下载并安装别人编写的命令行程序到本地使用。
  • 允许用户将自己编写的包或命令行程序上传到NPM服务器供别人使用。
    由于新版的nodejs已经集成了npm,所以之前npm也一并安装好了。同样可以通过输入 “npm -v” 来测试是否成功安装。命令如下,
    出现版本提示表示安装成功:
    1
    2
    npm -v
    //3.10.3

使用 npm 命令安装模块

语法格式:npm install “Module Name”
安装好之后,模块包就放在了工程目录下的 node_modules 目录中,因此在代码中只需要通过 require(‘Module Name’) 的方式
就好,无需指定第三方包路径。

全局安装与本地安装

npm 的包安装分为本地安装(local)、全局安装(global)两种

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

本地安装

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

    全局安装

  3. 将安装包放在 /usr/local 下或者你 node 的安装目录。
  4. 可以直接在命令行里使用。

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

你可以使用以下命令来查看所有全局安装的模块:

1
npm ls -g

使用 package.json

package.json 位于模块的目录下,用于定义包的属性。

Package.json 属性说明

  • name - 包名。
  • version - 包的版本号。
  • description - 包的描述。
  • homepage - 包的官网 url 。
  • author - 包的作者姓名。
  • contributors - 包的其他贡献者姓名。
  • dependencies - 依赖包列表。如果依赖包没有安装,npm 会自动将依赖包安装在 node_module 目录下。
  • repository - 包代码存放的地方的类型,可以是 git 或 svn,git 可在 Github 上。
  • main - main 字段是一个模块ID,它是一个指向你程序的主要项目。就是说,如果你包的名字叫 express,然后用户安装它,然后require(“express”)。
  • keywords - 关键字

卸载模块

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

1
npm uninstall express

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

1
npm ls

更新模块

1
npm update "Module Name"

搜索模块

1
npm search "Module Name"

创建模块

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

1
npm init

版本号

使用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 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分钟 一次以保证尽量与官方服务同步。

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

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

1
cnpm install "name"

http://npm.taobao.org/

文章目录
  1. 1. 使用 npm 命令安装模块
  2. 2. 全局安装与本地安装
    1. 2.1. 本地安装
    2. 2.2. 全局安装
  3. 3. 使用 package.json
    1. 3.1. Package.json 属性说明
  4. 4. 卸载模块
  5. 5. 更新模块
  6. 6. 搜索模块
  7. 7. 创建模块
  8. 8. 版本号
  9. 9. NPM 常用命令
  10. 10. 使用淘宝 NPM 镜像