install-pkg怎么安裝和使用

本文小編為大家詳細介紹“install-pkg怎么安裝和使用”，內容詳細，步驟清晰，細節處理妥當，希望這篇“install-pkg怎么安裝和使用”文章能幫助大家解決疑惑，下面跟著小編的思路慢慢深入，一起來學習新知識吧。

正文

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

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 && 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差不多，但是更加方便。

讀到這里，這篇“install-pkg怎么安裝和使用”文章已經介紹完畢，想要掌握這篇文章的知識點還需要大家自己動手實踐使用過才能領會，如果想了解更多相關內容的文章，歡迎關注億速云行業資訊頻道。