Shymean

参考

2018 年了，你还是只会 npm install 吗，这篇文章讲的很全，不妨移步阅读

npm install

参考:

模块安装流程

有了npm之后，我们只需要通过npm install xxx就可以从npm仓库里面下载别人写好的包，然后在代码里面引入相关的模块进行开发。

安装流程如下

npm 模块安装机制：
发出npm install命令
查询node_modules目录之中是否已经存在指定模块
- 若存在，不再重新安装
- 若不存在
  - npm 向 registry 查询模块压缩包的网址
  - 下载压缩包，存放在根目录下的.npm目录里
  - 解压压缩包到当前项目的node_modules目录

具体阶段可分为下面几个步骤

如果工程定义了preinstall钩子，则先执行
根据package.json中的dependencies 和 devDependencies 属性中直接指定的模块确定首层依赖，构建一颗以工程本身为根节点的依赖树
分析完模块依赖，就开始获取模块，获取模块是一个递归的过程
- 获取模块信息，在下载一个模块之前，首先要确定需要下载的包semver版本，然后返回对应的压缩包地址
- 获取模块实体，上一步会获取到模块的压缩包地址（resolved 字段），npm 会用此地址检查本地node_modules是否已经安装该包，如果没有则从仓库下载，下载的文件会放在node_modules下
- 查找该模块依赖，如果有依赖则回到第1步，如果没有则停止。

这里需要理解模块扁平化（dedupe）的概念。一棵完整的依赖树，其中可能包含大量重复模块，重复模块指的是模块名相同且semver兼容。已重复的模块不需要重新安装，这可以使更多冗余模块在 dedupe 过程中被去掉。

npm2中，node_modules采用简单的递归安装方法，不同的依赖包里面可能包含重复的底层包依赖
npm3中，node_modules 目录改成了更加扁平状的层级结构，得益于 node 的模块加载机制，模块可以在上层的node_modules目录中成功加载依赖，从而实现模块扁平化
npm5中，新增了package-lock.json文件，其作用是锁定依赖安装结构，内部与node_modules 目录的文件层级结构是一一对应的

优化install速度

切换镜像

日常工作可能需要从npm官方源、淘宝镜像、公司私有源等仓库来回切换，因此推荐nrm工具管理npm源

# 列举目前配置的源列表
nrm ls 
# 使用淘宝源
nrm use taobao
# 增加一种源，然后就可以在ls 和 use中使用了
nrm add xxxxx

直接从缓存安装

参考：npm 模块安装机制简介

一个模块安装以后，本地其实保存了两份。一份是~/.npm目录下的压缩包，另一份是node_modules目录下解压后的代码。

运行npm install的时候，只会检查node_modules目录，而不会检查~/.npm目录。也就是说，如果一个模块在～/.npm下有压缩包，但是没有安装在node_modules目录中，npm 依然会从远程仓库下载一次新的压缩包

这种行为固然可以保证总是取得最新的代码，但有时并不是我们想要的。最大的问题是，它会极大地影响安装速度。因此可以通过--cache-min从本地的缓存目录中直接解压包文件。

npm script

参考：npm scripts 使用指南

常见的cli工具，都增加了一个npm scripts命令，如npm run build、npm run serve等

每当执行npm run，就会自动新建一个 Shell，在这个 Shell 里面执行指定的脚本命令。因此，只要是 Shell（一般是 Bash）可以运行的命令，就可以写在 npm 脚本里面。

npx

npx是什么呢？ npx 会帮你执行依赖包里的二进制文件。

npm i webpack -D      //非全局安装

// 无npx 执行 webpack 的命令
./node_modules/.bin/webpack -v

// 使用npx
npx webpack -v

如何发布自己的npm包

编写本地模块

参考

怎么样写一个 node.js模块以及NPM Package

首先，新建一个txm文件夹，管理我们的整个模块文件，

index.js，用来存放模块的主要逻辑，注意按照CommonJS规范来书写模块，即每个模块使用exports暴露接口
package.json，模块的配置，比如名称，版本和相关依赖等等
README.md，模块的介绍和使用等

然后再txm文件夹中使用npm pack将整个文件夹打包，会显示生成txm-0.0.1.tgz(这个版本号是在package.json中定义)。

然后返回上一层，使用npm install txm/txm-0.0.1.tgz将txm模块包进行安装。
这里需要注意不能再txm文件夹中直接使用npm install txm-0.0.1.tgz，会出现Refusing to install xm as a dependency of itself的错误信息

可以在整个项目文件夹的node_modules文件夹中发现我们的模块包了。最后在项目的文件比如main.js中就可以直接使用let txm = require('txm')来加载我们的模块了。

发布及注意事项

编写好本地包之后，如果需要发布到npm仓库上供其他用户使用，按照以下步骤进行

