如何判断当前的 npm 包管理器?

1,931 阅读2分钟

前言

使用 npm 进行依赖安装比较常见。但随着项目体积、数量增加,npm 就会出现安装速度慢,体积过大的问题。使用 yarn 、pnpm 这些包管理器可以解决以上问题。

如果想强制让团队成员使用相同的包管理器,或者想针对不同的包管理器处理不同的逻辑。就需要判断当前使用的是哪种包管理器了。

实现方式

Vue 仓库 目前强制开发者使用 pnpm ,实现方式也非常巧妙。

首先,在运行 npm script 的时候,通过内置的 pre 命令运行前置脚本,在前置脚本中通过 process.env.npm_execpath 获取包管理器的文件路径,从而判断开发者使用的包管理器种类。

相关代码如下:

// package.json
"scripts": {
    "preinstall": "node ./scripts/preinstall.mjs",
},
// preinstall.mjs
if (!/pnpm/.test(process.env.npm_execpath || '')) {
  console.warn(
    `\u001b[33mThis repository requires using pnpm as the package manager ` +
      ` for scripts to work properly.\u001b[39m\n`
  )
  process.exit(1)
}

pre 命令

在 package.json 中,我们应该非常熟悉 npm script 的运行方式。

"scripts": {
    "dev": "vite",
},

通过阅读以上代码,我们就可以通过 npm run dev 来运行脚本了。

除了自定义脚本名称,npm 还内置了两个 prepost 指令,把 pre 拼接到自定义名称前,就可以实现前置钩子指令了。

"scripts": {
    "dev": "vite",
    "predev": "node predev.js"
    "postdev": "node postdev.js"
},

这样运行 npm run dev 指令的时候,终端会自动先运行 npm run predev ,再运行 npm run dev ,最后运行 npm run postdev,通过这种方式,我们就可以在自定义脚本运行前,先对包管理器进行判断了。

process.env.npm_execpath

在 vue@3.2.20 之前,Vue 的包管理器为 yarn ,之后改为了 pnpm。

使用 yarn 时,包管理器检查的代码为:

// scripts/checkYarn.js
if (!/yarn\.js$/.test(process.env.npm_execpath || '')) {
    console.warn(
    '\u001b[33mThis repository requires Yarn 1.x for scripts to work properly.\u001b[39m\n'
  )
  process.exit(1)
}

改为 pnpm 时,包管理器检查的代码为:

// preinstall.mjs
if (!/pnpm/.test(process.env.npm_execpath || '')) {
  console.warn(
    `\u001b[33mThis repository requires using pnpm as the package manager ` +
      ` for scripts to work properly.\u001b[39m\n`
  )
  process.exit(1)
}

通过对比,vue 是通过 process.env.npm_execpath 来判断包管理器的种类的,通过获取包管理器的路径,配合关键词检索,就可以完成包管理的种类判断了。

总结

通过借助 Vue 仓库 的这个方式,我们可以通过 npm script 内置的 pre 命令运行前置脚本,在前置脚本中通过 process.env.npm_execpath 获取包管理器的文件路径,从而判断开发者使用的包管理器种类。