[web] npm (2)

官方文档

一些常用命令

install
简写
i

--save
简写
-S

--save-dev
简写
-D

--save-optional
简写
-O

--save-exact
简写
-E

uninstall
简写
remove, rm, r, un, unlink

update 
outdated 
cache clean

npm install

安装模块，默认会安装最新的版本

npm install (with no args, in package dir)
npm install [<@scope>/]<name>
npm install [<@scope>/]<name>@<tag>
npm install [<@scope>/]<name>@<version>
npm install [<@scope>/]<name>@<version range>
npm install <tarball file>
npm install <tarball url>
npm install <folder>

alias: npm i
common options: [-S|--save|-D|--save-dev|-O|--save-optional] [-E|--save-exact] [--dry-run]

-S, --save 安装模块信息将加入到dependencies（生产阶段的依赖）
-D, --save-dev 安装模块信息将加入到devDependencies（开发阶段的依赖）
-O, --save-optional 安装模块信息将加入到optionalDependencies（可选阶段的依赖）
-E, --save-exact 精确安装指定模块版本

package版本

major 主要更新
x.0.0

minor 次要更新
0.x.0

patch 补丁
0.0.x

prerelease 预览版
0.0.0-x

1.1.1：精确下载安装1.1.1版本的模块

>、<=、>、>=1.1.1：分别表示下载安装大于、小于等于、大于等于1.1.1版本的模块

1.0.1-1.1.1：表示版本范围是包含1.0.1到1.1.1版本的模块

~1.1.1：表示尽量采用靠近1.1.1版本的模块，但可用的模块版本范围是1.1.1-0到1.1.x-x版本的模块

~1.1：表示下载安装1.1.x-x版本的模块

~1：表示下载安装1.x.x-x版本的模块

^1.1.1：表示模块版本范围是1.1.1到1.x.x-x

^0.1.1：表示模块版本范围是1.1.1到1.1.x-x

^1.1：表示模块版本范围是1.1.x-x到1.x.x-x

^1：表示模块版本范围是1.x.x-x

空格、x、*：表示任意版本即可

两个版本选择器间，空格表示and关系，||表示or关系。

latest : 总是安装最新版本

{ "dependencies" :
  { "foo" : "1.0.0 - 2.9999.9999"
  , "bar" : ">=1.0.2 <2.1.2"
  , "baz" : ">1.0.2 <=2.3.4"
  , "boo" : "2.0.1"
  , "qux" : "<1.0.0 || >=2.3.1 <2.4.5 || >=2.5.2 <3.0.0"
  , "asd" : "http://asdf.com/asdf.tar.gz"
  , "til" : "~1.2"
  , "elf" : "~1.2.3"
  , "two" : "2.x"
  , "thr" : "3.3.x"
  , "lat" : "latest"
  , "dyl" : "file:../dyl"
  }
}

npm uninstall

卸载模块

npm uninstall [<@scope>/]<pkg>[@<version>]... [-S|--save|-D|--save-dev|-O|--save-optional]

aliases: remove, rm, r, un, unlink

npm update

npm update [-g] [<pkg>...]

更新模块，如果不加对应的-S或-D则不会更新package.json文件，需要手动修改。

全部更新可以用这种方式

npm update  -S -D

可以安装 npm-check-updates
执行ncu检查版本状态

npm outdated

检查模块是否已经过时

npm outdated [[<@scope>/]<pkg> ...]

npm ls

查看安装的模块

npm ls [[<@scope>/]<pkg> ...]

aliases: list, la, ll

查看全局安装的模块及依赖

npm ls -g 

npm init

在项目中引导创建一个package.json文件

npm init [-f|--force|-y|--yes]

npm help

查看某条命令的详细帮助

npm help <term> [<terms..>]

例如输入npm help install，系统在默认的浏览器或者默认的编辑器中打开本地nodejs安装模块的文件/nodejs/node_modules/npm/html/doc/cli/npm-install.html

npm root 查看模块的安装路径

输出 node_modules的路径

npm root [-g]

npm roog -g   输出npm全局安装的目录

npm config 管理npm的配置路径

npm config set <key> <value> [-g|--global]
npm config get <key>
npm config delete <key>
npm config list  //查看config的全部配置
npm config edit
npm get <key>
npm set <key> <value> [-g|--global]

