程式設計式安裝依賴install-pkg原始碼解析

2022-12-27 14:01:40

正文

通常安裝依賴都是通過命令式的方式來安裝，有沒有想過可以通過程式設計式的方式來安裝依賴呢？

install-pkg是一個用於安裝依賴的工具，它可以在不同的環境下安裝依賴，比如 npm、yarn、pnpm 等。

使用

install-pkg的使用非常簡單，根據README的說明，就通過下面的程式碼就可以安裝依賴了：

import { install } from 'install-pkg'
await installPackage('vite', { silent: true })

原始碼分析

install-pkg的原始碼非常簡單，只有 100 行左右，我們來看看它的實現原理。

根據README的說明，我們可以通過installPackage方法來安裝依賴，那麼我們先來看看installPackage方法的實現：

installPackage方法在src/index.ts檔案中，轉成 js 程式碼如下：

import execa from 'execa'
import { detectPackageManager } from '.'
export async function installPackage(names, options = {}) {
  const detectedAgent = options.packageManager || await detectPackageManager(options.cwd) || 'npm'
  const [agent] = detectedAgent.split('@')
  if (!Array.isArray(names))
    names = [names]
  const args = options.additionalArgs || []
  if (options.preferOffline) {
    // yarn berry uses --cached option instead of --prefer-offline
    if (detectedAgent === 'yarn@berry')
      args.unshift('--cached')
    else
      args.unshift('--prefer-offline')
  }
  return execa(
    agent,
    [
      agent === 'yarn'
        ? 'add'
        : 'install',
      options.dev ? '-D' : '',
      ...args,
      ...names,
    ].filter(Boolean),
    {
      stdio: options.silent ? 'ignore' : 'inherit',
      cwd: options.cwd,
    },
  )
}

可以看到是一個非同步方法，它接收兩個引數，第一個引數是要安裝的依賴名稱，第二個引數是設定項。

在方法內部，首先通過傳入的設定項options來獲取packageManager，如果沒有傳入packageManager，則通過detectPackageManager方法來獲取packageManager，如果detectPackageManager方法也沒有獲取到packageManager，則預設使用npm。

來看看detectPackageManager方法的實現：

import fs from 'fs'
import path from 'path'
import findUp from 'find-up'
const AGENTS = ['pnpm', 'yarn', 'npm', 'pnpm@6', 'yarn@berry', 'bun']
const LOCKS = {
  'bun.lockb': 'bun',
  'pnpm-lock.yaml': 'pnpm',
  'yarn.lock': 'yarn',
  'package-lock.json': 'npm',
  'npm-shrinkwrap.json': 'npm',
}
export async function detectPackageManager(cwd = process.cwd()) {
  let agent = null
  const lockPath = await findUp(Object.keys(LOCKS), { cwd })
  let packageJsonPath
  if (lockPath)
    packageJsonPath = path.resolve(lockPath, '../package.json')
  else
    packageJsonPath = await findUp('package.json', { cwd })
  if (packageJsonPath && fs.existsSync(packageJsonPath)) {
    try {
      const pkg = JSON.parse(fs.readFileSync(packageJsonPath, 'utf8'))
      if (typeof pkg.packageManager === 'string') {
        const [name, version] = pkg.packageManager.split('@')
        if (name === 'yarn' && parseInt(version) > 1)
          agent = 'yarn@berry'
        else if (name === 'pnpm' && parseInt(version) < 7)
          agent = 'pnpm@6'
        else if (name in AGENTS)
          agent = name
        else
          console.warn('[ni] Unknown packageManager:', pkg.packageManager)
      }
    }
    catch {}
  }
  // detect based on lock
  if (!agent && lockPath)
    agent = LOCKS[path.basename(lockPath)]
  return agent
}

findUp是一個用於查詢檔案的工具，它可以從當前目錄向上查詢檔案，直到找到為止。

我們來逐行分析：

const lockPath = await findUp(Object.keys(LOCKS), {cwd})
let packageJsonPath
if (lockPath)
    packageJsonPath = path.resolve(lockPath, '../package.json')
else
    packageJsonPath = await findUp('package.json', {cwd})

最開始是獲取package-lock.json、yarn.lock、pnpm-lock.yaml等檔案的路徑；

如果找到就好辦了，直接在這個檔案目錄下找package.json檔案即可；

如果沒找到就繼續使用findUp方法來查詢package.json檔案。

if (packageJsonPath &amp;&amp; fs.existsSync(packageJsonPath)) {
    try {
        const pkg = JSON.parse(fs.readFileSync(packageJsonPath, 'utf8'))
        // ...
    } catch {
    }
}

如果找到了package.json檔案，就讀取檔案內容，然後解析成 JSON 物件。

if (typeof pkg.packageManager === 'string') {
    const [name, version] = pkg.packageManager.split('@')
    if (name === 'yarn' && parseInt(version) > 1)
        agent = 'yarn@berry'
    else if (name === 'pnpm' && parseInt(version) < 7)
        agent = 'pnpm@6'
    else if (name in AGENTS)
        agent = name
    else
        console.warn('[ni] Unknown packageManager:', pkg.packageManager)
}

這裡是用過packageManager來判斷使用哪個包管理器;

如果packageManager是yarn，並且版本號大於1，則使用yarn@berry；
如果packageManager是pnpm，並且版本號小於7，則使用pnpm@6；
如果packageManager是yarn、pnpm、npm、bun中的一個，則直接使用；
否則就列印一個警告。

// detect based on lock
if (!agent && lockPath)
    agent = LOCKS[path.basename(lockPath)]

如果沒有通過package.json來獲取packageManager，則通過lockPath來獲取packageManager。

這個方法的核心就是通過兩個方式來獲取packageManager：

通過package.json中的packageManager欄位；
通過lock檔案來獲取。

可以說是非常巧妙。

我們繼續看installPackage方法：

const detectedAgent = options.packageManager || await detectPackageManager(options.cwd) || 'npm'
const [agent] = detectedAgent.split('@')

這裡是第一行，就是獲取packageManager，和上面講的方法相輔相成，繼續往下看：

if (!Array.isArray(names))
    names = [names]

這裡是將name統一變成陣列，方便後面處理。

const args = options.additionalArgs || []
if (options.preferOffline) {
    // yarn berry uses --cached option instead of --prefer-offline
    if (detectedAgent === 'yarn@berry')
        args.unshift('--cached')
    else
        args.unshift('--prefer-offline')
}

這裡是處理preferOffline引數，如果設定了這個引數，就會在args中新增--prefer-offline或者--cached引數，因為yarn@berry和npm的引數不一樣。

return execa(
    agent,
    [
      agent === 'yarn'
        ? 'add'
        : 'install',
      options.dev ? '-D' : '',
      ...args,
      ...names,
    ].filter(Boolean),
    {
      stdio: options.silent ? 'ignore' : 'inherit',
      cwd: options.cwd,
    },
  )

這裡的命令是根據packageManager來拼接的，yarn和npm的命令不一樣，所以需要判斷一下。

最後就是執行安裝命令了，這裡使用了execa來執行命令，這個庫的用法和child_process差不多，但是更加方便，參考：execa。