codecamp

Node.js npm模块管理器

简介

npm有两层含义。一层含义是Node.js的开放式模块登记和管理系统,网址为http://npmjs.org。另一层含义是Node.js默认的模块管理器,是一个命令行下的软件,用来安装和管理node模块。

npm不需要单独安装。在安装node的时候,会连带一起安装npm。但是,node附带的npm可能不是最新版本,最好用下面的命令,更新到最新版本。

$ npm install npm@latest -g

上面的命令之所以最后一个参数是npm,是因为npm本身也是Node.js的一个模块。

node安装完成后,可以用下面的命令,查看一下npm的帮助文件。

# npm命令列表
$ npm help

# 各个命令的简单用法
$ npm -l

下面的命令分别查看npm的版本和配置。

$ npm -v
$ npm config list -l

npm info

npm info命令可以查看每个模块的具体信息。比如,查看underscore模块信息的命令是:

$ npm info underscore
{ name: 'underscore',
  description: 'JavaScript\'s functional programming helper library.',
  'dist-tags': { latest: '1.5.2', stable: '1.5.2' },
  repository:
   { type: 'git',
     url: 'git://github.com/jashkenas/underscore.git' },
  homepage: 'http://underscorejs.org',
  main: 'underscore.js',
  version: '1.5.2',
  devDependencies: { phantomjs: '1.9.0-1' },
  licenses:
   { type: 'MIT',
     url: 'https://raw.github.com/jashkenas/underscore/master/LICENSE' },
  files:
   [ 'underscore.js',
     'underscore-min.js',
     'LICENSE' ],
  readmeFilename: 'README.md'}

上面命令返回一个JavaScript对象,包含了underscore模块的详细信息。这个对象的每个成员,都可以直接从info命令查询。

$ npm info underscore description
JavaScript's functional programming helper library.

$ npm info underscore homepage
http://underscorejs.org

$ npm info underscore version
1.5.2

npm search

向npm仓库搜索某个模块,使用search命令(可使用正则搜索)。

$ npm search <搜索词>

如果不加搜索词,npm search默认返回npm仓库的所有模块。

npm list

npm list命令列出当前目录安装的所有模块。如果使用global参数,就是列出全局安装的模块。

$ npm list
$ npm -global list

npm install

Node模块采用npm install命令安装。每个模块可以“全局安装”,也可以“本地安装”。两者的差异是模块的安装位置,以及调用方法。

“全局安装”指的是将一个模块直接下载到Node的安装目录中,各个项目都可以调用。“本地安装”指的是将一个模块下载到当前目录的node_modules子目录,然后只有在当前目录和它的子目录之中,才能调用这个模块。一般来说,全局安装只适用于工具模块,比如npm和grunt。

默认情况下,npm install命令是“本地安装”某个模块。

$ npm install <package name>

npm也支持直接输入github地址。

$ npm install git://github.com/package/path.git
$ npm install git://github.com/package/path.git#0.1.0

运行上面命令后,模块文件将下载到当前目录的node_modules子目录。

使用global参数,可以“全局安装”某个模块。global参数可以被简化成g参数。

$ sudo npm install -global [package name]
$ sudo npm install -g [package name]

install命令总是安装模块的最新版本,如果要安装模块的特定版本,可以在模块名后面加上@和版本号。

$ npm install sax@latest
$ npm install sax@0.1.1
$ npm install sax@">=0.1.0 <0.2.0"

install命令可以使用不同参数,指定所安装的模块属于哪一种性质的依赖关系,即出现在packages.json文件的哪一项中。

  • --save:模块名将被添加到dependencies,可以简化为参数-S
  • --save-dev: 模块名将被添加到devDependencies,可以简化为参数-D
$ npm install sax --save
$ npm install node-tap --save-dev
# 或者
$ npm install sax -S
$ npm install node-tap -D

npm install默认会安装dependencies字段和devDependencies字段中的所有模块,如果使用production参数,可以只安装dependencies字段的模块。

$ npm install --production
# 或者
$ NODE_ENV=production npm install

一旦安装了某个模块,就可以在代码中用require命令调用这个模块。

var backbone = require('backbone')

console.log(backbone.VERSION)

语义版本(SemVer)

