一、npm
是什么?
在讲npm
是什么之前,我们来讲一下什么是Node
。
Node
是JavaScript
语言的服务器运行环境(一般我都是用浏览器来调试JavaScript
的)
-
Javascript
语言通过Node
在服务器运行 -
Node
提供大量工具库,使得JavaScript
语言与操作系统互动(如读写文件)
好了,现在我们来讲一下什么是npm
npm
是Node
默认的模块管理器,用来安装和管理Node
模块,是一个使用Node.js
编写的包管理工具。(ps:包就是一段实现某个特定功能的JavaScript
代码)
二、npm
的使用
-
npm
的安装
npm
不需要单独安装,在安装Node
的时候,会连带一起安装npm
。
但是,Node
附带的npm
可能不是最新版本,最好用下面的命令,更新到最新版本。不过以下方法会有些问题,具体可以参考下这篇文章windows系统下npm升级的正确姿势以及原理
npm install npm@latest -g
-
npm init
npm init
用来初始化生成一个新的package.json
文件。它会向用户提问一系列问题,如果你觉得不用修改默认配置,一路回车就可以了。
如果使用了-f
(代表force)、-y
(代表yes),则跳过提问阶段,直接生成一个新的package.json
文件。
- 转到对应的目录下,输入
npm init
命令,一路回车
-
npm init -y
会直接生成package.json
文件
-
npm set
npm set
用来设置环境变量
npm set init-author-name 'Your name'
npm set init-author-email 'Your email'
npm set init-author-url 'http://yourdomain.com'
npm set init-license 'ISC'
上面命令等于为npm init
设置了默认值,以后执行npm init
的时候,package.json
的作者姓名、邮件、主页、许可证字段就会自动写入预设的值。这些信息会存放在用户主目录的~/.npmrc
文件,使得用户不用每个项目都输入。
-
npm install -g
和npm install
Node
模块(npm
包)采用npm install
命令来安装
每个模块可以全局安装,也可以本地安装。
-
全局安装(
npm install -g <package name>
) 指的是将一个模块安装到系统目录中,各个项目都可以调用。一般来说,全局安装只适用于工具模块,比如eslint
和gulp
。 -
本地安装(
npm install <package name>
) 指的是将一个模块下载到当前项目的node_modules
子目录,然后只有在项目目录之中,才能调用这个模块 - 下面的命令执行之后将会在当前的目录下创建一个
node_modules
的目录(如果不存在的话),然后将下载的包保存到这个目录下
// 本地安装
npm install <package name>
// 全局安装
npm install -global <package name>
npm install -g <package name>
- 例如安装一个
http-server
和一个lodash
的包
npm install -g http-server
npm install lodash
-
npm install --save
和npm install --save-dev
install
命令可以使用不同参数,指定所安装的模块属于哪一种性质的依赖关系,即出现在packages.json
文件的哪一项中
即:把一个模块安装到node-modules
下,且将文件写入到packges.json
文件中的对应项中
-
--save
:模块名将被添加到dependencies
,可以简化为参数-S
。 -
--save-dev
: 模块名将被添加到devDependencies
,可以简化为参数-D
。
添加依赖进入 package.json
文件的 dependencies
:
npm install <package_name> --save
# 或者
npm install <package_name> -S
添加依赖进入 package.json
文件的devDependencies
:
npm install <package_name> --save-dev
# 或者
npm install <package_name> -D
-
npm uninstall
x卸载包
npm uninstall
命令,卸载已安装的模块。
npm uninstall <package_name>
# 卸载全局模块
npm uninstall <package_name> -global
-
npm run xxx
npm
不仅可以用于模块管理,还可以用于执行脚本。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-script lint
或者npm run lint
,就会执行jshint **.js
,输入npm run-script test
或者npm run test
,就会执行mocha test/
。npm run
是npm run-script
的缩写,一般都使用前者,但是后者可以更好地反应这个命令的本质。
npm run
命令会自动在环境变量$PATH
添加node_modules/.bin
目录,所以scripts
字段里面调用命令时不用加上路径,这就避免了全局安装NPM
模块。
npm run
如果不加任何参数,直接运行,会列出package.json
里面所有可以执行的脚本命令。
npm
内置了两个命令简写,npm test
等同于执行npm run test
,npm start
等同于执行npm run start
。
npm run
会创建一个Shell
,执行指定的命令,并临时将node_modules/.bin
加入PATH
变量,这意味着本地模块可以直接运行。
三、package.json
每个项目的根目录下面,一般都有一个package.json
文件,定义了这个项目所需要的各种模块,以及项目的配置信息(比如名称、版本、许可证等元数据)。npm install
命令根据这个配置文件,自动下载所需的模块,即配置项目所需的运行和开发环境。
package.json
文件可以手工编写,也可以使用npm init
命令自动生成。
下面是一个package.json
文件
{
"name": "Hello World",
"version": "1.0.0",
"author": "",
"description": "第一个node.js程序",
"keywords":[],
"repository": {
"type": "git",
"url": "https://path/to/url"
},
"license":"ISC",
"bugs":{"url":"http://path/to/bug","email":"bug@example.com"},
"scripts": {
"start": "node index.js"
},
"dependencies": {
"express": "latest",
"mongoose": "~3.8.3",
"handlebars-runtime": "~1.0.12"
},
"devDependencies": {
"bower": "~1.2.8",
"grunt": "~0.4.1",
"grunt-contrib-concat": "~0.3.0",
"grunt-contrib-jshint": "~0.7.2",
"grunt-contrib-uglify": "~0.2.7",
"grunt-contrib-clean": "~0.5.0",
"browserify": "2.36.1",
"grunt-browserify": "~1.3.0",
}
}
简单介绍默认信息:
-
name
: 当前目录名称 -
version
: 总会是 1.0.0 -
description
: 来自readme
文件,没有就是空字符串""
-
main
: 总会是index.js
-
scripts
: 默认情况下会创建一个空的测试脚本 -
keywords
: 为空 -
author
: 为空 -
license
:ISC
-
bugs
: 来自当前目录的信息(如果存在) -
homepage
: 来自当前目录的信息(如果存在)
-
scripts
字段
scripts
指定了运行脚本命令的npm
命令行缩写,比如start
指定了运行npm run start
时,所要执行的命令。 -
dependencies
字段,devDependencies
字段
它们都指向一个对象。该对象的各个成员,分别由模块名和对应的版本要求组成,表示依赖的模块及其版本范围。-
dependencies
字段指定了项目运行所依赖的模块,这个对象里面的内容就是我们这个项目所依赖的js
模块包 -
devDependencies
指定项目开发所需要的模块,在我们开发的时候会用到的一些包,只是在开发环境中需要用到,但是在别人引用我们包的时候,不会用到这些内容,放在devDependencies
的包
-
当拥有了一个完整的 package.json
文件的时候,就可以让人一眼看出来,这个模块的基本信息,和这个模块所需要依赖的包。我们可以通过 npm install
就可以很方便的下载好这个模块所需要的包。
npm install
默认会安装dependencies
字段和 devDependencies
字段中的所有模块,如果使用--production
参数,可以只安装 dependencies
字段的模块。
npm install --production
-
main
字段
main
字段指定了加载的入口文件,require('moduleName')
就会加载这个文件。这个字段的默认值是模块根目录下面的index.js
。
四、流程捋一遍
-
从
Node.js
官网下载并安装Node
,安装Node
的同时npm
也会一并安装,可使用npm -v
查看npm
是否成功安装,若出现对应版本号,则安装成功
创建一个文件夹,如
npmdemo
-
打开终端,
cd
到npmdemo
文件夹下,使用npm init -y
来创建一个默认的package.json
文件
-
本地安装一个依赖(包),如
axios
,使用npm install axios
会把axios
模块安装到node-modules
(若没有node-modules,会自动生成
,(插一句node-modules
目录下的.bin
目录保存着Node
模块的可执行脚本))下,且将文件写入到packges.json
文件中的dependencies
对象中
至此,我们就完成了一个包的安装,要使用他,就可在对应文件中
require
即可
// index.js
const axios = require('axios');
- 更新包,
cd
到项目的根目录中,运行update
命令
//更新所有的包
npm update
// 更新单独的包
npm update axios
参考资料
http://javascript.ruanyifeng.com/nodejs/npm.html
https://www.jianshu.com/p/dca65f9493ad