NPM使用说明记录

0. 扫盲

NPM是随同NodeJS一起安装的包管理工具,能解决NodeJS代码部署上的很多问题,常见的使用场景有以下:

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

-> Mac安装姿势:https://zhuanlan.zhihu.com/p/90508170
-> 参考教程:https://www.runoob.com/nodejs/nodejs-npm.html


1. 安装 【npm】

—> 1. 确认是否安装

由于新版的nodejs已经集成了npm,所以之前npm也一并安装好了。同样可以通过输入 "npm -v" 来测试是否成功安装。命令如下,出现版本提示表示安装成功:

# 查询版本号
$ npm -v
7.5.0

—> 2. 安装npm,使用淘宝镜像的命令来升级

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

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

如果是Window系统使用以下命令即可:

$ npm install npm -g

—> 3. 使用cnpm命令安装模块

用 cnpm 命令安装Node.js模块语法格式如下:

$ cnpm install【Module Name】
# 我们使用 npm 命令安装常用的 Node.js web框架模块 express:
$ npm install express

也可以不跟模块就会下载package.json文件里dependencies里面的所有模块

$ cnpm install

安装完成后这个时候项目目录下会增加node_modules这个文件夹。

—> 4. 启动服务

运行npm run start命令即可启动两个服务。

$ npm run start

启动本地项目

node app.js

—> 5. 全局安装与本地安装

npm 的包安装分为本地安装(local)、全局安装(global)两种,从敲的命令行来看,差别只是有没有-g而已

npm install express      # 本地安装

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

1. 将安装包放在 ./node_modules 下(运行 npm 命令时所在的目录),如果没有 node_modules 目录,会在当前执行 npm 命令的目录下生成 node_modules 目录。
2. 可以通过 require() 来引入本地安装的包。

5.2 全局安装

1. 将安装包放在 /usr/local 下或者你 node 的安装目录。
2. 可以直接在命令行里使用。

5.3 查看安装信息

你可以使用npm list -g命令来查看所有全局安装的模块:

$ npm list -g
/usr/local/lib
├── [email protected]
└── [email protected]

如果要查看某个模块的版本号,可以使用npm list【Module Name】命令:

$ npm list【Module Name】

—> 6. 卸载模块

$ npm uninstall【Module Name】

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

$ npm ls

—> 7. 更新模块

$ npm update【Module Name】

—> 8. 搜索模块

$ npm search【Module Name】

—> 9. 创建模块

创建模块,package.json 文件是必不可少的。我们可以使用 NPM 生成 package.json 文件,生成的文件包含了基本的结果。

$ npm init

在最后输入 "yes" 后会生成 package.json 文件。接着在 npm 资源库中注册用户(使用邮箱注册):

$ npm adduser

接下来就发布模块:

$ npm publish

2. 使用package.json

—> 1. Package.json简介

package.json 位于模块的目录下,用于定义包的属性。接下来让我们来看下 express 包的 package.json 文件,位于 node_modules/express/package.json

—> 2. 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 - 关键字

3. 版本号

—> 1. Package.json简介

使用NPM下载和发布代码时都会接触到版本号。NPM使用语义版本号来管理代码,这里简单介绍一下。

语义版本号分为X.Y.Z三位,分别代表主版本号、次版本号和补丁版本号。

当代码变更时,版本号按以下原则更新:
1. 如果只是修复bug,需要更新Z位。
2. 如果是新增了功能,但是向下兼容,需要更新Y位。
3. 如果有大变动,向下不兼容,需要更新X位。

版本号有了这个保证后,在申明第三方包依赖时,除了可依赖于一个固定版本号外,还可依赖于某个范围的版本号。例如"argv": "0.0.x"表示依赖于0.0.x系列的最新版argv。


4. NPM常用命令

// vscode  node.js智能提示功能
npm install --save-dev @types/node

NPM提供了很多命令,例如install和publish,使用npm help可查看所有命令。

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

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

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

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

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

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

你可能感兴趣的:(NPM使用说明记录)