npm采用”语义版本“管理软件包。所谓语义版本,就是指版本号为a.b.c的形式,其中a是大版本号,b是小版本号,c是补丁号。

一个软件发布的时候,默认就是 1.0.0 版。如果以后发布补丁,就增加最后一位数字,比如1.0.1;如果增加新功能,且不影响原有的功能,就增加中间的数字(即小版本号),比如1.1.0;如果引入的变化,破坏了向后兼容性,就增加第一位数字(即大版本号),比如2.0.0。

npm允许使用特殊符号,指定所要使用的版本范围,假定当前版本是1.0.4。

  • 只接受补丁包:1.0 或者 1.0.x 或者 ~1.0.4
  • 只接受小版本和补丁包:1 或者 1.x 或者 ^1.0.4
  • 接受所有更新:* or x

对于~和^,要注意区分。前者表示接受当前小版本(如果省略小版本号,则是当前大版本)的最新补丁包,后者表示接受当前大版本的最新小版本和最新补丁包。

~2.2.1 // 接受2.2.1,不接受2.3.0
^2.2.1 // 接受2.2.1和2.3.0

~2.2 // 接受2.2.0和2.2.1,不接受2.3.0
^2.2 // 接受2.2.0、2.2.1和2.3.0

~2 // 接受2.0.0、2.1.0、2.2.0、2.2.1和2.3.0
^2 // 接受2.0.0、2.1.0、2.2.0、2.2.1和2.3.0

还可以使用数学运算符(比如>, = or <=等),指定版本范围。

>2.1
1.0.0 - 1.2.0
>1.0.0-alpha
>=1.0.0-rc.0 <1.0.1
^2 <2.2 || > 2.3

注意,如果使用连字号,它的两端必须有空格。如果不带空格,会被npm理解成预发布的tag,比如1.0.0-rc.1。

npm update,npm uninstall

npm update 命令可以升级本地安装的模块。

npm update [package name]

加上global参数,可以升级全局安装的模块。

npm update -global [package name]

npm uninstall 命令,删除本地安装的模块。

npm uninstall [package name]

加上global参数,可以删除全局安装的模块。

sudo npm uninstall [package name] -global

npm shrinkwrap

对于一个项目来说,通常不会写死依赖的npm模块的版本。比如,开发时使用某个模块的版本是1.0,那么等到用户安装时,如果该模块升级到1.1,往往就会安装1.1。

但是,对于开发者来说,有时最好锁定所有依赖的版本,防止模块升级带来意想不到的问题。但是,由于模块自己还依赖别的模块,这一点往往很难做到。举例来说,项目依赖A模块,A模块依赖B模块。即使写死A模块的版本,但是B模块升级依然可能导致不兼容。

npm shrinkwrap命令就是用来彻底锁定所有模块的版本。

$ npm shrinkwrap

运行上面这个命令以后,会在项目目录下生成一个npm-shrinkwrap.json文件,里面包含当前项目用到的所有依赖(包括依赖的依赖,以此类推),以及它们的准确版本,也就是当前正在使用的版本。

只要存在npm-shrinkwrap.json文件,下一次用户使用npm install命令安装依赖的时候,就会安装所有版本完全相同的模块。

如果执行npm shrinkwrap的时候,加上参数dev,还可以记录devDependencies字段中模块的准确版本。

$ npm shrinkwrap --dev

npm prune

npm prune命令与npm shrinkwrap配套使用。

使用npm shrinkwrap的时候,有时可能存在某个已经安装的模块不在dependencies字段内的情况,这时npm shrinkwrap 就会报错。

npm prune命令可以移除所有不在dependencies字段内的模块。所有指定模块名,则移除单个模块。

$ npm prune
$ npm package <package name>

npm run

package.json文件有一项scripts,用于指定脚本命令,供npm直接调用。

{
  "name": "myproject",
  "devDependencies": {
    "jshint": "latest",
    "browserify": "latest",
    "mocha": "latest"
  },
  "scripts": {
    "lint": "jshint **.js",
    "test": "mocha test/"
  }
}

上面代码中,scripts指定了两项命令lint和test。命令行输入npm run lint,就会执行jshint **.js,输入npm run test,就会执行mocha test/。npm内置了两个命令简写,npm test等同于执行npm run lintnpm start等同于执行npm run start

