如何限制统一使用包管理器

本文参加了由公众号@若川视野 发起的每周源码共读活动，点击了解详情一起参与。

在我们平时所见到的一些项目中，对于依赖的安装方式都并没有做出强制的规范约束，这样就可能导致每个人使用的包管理器不一样，可能是npm也可能是yarn又或者是pnpm，而使用的不同的包管理器又可能导致出一些问题，所以这里我们可以看看该如何去做出这个规范约束

Vue3以及vite是怎么统一规范的

// vue3
{
  "private": true,
    "version": "3.2.22",
      "scripts": {
    "preinstall": "node ./scripts/preinstall.js",
  }
}

// vite
{
  "scripts": {
    "preinstall": "npx only-allow pnpm"
  }
}

可以看到vue3以及vite是通过npm中的preinstall去约束的，而在vite中更是用到了only-allow这个包

only-allow

npm地址：www.npmjs.com/package/onl…

文档介绍only-allow是强制在一个项目上使用一个特定的软件包管理器，既然如此，那我们就拉下代码看看是如何实现的

only-allow源码

拿到代码后，我们先看package.json找到入口文件并加上一行代码

找到入口文件bin.js后，先贴上整体代码，再来一步一步看

#!/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)
}
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()
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)
}

process.argv属性返回一个数组，由命令行执行脚本时的各个参数组成。它的第一个成员总是node，第二个成员是脚本文件名，其余成员是脚本文件的参数。 process.exit进程的退出，process.exit(1)由于某种故障而退出进程 跟随着调试来到whichPMRuns函数内部

whichPMRuns

'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是类似于这样的字符串 'yarn/1.22.19 npm/? node/v16.16.0 win32 x64'，所以whichPMRuns的作用是获取当前运行的是哪个包管理器，并且返回名字和版本号。

总结

1. 了解了process对象
2. 通过preinstall和only-allow约束包管理器