对于config这块用得最多应该是设置代理，解决npm安装一些模块失败的问题

设置代理

npm config set proxy=http://dev-proxy.oa.com:8080

设置镜像

npm config set registry="http://r.cnpmjs.org"

安装淘宝镜像

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

使用nrm切换registry

npm cache

管理模块的缓存

npm cache add <tarball file>
npm cache add <folder>
npm cache add <tarball url>
npm cache add <name>@<version>

npm cache ls [<path>]

npm cache clean [<path>]

清除npm本地缓存

npm cache clean

npm version

查看模块版本
也可用作发布package前提升package的版本号

npm version [<newversion> | major | minor | patch | premajor | preminor | prepatch | prerelease | from-git]

'npm [-v | --version]' to print npm version
'npm view <pkg> version' to view a package's published version
'npm ls' to inspect current package/dependency versions

查看npm的版本

npm -v

npm view

查看模块的注册信息

npm view [<@scope>/]<name>[@<version>] [<field>[.<subfield>]...]

aliases: info, show, v

查看模块的依赖关系

npm view gulp dependencies

查看模块的源文件地址

npm view gulp repository.url

查看模块的贡献者，包含邮箱地址

npm view npm contributors

npm adduser

用户登录

npm adduser [--registry=url] [--scope=@orgname] [--always-auth]

npm publish

发布模块
发布模板到npm社区前需要先登录，然后再进入发布的操作

npm publish [<tarball>|<folder>] [--tag <tag>] [--access <public|restricted>]

Publishes '.' if no argument supplied
Sets tag 'latest' if no --tag specified

npm access

在发布的包上设置访问级别

npm access public [<package>]
npm access restricted [<package>]

npm access grant <read-only|read-write> <scope:team> [<package>]
npm access revoke <scope:team> [<package>]

npm access ls-packages [<user>|<scope>|<scope:team>]
npm access ls-collaborators [<package> [<user>]]
npm access edit [<package>]

npm package.json

默认值

npm会根据包内容设置一些默认值。
"scripts": {"start": "node server.js"}
如果包的根目录有server.js文件，npm会默认将start命令设置为node server.js。

"scripts":{"preinstall": "node-waf clean || true; node-waf configure build"}
如果包的根目录有wscript文件，npm会默认将preinstall命令用node-waf进行编译。

"scripts":{"preinstall": "node-gyp rebuild"}
如果包的根目录有binding.gyp文件，npm会默认将preinstall命令用node-gyp进行编译。

"contributors": [...]
如果包的根目录有AUTHORS文件，npm会默认逐行按Name (url)格式处理，邮箱和url是可选的。#号和空格开头的行会被忽略。

name

在package.json中最重要的就是name和version字段。他们都是必须的，如果没有就无法install。name和version一起组成的标识在假设中是唯一的。

name是这个模块的名字。注意：

不要把node或者js放在名字中。因为你写了package.json它就被假定成为了js，不过你可以用"engine"字段指定一个引擎。
这个名字会作为在URL的一部分、命令行的参数或者文件夹的名字。任何non-url-safe的字符都是不能用的。
这个名字可能会作为参数被传入require()，所以它应该比较短，但也要意义清晰。
在你爱上你的名字之前，你可能要去npm registry查看一下这个名字是否已经被使用了。http://registry.npmjs.org/

version

version必须能被node-semver解析，它被包在npm的依赖中。

description

放简介，字符串，方便在npm search中搜索

keywords

关键字，数组、字符串，方便在npm search中搜索

bugs

你项目的提交问题的url和（或）邮件地址

{
 "url" : "http://github.com/owner/project/issues", 
 "email" : "project@hostname.com"
}

license

指定一个让人知道使用的权利和限制的许可证。

最简单的方法是，假如你用一个像 BSD 或者 MIT 这样通用的许可证，就只需要指定一个许可证的名字，像这样：

{ "license" : "MIT" }

如果你又更复杂的许可条件，或者想要提供给更多地细节，可以这样:

"licenses" : [
  { "type" : "MyLicense",
    "url" : "http://github.com/owner/project/path/to/license"
  }
]

repository

指定代码存放的地方。这个对希望贡献的人有帮助。
如果git仓库在github上，那么npm docs命令能找到。

"repository" :
  { "type" : "git",
    "url" : "http://github.com/isaacs/npm.git"
  }

