NPM使用使用说明

npm使用说明

npm是随着nodeJs一同安装的包管理工具,能解决node.js代码部署的很多问题,常见的使用场景具有以下几种:

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


使用npm命令安装模块

 npm install <Module Name>

使用npm安装常用框架express

npm install express

 在安装成功之后,包放在的目录 node_modules 目录中 。 用户需要这个框架的时候则可以使用require来引入require('express') 则可以,不需要指定包的路径。

express = require('express');



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

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

如果出现以下错误

npm err! Error: connect ECONNREFUSED 127.0.0.1:8087

解决办法为:

$ npm config set proxy null

查看安装信息

npm list -g

查看某个模块的版本号
npm list grunt


使用package.json
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:关键字

卸载模块
卸载命令

npm uninstall express

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

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 adduser
Username: mcmohd
Password:
Email: (this IS public) mcmohd@gmail.com

接下来我们就用以下命令来发布模块:

 npm publish

版本号

使用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提供了很多命令,例如installpublish,使用npm help可查看所有命令。

  • 使用npm help <command>可查看某条命令的详细帮助,例如npm help install

  • package.json所在目录下使用npm install . -g可先在本地安装当前命令行程序,可用于发布前的本地测试。

  • 使用npm update <package>可以把当前目录下node_modules子目录里边的对应模块更新至最新版本。

  • 使用npm update <package> -g可以把全局安装的对应命令行程序更新至最新版。

  • 使用npm cache clear可以清空NPM本地缓存,用于对付使用相同版本号发布新版本代码的人。

  • 使用npm unpublish <package>@<version>可以撤销发布自己发布过的某个版本代码。


使用淘宝 NPM 镜像

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

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

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

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

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

$ cnpm install [name]