npm run会创建一个shell,执行指定的命令,并将node_modules/.bin加入PATH变量,这意味着本地模块可以直接运行。也就是说,npm run lint直接运行jshint **.js即可,而不用./node_modules/.bin/jshint **.js

如果直接运行npm run不给出任何参数,就会列出scripts属性下所有命令。

Available scripts in the user-service package:
  lint
     jshint **.js
  test
    mocha test/

下面是另一个package.json文件的例子。

"scripts": {
  "watch": "watchify client/main.js -o public/app.js -v",
  "build": "browserify client/main.js -o public/app.js",
  "start": "npm run watch & nodemon server.js",
  "test": "node test/all.js"
},

上面代码在scripts项,定义了四个别名,每个别名都有对应的脚本命令。

npm run watch
npm run build
npm run start
npm run test

其中,start和test属于特殊命令,可以省略run。

npm start
npm test

如果希望一个操作的输出,是另一个操作的输入,可以借用Linux系统的管道命令,将两个操作连在一起。

"build-js": "browserify browser/main.js | uglifyjs -mc > static/bundle.js"

但是,更方便的写法是引用其他npm run命令。

"build": "npm run build-js && npm run build-css"

上面的写法是先运行npm run build-js,然后再运行npm run build-css,两个命令中间用&&连接。如果希望两个命令同时平行执行,它们中间可以用&连接。

下面是一个流操作的例子。

"devDependencies": {
  "autoprefixer": "latest",
  "cssmin": "latest"
},

"scripts": {
  "build:css": "autoprefixer -b 'last 2 versions' < assets/styles/main.css | cssmin > dist/main.css"
}

写在scripts属性中的命令,也可以在node_modules/.bin目录中直接写成bash脚本。

#!/bin/bash

cd site/main;
browserify browser/main.js | uglifyjs -mc > static/bundle.js

假定上面的脚本文件名为build.sh,并且权限为可执行,就可以在scripts属性中引用该文件。

"build-js": "bin/build.sh"

npm run为每条命令提供了pre和post两个钩子(hook)。以npm run lint为例,执行这条命令之前,npm会先查看有没有定义prelint和postlint两个钩子,如果有的话,就会先执行npm run prelint,然后执行npm run lint,最后执行npm run postlint。所有命令都是这样,包括npm test(即实际存在npm run pretestnpm run testnpm run posttest三条命令)。如果执行过程出错,就不会执行排在后面的命令,即如果pretest命令执行出错,就不会接着执行 test和posttest命令。不能在pre命令之前再加pre,即prepretest命令不起作用。另外,还可以为一些内部命令指定pre和post的钩子:install、uninstall、publish、update。

"scripts": {
  "lint": "jshint **.js",
  "build": "browserify index.js > myproject.min.js",
  "test": "mocha test/",

  "prepublish": "npm run build # also runs npm run prebuild",
  "prebuild": "npm run test # also runs npm run pretest",
  "pretest": "npm run lint"
}

npm run命令还可以添加参数。

"scripts": {
  "test": "mocha test/"
}

上面代码指定npm test,实际运行mocha test/。可以在npm test命令后面加上参数,比如npm run test -- anothertest.js,实际运行的是mocha test/ anothertest.js

npm link

一般来说,每个项目都会在项目目录内,安装所需的模块文件。也就是说,各个模块是局部安装。但是有时候,我们希望模块是一个符号链接,连到外部文件,这时候就需要用到npm link命令。

为了理解npm link,请设想这样一个场景。你开发了一个模块myModule,目录为src/myModule,你自己的项目myProject要用到这个模块,项目目录为src/myProject。每一次,你更新myModule,就要用npm publish命令发布,然后切换到项目目录,使用npm update更新模块。这样显然很不方便,如果我们可以从项目目录建立一个符号链接,直接连到模块目录,就省去了中间步骤,项目可以直接使用最新版的模块。

先在模块目录(src/myModule)下运行npm link命令。

src/myModule$ npm link

上面的命令会在npm的全局模块目录内(比如/usr/local/lib/node_modules/),生成一个符号链接文件,该文件的名字就是package.json文件中指定的文件名。

/usr/local/lib/node_modules/myModule -> src/myModule

