读39行代码的小工具 install-pkg并解析其实现

最新推荐文章于 2023-09-15 22:00:00 发布

原创最新推荐文章于 2023-09-15 22:00:00 发布 · 471 阅读

1 ·

CC 4.0 BY-SA版权

文章标签：

#npm #前端 #node.js

install-pkg是一个用于编程安装npm包的工具，它能自动检测并使用正确的包管理器。本文深入解析其仓库、package.json、依赖和代码实现，包括ni自动检测、tsup编译工具、execa命令执行库以及find-up文件查找工具的使用。同时，文章还分析了关键代码逻辑，如检测包管理器、stdi配置及过滤逻辑。

install-pkg

以编程方式安装程序包。并且自动检测包装管理器（npm、yarn和pnpm）

npm i @antfu/install-pkg

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

也就是通过编程方式去安装某个包到本地中，它让我想起了14期remote-git-tags中的实现，本质上是通过代码执行去调用命令安装

仓库

这里推荐使用川哥整理好的同步文章仓库

//川
git clone https://github.com/lxchuan12/install-pkg-analysis.git
cd install-pkg-analysis/install-pkg && pnpm i

//官方项目
git clone https://github.com/antfu/install-pkg.git
cd install-pkg && pnpm i

package.json 解析

ni

自动检测包管理工具，使用正确的包管理器。它可以根据你的锁文件去推断你当前的包管理器，根据相应的命令去做转化

prepublishOnly

npm钩子，在执行 npm publish 之前会执行这个命令

nr

ni 下可执行命令，对应的是 npm run /yarn run / pnpm run

nr build , 如果你使用npm包管理工具，对应的就是 npm run build

esno

具有自动CJS/ESM模式和缓存的ts编译工具，本质就是一个tsx

tsup

使用Esbuild，无需配置即可打包你的TS库

tsup src/index.ts --format cjs,esm --dts --no-splitting

bumpp

更好的进行版本号提升的工具，基于version-bump-prompt改造

生产依赖

execa

命令执行相关的库，基于 child_process 进行了封装，使用更加友好

import {execa} from 'execa';
const {stdout} = await execa('echo', ['unicorns']);
console.log(stdout);

find-up

通过查找父目录查找文件或目录 , 字面意思就是找到指定文件路径的工具

import path from 'node:path';
import {findUp, pathExists} from 'find-up';

console.log(await findUp('unicorn.png'));
//=> '/Users/sindresorhus/unicorn.png'

代码

index.ts

export * from './detect'
export * from './install'

统一出口，将detect 和 install的导出从index统一导出

install.ts

import execa from 'execa'
import { detectPackageManager } from '.'

export interface InstallPackageOptions {cwd?: stringdev?: booleansilent?: booleanpackageManager?: stringpreferOffline?: booleanadditionalArgs?: string[]
}

export async function installPackage(names: string | string[], options: InstallPackageOptions = {}) {const agent = options.packageManager || await detectPackageManager(options.cwd) || 'npm'if (!Array.isArray(names))names = [names]const args = options.additionalArgs || []if (options.preferOffline)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,},)
}

detect.ts

import path from 'path'
import findUp from 'find-up'

export type PackageManager = 'pnpm' | 'yarn' | 'npm'

const LOCKS: Record<string, PackageManager> = {'pnpm-lock.yaml': 'pnpm','yarn.lock': 'yarn','package-lock.json': 'npm',
}

export async function detectPackageManager(cwd = process.cwd()) {const result = await findUp(Object.keys(LOCKS), { cwd })const agent = (result ? LOCKS[path.basename(result)] : null)return agent
}

逐行分析

const agent = options.packageManager || await detectPackageManager(options.cwd) || 'npm'if (!Array.isArray(names))names = [names]

agent 从默认的配置对象中以及 detectPackageManager 函数去读取我们使用的是什么包管理工具，不成立的情况下默认为npm，并将第一个传入的非数组参数包装了为数组类型

import findUp from 'find-up'
export async function detectPackageManager(cwd = process.cwd()) {const result = await findUp(Object.keys(LOCKS), { cwd })const agent = (result ? LOCKS[path.basename(result)] : null)return agent
}

detectPackageManager 函数通过当前执行命令的目录，使用 find-up去查找锁文件(LOCKS)，得到对应的包管理工具，否则为null。知道findUp 函数是干啥的这里就很好理解了

 const args = options.additionalArgs || []if (options.preferOffline)args.unshift('--prefer-offline')

args变量即执行执行时的附加参数

一条没见过的新命令: –prefer-offline

--prefer-offline将使npm跳过任何条件请求（304检查）直接使用缓存数据，只有在缓存无法匹配到的时候，才去访问网络。这样我们将依赖包添加到项目的过程就会快很多,可以理解为优先使用本地或者全局的缓存，没有才进行联网安装

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

奇怪的Boolean

在读这一块代码时，产生了一个疑问， Boolean这干啥的，第一眼想起了装箱类型，即它本身是一个function, 所以它被作为callback 给了filter使用。接着我就去研究这个函数的作用，它会根据传入的参数是否有效决定返回值。 即 1 返回 true ， 0 返回false