将镜像切换回https://registry.npmjs.org/，其他源如淘宝npm会定期从npm官网上同步包，因此只需要发布在npm上即可
npm adduser、npm login登录需要发布模块的账号
注意包名和版本号，是否已经存在了

目前npm的包名为了防止“误植”攻击，会自动检测相近的包名，参考https://www.w3cvip.org/topics/393。

解决办法是加命名空间，然后修改发布权限

"name": "@shymean/koa-mock",
  
npm publish --access=public

具体实践可以参考之前写的一篇文章:

写一个搭建本地mock服务器的命令行工具。

搭建本地npm服务器

在某些时候不方便将模块发布到公共的npm仓库，因此就有了搭建本地npm服务器的需求

在之前可以使用sinopia来搭建npm私有仓库，但sinopia已经年久失修了，目前一般使用verdaccio

# 全局安装
npm i verdaccio -g 

# 启动服务
verdaccio

# 如果希望开启守护经常，可以使用pm2 
pm2 start verdaccio

http://localhost:4873

可以修改vs ~/.config/verdaccio/config.yaml的相关配置，比如当找不到包时如果希望去其他镜像查找，则修改uplinks参数

uplinks:
  npmjs:
    url: https://registry.npmjs.org/
    # 可以修改为淘宝镜像 url: https://registry.npm.taobao.org/

如果是公司级别的npm私库，可以考虑使用Docker安装verdaccio镜像，此外各大云服务提供商业提供了企业级别的私有包托管仓库，直接购买购买云服务应该也可以

修改npm镜像

如果是临时修改镜像源，可以通过--registry参数

npm --registry https://registry.npm.taobao.org install

永久修改registry，则可以通过npm config

npm config set registry https://registry.npm.taobao.org/

如果需要经常在多个镜像之间来回切换，可以使用nrm

npm install -g nrm

# 查看镜像
nrm ls

# 使用某个镜像
nrm use taobao

# 添加镜像
nrm add local http://localhost:4873/

其他包管理工具

yarn

Yarn是由Facebook、Google、Exponent 和 Tilde 联合推出了一个新的 JS 包管理工具，主要目的是弥补npm的一些设计缺陷。

在当时还是npm4.x的时代背景下，npm存在的一些缺陷

npm install的时候非常慢，要安装的依赖太多了，并且是按照队列顺序安装每个依赖
同一个项目，安装的时候无法保持一致性，没错，当时还没有package-lock.json

yarn具备的优点

安装速度快，主要靠：并行下载、缓存离线安装
yarn.lock记录每个被安装的依赖的版本

npm5.x之后做出了一些改动

增加了package-lock.json
文件依赖优化，通过symlinks依赖本地模块（之前是拷贝文件到node_modules）

yarn切换镜像的话，可以使用yrm，跟上面的nrm基本一致。

cnpm

不要用，不如使用npm然后改个taobao镜像。

pnpm

NPM与Yarn都是将项目依赖的包安装到项目目录node_modules下，PNPM采用了一种不同的方法，它在您的计算机上创建一个单一的虚拟存储库，并使用硬链接将其链接到各个项目目录，而不是将文件复制到每个项目目录中。这样可以实现多个项目共享相同的包版本而无需重复复制。PNPM还支持多个注册表、私有包和基于锁定文件的确定性构建。

这样就可以通过在项目之间使用共享存储来减少磁盘空间占用和加快安装速度

目前使用PNPM可以在Monorepo中更高效地管理依赖关系。PNPM的特点之一是使用虚拟存储库和硬链接来共享依赖项，从而减少磁盘空间占用和安装时间。这对于Monorepo来说非常有用，因为不同项目可以共享相同的依赖项，而不必在每个项目中都复制一份。这样可以减少冗余，并提供更快的安装和构建速度。

相关概念

模块与包

package.json

语义化版本

package-lock

npm install

模块安装流程

优化install速度

npm script

npx

如何发布自己的npm包

编写本地模块

发布及注意事项

搭建本地npm服务器

修改npm镜像

其他包管理工具

yarn

cnpm

pnpm

相关概念 ​

模块与包 ​

package.json ​

语义化版本 ​

package-lock ​

npm install ​

模块安装流程 ​

优化install速度 ​

npm script ​

npx ​

如何发布自己的npm包 ​

编写本地模块 ​

发布及注意事项 ​

搭建本地npm服务器 ​

修改npm镜像 ​

其他包管理工具 ​

yarn ​

cnpm ​

pnpm ​

相关概念

模块与包

package.json

语义化版本

package-lock

npm install

模块安装流程

优化install速度

npm script

npx

如何发布自己的npm包

编写本地模块

发布及注意事项

搭建本地npm服务器

修改npm镜像

其他包管理工具

yarn

cnpm

pnpm