only-allow一行代码统一规范团队包管理器的神器
npx only-allow npmnpx only-allow yarnnpx only-allow pnpm{
"scripts": {
"preinstall": "npx only-allow npm"
}
}
Vue3 源码用了 npm 的 preinstall 钩子 约束，只能使用 pnpm 安装依赖。
package.json
// vue-next/package.json
{
"private": true,
"version": "3.2.22",
"scripts": {
"preinstall": "node ./scripts/preinstall.js",
}
}
// vue-next/scripts/preinstall.js
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)
}
关于 process 对象可以查看 阮一峰老师 process 对象
process.argv属性返回一个数组，由命令行执行脚本时的各个参数组成。 它的第一个成员总是node，第二个成员是脚本文件名，其余成员是脚本文件的参数。
独立的 npm 包，https://pnpm.io/only-allow-pnpm
#!/usr/bin/env node
const whichPMRuns = require('which-pm-runs')
const boxen = require('boxen')
const argv = process.argv.slice(2)
if (argv.length === 0) {
console.log('Please specify the wanted package manager: only-allow <npm|pnpm|yarn>')
process.exit(1)
}
// 第一个参数则是 用户传入的希望使用的包管理器
// 比如 npx only-allow pnpm
// 这里调试是 node bin.js pnpm
const wantedPM = argv[0]
if (wantedPM !== 'npm' && wantedPM !== 'pnpm' && wantedPM !== 'yarn') {
console.log(`"${wantedPM}" is not a valid package manager. Available package managers are: npm, pnpm, or yarn.`)
process.exit(1)
}
const usedPM = whichPMRuns()
// 希望使用的包管理器 不相等，则报错。
// - npm 提示使用 npm install
// - pnpm 提示使用 pnpm install
// - yarn 提示使用 yarn install
// 最后退出进程
if (usedPM && usedPM.name !== wantedPM) {
const boxenOpts = { borderColor: 'red', borderStyle: 'double', padding: 1 }
switch (wantedPM) {
case 'npm':
console.log(boxen('Use "npm install" for installation in this project', boxenOpts))
break
case 'pnpm':
console.log(boxen(`Use "pnpm install" for installation in this project.
If you don't have pnpm, install it via "npm i -g pnpm".
For more details, go to https://pnpm.js.org/`, boxenOpts))
break
case 'yarn':
console.log(boxen(`Use "yarn" for installation in this project.
If you don't have Yarn, install it via "npm i -g yarn".
For more details, go to https://yarnpkg.com/`, boxenOpts))
break
}
process.exit(1)
}
可以继续查看 which-pm-runs 源码如下，返回包管理器和版本号。
which-pm-runs源码如下
'use strict'
module.exports = function () {
if (!process.env.npm_config_user_agent) {
return undefined
}
return pmFromUserAgent(process.env.npm_config_user_agent)
}
function pmFromUserAgent (userAgent) {
const pmSpec = userAgent.split(' ')[0]
const separatorPos = pmSpec.lastIndexOf('/')
return {
name: pmSpec.substr(0, separatorPos),
version: pmSpec.substr(separatorPos + 1)
}
}
关于 process.env.npm_config_user_agent
process.env.npm_config_user_agent 是格式类似如下的字符串, 从中提取第一项，得出当前使用的包管理器
npm/6.1.0 node/v8.9.4 darwin x64
// 或
yarn/1.7.0 npm/? node/v8.9.4 darwin x64
process
process.argvprocess.env.npm_config_user_agentsubstr String.prototype.substr is deprecated.
扩展
技术（开源）项目本质上是：理念、套路、规范的工具化。