← 中文资源

简体中文版本

构建依赖图 CLI

构建依赖图 CLI:完整覆盖 dependency analysis,含 Manifest reader、Graph builder 与测试的端到端实现。

阅读英文原文

项目概述

本项目实现一个面向 dependency analysis 的完整系统,核心要解决的问题是 building a graph of package dependencies and reporting cycles and orphans。整体由 Manifest reader、Graph builder、Cycle detector、Reachability analyzer、Report renderer 五个模块组成,每个模块单一职责、可独立测试,最后通过集成测试验证端到端正确性。设计上把 a cycle that the detector reports but the renderer truncates, hiding which edge to break 作为第一类需求先行处理,而非事后再补。

架构与关键决策

数据模型为 a directed graph of package nodes with dependency edges, analyzed for cycles and nodes unreachable from the entry。Manifest reader 定义其余阶段共同依赖的数据形状并在边界处校验输入;Graph builder 承载 dependency analysis 的正确性逻辑;Cycle detector 专门处理 a cycle that the detector reports but the renderer truncates, hiding which edge to break,在失败路径上给出明确的拒绝、重试或降级策略;Reachability analyzer 提供可观测性,每次操作输出带关联 id 的结构化事件;Report renderer 在过载时按既定方式降级,避免过载演变为数据损坏。配置与代码分离,使风险变更可经 diff 审阅。

实施与测试

按五个阶段依次实现 Manifest reader、Graph builder、Cycle detector、Reachability analyzer、Report renderer,每阶段配套聚焦单测。集成测试组合各模块并驱动真实 dependency analysis 场景:先验证正常路径,再刻意触发 a cycle that the detector reports but the renderer truncates, hiding which edge to break 并断言系统降级而非损坏。所有依赖均在进程内或被桩替换,用例在 CI 中确定可复现。

限制与后续

  • 单区域设计,多区域复制超出范围。
  • Manifest reader 默认进程内,未水平共享。
  • 无鉴权层,假定部署在强制身份的边缘之后。

代码示例

# setup for dependency-graph-cli
pnpm init
pnpm add commander graphlib
pnpm add -D typescript tsx vitest
dependency_graph_cli/
├── src/index.ts
├── src/manifest-reader.ts
├── src/graph-builder.ts
├── tests/dependency_graph_cli.test.ts
└── package.json
// Manifest reader: dependency analysis core
export function manifestreader(input: ManifestreaderInput): ManifestreaderResult {
  // Build the manifest reader that anchors dependency analysis and defines the core data shape.
  return processManifestreader(input);
}
// Graph builder — handles dependency analysis Add the graph builder so
export class Graphbuilder {
  constructor(private opts: GraphbuilderOptions) {}
  async run(ctx: Context): Promise<GraphbuilderOutput> {
    return this.execute(ctx);
  }
}
// Cycle detector: dependency analysis stage
export const cycledetector = (next: Next) => async (req: Request) => {
  const out = await transform(req);
  return next(out);
};
// Reachability analyzer for dependency analysis
export async function reachabilityanalyzer(stream: AsyncIterable<Chunk>): Promise<Aggregate> {
  let acc = init();
  for await (const c of stream) acc = merge(acc, c);
  return acc;
}
// Report renderer: dependency analysis finalization
export function reportrenderer(state: State): Result {
  validate(state);
  return finalize(state);
}
# run the dependency analysis test suite
pnpm vitest run