然后,切换到你需要放置该模块的项目目录,再次运行npm link命令,并指定模块名。

src/myProject$ npm link myModule

上面命令等同于生成了本地模块的符号链接。

src/myProject/node_modules/myModule -> /usr/local/lib/node_modules/myModule

然后,就可以在你的项目中,加载该模块了。

var myModule = require('myModule');

这样一来,myModule的任何变化,都可以直接在myProject中调用。但是,同时也出现了风险,任何在myProject目录中对myModule的修改,都会反映到模块的源码中。

npm link命令有一个简写形式,显示连接模块的本地目录。

$ src/myProject$ npm link ../myModule

上面的命令等同于下面几条命令。

$ src/myProject$ cd ../myModule
$ src/myModule$ npm link
$ src/myModule$ cd ../myProject
$ src/myProject$ npm link myModule

如果你的项目不再需要该模块,可以在项目目录内使用npm unlink命令,删除符号链接。

src/myProject$ npm unlink myModule

一般来说,npm公共模块都安装在系统目录(比如/usr/local/lib/),普通用户没有写入权限,需要用到sudo命令。这不是很方便,我们可以在没有root的情况下,用好npm。

首先在主目录下新建配置文件.npmrc,然后在该文件中将prefix变量定义到主目录下面。

prefix = /home/yourUsername/npm

然后在主目录下新建npm子目录。

$ mkdir ~/npm

此后,全局安装的模块都会安装在这个子目录中,npm也会到~/npm/bin目录去寻找命令。因此,npm link就不再需要 root权限了。

最后,将这个路径在.bash_profile文件(或.bashrc文件)中加入PATH变量。

export PATH=~/npm/bin:$PATH

npm publish

在发布你的模块之前,需要先设定个人信息。

$ npm set init.author.name “张三”
$ npm set init.author.email “zhangsan@email.com”
$ npm set init.author.url “http://your.url.com"

这些信息会存放在用户主目录的~/.npmrc文件,使得用户不用每个项目都输入。如果遇到某个模块的作者信息,与全局设置不同,可以在项目目录中,单独设置一次上面这些命令。

然后,向npm系统申请用户名。

$ npm adduser

运行上面的命令之后,屏幕上会提示输入用户名,然后是输入Email地址和密码。

如果已经注册过,就使用下面的命令登录。

$ npm login

最后,使用npm publish命令发布。

$ npm publish

npm version

npm version命令用来修改项目的版本号。当你完成代码修改,要发布新版本的时候,就用这个命令更新一下软件的版本。

$ npm version <update_type> -m "<message>"

npm version命令的update_type参数有三个选项:patch、minor、major。

  • npm version patch增加一位补丁号(比如 1.1.1 -> 1.1.2)
  • npm version minor增加一位小版本号(比如 1.1.1 -> 1.2.0)
  • npm version major增加一位大版本号(比如 1.1.1 -> 2.0.0)。

下面是一个例子。

$ npm version patch -m "Version %s - xxxxxx"

上面命令的%s表示新的版本号。

除了增加版本号,npm version命令还会为这次修改,新增一个git commit记录,以及一个新的git tag。

由于更新npm网站的唯一方法,就是发布一个新的版本。因此,除了第一次发布,这个命令与npm publish几乎是配套的,先使用它,再使用npm publish

参考链接

Node.js package.json文件
Node.js fs 模块
温馨提示
下载编程狮App,免费阅读超1000+编程语言教程
取消
确定
目录

关闭

MIP.setData({ 'pageTheme' : getCookie('pageTheme') || {'day':true, 'night':false}, 'pageFontSize' : getCookie('pageFontSize') || 20 }); MIP.watch('pageTheme', function(newValue){ setCookie('pageTheme', JSON.stringify(newValue)) }); MIP.watch('pageFontSize', function(newValue){ setCookie('pageFontSize', newValue) }); function setCookie(name, value){ var days = 1; var exp = new Date(); exp.setTime(exp.getTime() + days*24*60*60*1000); document.cookie = name + '=' + value + ';expires=' + exp.toUTCString(); } function getCookie(name){ var reg = new RegExp('(^| )' + name + '=([^;]*)(;|$)'); return document.cookie.match(reg) ? JSON.parse(document.cookie.match(reg)[2]) : null; }