"repository" :
  { "type" : "svn",
    "url" : "http://v8.googlecode.com/svn/trunk/"
  }

URL应该是公开的（即便是只读的）能直接被未经过修改的版本控制程序处理的url。不应该是一个html的项目页面。因为它是给计算机看的。

scripts

“scripts”是一个由脚本命令组成的hash对象，他们在包不同的生命周期中被执行。key是生命周期事件，value是要运行的命令。
参考上面的npm start、npm test命令。

config

"config" hash可以用来配置用于包脚本中的跨版本参数。

{
 "name" : "foo",
 "config" : { "port" : "8080" } 
}

然后有一个“start”命令引用了npm_package_config_port环境变量，用户可以通过npm config set foo:port 8001来重写。

dependencies

依赖是给一组包名指定版本范围的一个hash。这个版本范围是一个由一个或多个空格分隔的字符串。依赖还可以用tarball或者git URL。

不要将测试或过渡性的依赖放在dependencies hash中。

devDependencies

如果有人要使用你的模块，那么他们可能不需要你开发使用的外部测试或者文档框架。

在这种情况下，最好将这些附属的项目列在devDependencies中。

这些东西会在执行npm link或者npm install的时候初始化，并可以像其他npm配置参数一样管理。。

对于非特定平台的构建步骤，比如需要编译CoffeeScript，可以用prepublish脚本去实现，并把它依赖的包放在devDependency中。

{ "name": "ethopia-waza",
  "description": "a delightfully fruity coffee varietal",
  "version": "1.2.3",
  "devDependencies": {
    "coffee-script": "~1.6.3"
  },
  "scripts": {
    "prepublish": "coffee -o lib/ -c src/waza.coffee"
  },
  "main": "lib/waza.js"
}

prepublish脚本会在publishing前运行，这样用户就不用自己去require来编译就能使用。并且在开发模式中（比如本地运行npm install）会运行这个脚本以便更好地测试。

npm scripts 和 bin

scripts指定了运行脚本命令的npm命令行缩写，比如start指定了运行npm run start时，所要执行的命令。

bin项用来指定各个内部命令对应的可执行文件的位置。
简要来说，bin是执行一个可执行文件，scripts是批量执行一些任务。

所有node_modules/.bin/目录下的命令，都可以用npm run [命令]的格式运行。
同时，以node_module形式被安装的模块，bin项都会被安装模块的package.json的scripts捕获。

  "scripts": {
    "build": "tnpm install && npm run clean-dist && ocms build",
    "clean-dist": "npm run remove-dist && mkdir dist",
    "remove-dist": "node_modules/.bin/rimraf ./dist",
    "template": "template" //template为自动被引入scripts
  },  
  "bin": {
    "template": "./bin/generate-template"
  }

如果该模块被装在global，那么bin会被命令行识别
如

  "bin": {
    "vue": "bin/vue",
    "vue-init": "bin/vue-init",
    "vue-list": "bin/vue-list"
  }

npm link

NPM Link：创建快捷链接，供本地模块调试使用（比复制好操作）.

1. 创建开发模块的短连接:
   首先，在模块目录（src/myModule）下运行npm link命令。
   src/myModule$ npm link
   上面的命令会在Npm的全局模块目录内，生成一个符号链接文件，该文件的名字就是package.json文件中指定的文件名。
   /path/to/global/node_modules/myModule -> src/myModule
   这个时候，已经可以全局调用myModule模块了。但是，如果要让这个模块安装在项目内，还要进行下面的步骤。
2. 创建使用中项目的短连接:
   切换到项目目录，再次运行npm link命令，并指定模块名。
   src/myProject$ npm link myModule
   上面命令等同于生成了本地模块的符号链接。
   src/myProject/node_modules/myModule -> /path/to/global/node_modules/myModule
   然后，就可以在项目中，加载该模块了。
3. 删除link:
   如果项目不再需要该模块，可以在项目目录内使用npm unlink命令，删除符号链接。

src/myProject$ npm unlink myModule
src/myModule$ npm unlink

npm link 似乎可以link绝对路径

windows-build-tools

windows有些模块(如sass)安装不了需要
npm install --global --production windows-build-tools
可能会装很久

转载于:https://www.cnblogs.com/qingmingsang/articles/7157364.html