【源码共读】第16期 | 一行代码统一规范 包管理器

1. 前言

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

• 这是源码共读的第16期，链接：一行代码统一规范 包管理器

• only-allow仓库

2. 如何进行统一包管理

场景：当开发同一项目时，个人习惯不同，可能使用的包管理工具不同，需要进行统一。

2.1 npm钩子

npm提供了很多钩子，帮助我们实现。

实现思路：

每次使用命令安装时，会运行钩子，可在preinstall钩子函数中进行判断，是否使用限制的包管理工具。

3. 源码调试

代码如下：

#!/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()// {name:'yarn',version:'1.22.17'}
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)
}

1. 获取当前期望的包管理工具

2. 使用whichPMRuns获取当前使用的包工具

3. 两者进行判断，使用boxen进行报错

4. 总结

整体流程如下：

源码比较简单，具体就是为了解决运行的包管理器一致问题。一步一个脚印，加油吧 O^O!