npm命令大全_整理NPM常用命令

时间: 2018-04-08阅读: 190标签: npm

npm是什么

NPM的全称是Node Package Manager,是随同NodeJS一起安装的包管理和分发工具,它很方便让JavaScript开发者下载、安装、上传以及管理已经安装的包。


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]

安装包,默认会安装最新的版本

npm install webpack
npm install webpack@1.4.0 //安装指定版本

安装包并将信息保持到项目的package.json文件中 
项目对模块的依赖可以使用下面的 3 种方法来表示(假设当前版本号是 1.1.0 ):

  • 兼容模块新发布的补丁版本:~1.1.0、1.1.x、1.1
  • 兼容模块新发布的小版本、补丁版本:^1.1.0、1.x、1
  • 兼容模块新发布的大版本、小版本、补丁版本:*、x

-S, –save 安装包信息将加入到dependencies(生产阶段的依赖)

"dependencies": {
    "webpack": "^1.14.0",
    "webpack-dev-server": "^1.16.2"
}

-D, –save-dev 安装包信息将加入到devDependencies(开发阶段的依赖),所以开发阶段一般使用它

npm install gulp --save-dev 或 npm install gulp -D
//package.json 文件的 devDependencies字段:

"devDependencies": {
    "html-webpack-plugin": "^2.26.0"
}

-O, –save-optional 安装包信息将加入到optionalDependencies(可选阶段的依赖)

npm install gulp --save-optional 或 npm install gulp -O
package.json 文件的optionalDependencies字段:

"optionalDependencies": {
    "gulp": "^3.9.1"
}

-E, –save-exact 精确安装指定模块版本

npm install gulp --save-exact 或 npm install gulp -E
输入命令npm install gulp -ES,留意package.json 文件的 dependencies 字段,以看出版本号中的^消失了

"dependencies": {
    "gulp": "3.9.1"
}

模块的依赖都被写入了package.json文件后,他人打开项目的根目录(项目开源、内部团队合作),使用npm install命令可以根据dependencies配置安装所有的依赖包

npm install

本地安装和全局安装

npm install webpack
npm install webpack -g //使用-g或--global


npm uninstall 卸载模块

基础语法

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

aliases: remove, rm, r, un, unlink

卸载开发版本的模块

npm uninstall webpack --save-dev


npm update 更新模块

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


npm outdated 检查模块是否已经过时

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

此命令会列出所有已过时的包,可以及时更新


npm ls 查看安装的模块

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

aliases: list, la, ll


//查看全局安装的模块及依赖 
npm ls -g 


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

安装包的信息可保持到项目的package.json文件中,以便后续的其它的项目开发或者他人合作使用,也说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 help install


npm root 查看包的安装路径

输出 node_modules的路径

npm root [-g]


npm config 管理npm的配置路径

npm config set <key> <value> [-g|--global]
npm config get <key>
npm config delete <key>
npm config list
npm config edit
npm get <key>
npm set <key> <value> [-g|--global]

对于config这块用得最多应该是设置代理,解决npm安装一些模块失败的问题 
例如我在公司内网,因为公司的防火墙原因,无法完成任何模块的安装,这个时候设置代理可以解决

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

又如国内的网络环境问题,某官方的IP可能被和谐了,幸好国内有好心人,搭建了镜像,此时我们简单设置镜像

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

也可以临时配置,如安装淘宝镜像

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


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 run-script执行脚本

npm run-script <command> [-- <args>...]

alias: npm run

如果直接运行npm run,将列出所有可用的脚本

npm run


npm start 启动模块

npm start [-- <args>]

该命令写在package.json文件scripts的start字段中,可以自定义命令来配置一个服务器环境和安装一系列的必要程序,如

"scripts": {
    "start": "gulp -ws"
}

此时在cmd中输入npm start命令相当于执行gulpfile.js文件自定义的watch和server命令。 
如果package.json文件没有设置start,则将直接启动node server.js


npm stop 停止模块

npm stop [-- <args>]


npm restart 重新启动模块

npm restart [-- <args>]


npm test 测试模块

npm test [-- <args>]

该命令写在package.json文件scripts的test字段中,可以自定义该命令来执行一些操作,如

"scripts": {
    "test": "gulp release"
},

此时在cmd中输入npm test命令相当于执行gulpfile.js文件自定义的release命令。


npm version 查看模块版本

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 version


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 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的语法

英文原版:https://docs.npmjs.com/files/package.json

这块内容好多,国内有好心人整理:《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一起组成的标识在假设中是唯一的。改变包应该同时改变version。

name是这个东西的名字。注意:

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

scripts

“scripts”是一个由脚本命令组成的hash对象,他们在包不同的生命周期中被执行。key是生命周期事件,value是要运行的命令。

参见 npm-scripts(7)


npm和bower的关系和区别

npm和bower太像了,就像一对孪生兄弟…… npm的文件是package.json,包安装的目录是node_modules。 bower的文件是bower.json,包安装的目录是bower_components。使用命令也基本一致

npm 执行多个命令_如何用npm同时执行多条监听命令

直接通过&&连接多条命令,在npm run start的时候,发现只停留在第一个命令执行监听,后面的命令都没有执行。只能通过打开多个窗口分别执行多条命令,那么有没有办法实现一条npm命令执行多条监听呢?

使用webpack开发npm插件

webpack:解析js文件,无法解析的文件需要借助loader,npm插件发布(vue&webpack&单页面):npm init =>package.json,创建.vue文件 =>插件界面及功能,index.js =>入口文件

yarn和npm的区别对比_比较npm和yarn 命令行

npm 是目前js最流行的包管理工具,通过 npm 可以安装、共享、分发代码,管理项目依赖关系。Yarn 是为了弥补 npm 的一些缺陷而出现的,Yarn 定位为快速、可靠、安全的依赖管理工具。

Yarn vs npm: 你需要知道的一切

Yarn 是 Facebook, Google, Exponent 和 Tilde 开发的一款新的 JavaScript 包管理工具。它的目的是解决这些团队使用 npm 面临的少数问题,即:安装的时候无法保证速度/一致性,安全问题,因为 npm 安装时允许运行代码

在5分钟内搭建企业内部私有npm仓库

下面通过三种方法来搭建公司私有npm仓库,每种方式都有自己的优势。启动并配置服务、设置注册地址、登录cnpm、包上传到私有仓库、查看预览包、通过verdaccio搭建....