@abmao/pkgs

Appearance

On this page

插件 ​

简介 ​

pkgs 支持插件化，通过配置文件 plugins 引入，支持对象、函数、路径、模块名

插件声明类型

插件格式基于 commander 封装，插件 action 方法会接受 context 与 插件定义的命令参数

实现插件 ​

下列例子实现一个插件，返回工作区所有的包（包括间接影响的包），并基于依赖顺序打印到命令行上

项目示例

实现过程 ​

默认导出一个插件函数

ts
import type { PluginData } from '@abmao/pkgs'

// ./plugin.ts
export default function createPackagesPlugin(): PluginData {
  return {
    id: 'packages',
    command: 'packages',
    description: 'get work packages',
    action: commandPackages,
  }
}

接收 context 做操作

ts
import type { Context } from '@abmao/pkgs'

// ./plugin.ts
export async function parsecCommandPackages(context: Context): Promise<string[]> {
  // 获取工作区包目录路径，包括直接和间接依赖这些包的包
  const files = await context.fileStore.workDiffFile()
  // 通过扑排序返回直接和间接这些包的依赖包
  const packageDirList = context.contextAnalysisDiagram.getMyRelyDir(files)

  const packageNameList = packageDirList
    // 包目录映射到对应的图表，拿到包名
    .map(dir => context.contextAnalysisDiagram.dirToAnalysisBlock(dir)?.name)
    .filter(name => name) as string[]
  return packageNameList
}

export async function commandPackages(context: Context): Promise<string[]> {
  // 接收命令
  const packageNameList = await parsecCommandPackages(context)
  // 序列化成字符串
  const logStr = packageNameList.reduce((previousValue, currentValue) => {
    return `${previousValue}\n${currentValue}`
  }, '')
  // 打印命令
  console.log(logStr)
  return packageNameList
}
ts
// ./pkgs.config.ts
import { createPackagesPlugin } from './plugin.ts'

export default {
  plugins: [
    createPackagesPlugin,
  ],
}

项目背景 ​

项目示例有3个包，分别是demo、demo2和demo3，demo依赖了demo3，我们修改demo3包在工作区上，通过pkgs packages就可以依次打印出demo3和demo

运行命令 ​

bash
pkgs -h

pkgs -h

bash
pkgs packages

pkgs packages