【第16期】 only-allow 限制包管理器本地源码分析的是 only-allow , 它的作用是限制项目中使用统一

本文参加了由公众号@若川视野 发起的每周源码共读活动， 点击了解详情一起参与。
这是源码共读的第16期，链接：www.yuque.com/ruochuan12/…。

本地源码分析的是 only-allow , 它的作用是限制项目中使用统一的包管理工具, 如果使用的不是约定的包管理工具, 则不会执行相应的脚本.

这个包在 vite中有使用, 而在vue3中也有类似功能的代码

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)
}

如果想要对包管理器做出限制, 那面就需要在执行 install 脚本之前做出判断, 正好官方提供了脚本钩子, 包括 pre 和 post, 使用方式如下

{
  "scripts": {
    "precompress": "{{ executes BEFORE the `compress` script }}",
    "compress": "{{ run command to compress files }}",
    "postcompress": "{{ executes AFTER `compress` script }}"
  }
}

源码分析

#!/usr/bin/env node
// 获取用户使用的包管理器类型和版本
const whichPMRuns = require('which-pm-runs')
// 在终端上显示盒子
const boxen = require('boxen')

// process.argv属性返回一个数组，由命令行执行脚本时的各个参数组成。它的第一个成员总是node，第二个成员是脚本文件名，其余成员是脚本文件的参数。
const argv = process.argv.slice(2)
if (argv.length === 0) {
  console.log('Please specify the wanted package manager: only-allow <npm|cnpm|pnpm|yarn>')
  process.exit(1)
}
// 获取目标包管理器, 必须是 npm cnpm pnpm yarn 之一
const wantedPM = argv[0]
if (wantedPM !== 'npm' && wantedPM !== 'cnpm' && wantedPM !== 'pnpm' && wantedPM !== 'yarn') {
  console.log(`"${wantedPM}" is not a valid package manager. Available package managers are: npm, cnpm, pnpm, or yarn.`)
  process.exit(1)
}
// 获取执行当前命令时使用的包管理器 {name: 'npm', version: '7.24.0'}
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 'cnpm':
      console.log(boxen('Use "cnpm 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)
}

比如我们设定的包管理器是 pnpm, 在 package.json 文件中进行配置

{
    ...
    "scripts": {
        "preinstall": "node bin.js pnpm" // bin.js 是 only-allow 的源码文件
    }, 
    ...
}

那么我们在命令行中使用 npm install, 则会出现如下错误, 并终止命令的执行.

which-pm-runs

module.exports = function () {
  if (!process.env.npm_config_user_agent) {
    return undefined
  }
  //npm_config_user_agent: npm/7.24.0 node/v14.17.6 win32 x64 workspaces/false
  return pmFromUserAgent(process.env.npm_config_user_agent) 
}

function pmFromUserAgent (userAgent) {
  const pmSpec = userAgent.split(' ')[0] // npm/7.24.0
  const separatorPos = pmSpec.lastIndexOf('/') // 3
  return {
    name: pmSpec.substr(0, separatorPos),
    version: pmSpec.substr(separatorPos + 1)
  }
}