mcpField
P
package-architect

package-architect

github.com/shipshitdev开发38173 次安装2 天前更新
代码仓库

关于 package-architect

用于在 Bun、pnpm 或 npm 工作区中设计可复用 TypeScript 包的技能。它为 monorepo 中的包边界、公共导出、TypeScript 引用和构建组织提供指导。

主要功能

  1. 01组织可复用的 TypeScript 包
  2. 02定义稳定的包导出
  3. 03配置 TypeScript 项目引用
  4. 04分离构建产物与源代码
  5. 05检查依赖和配置一致性

适用场景

  1. 01在 monorepo 中创建包
  2. 02重构工作区包结构
  3. 03设置包导出和 TypeScript 引用

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/shipshitdev/skills --skill package-architect

安装后在 Claude Code 中输入/package-architect确认已加载。

附带文件plugin.json

详细介绍

包架构设计

在 monorepo 中设计可复用的 TypeScript 包(Bun、pnpm 或 npm 工作区)。

适用场景

  • 创建新包或重构 monorepo 包
  • 定义 package.json 导出
  • 设置 tsconfig 引用

核心原则

  • 每个包只承担一项职责。
  • 提供稳定且导出清晰的公共 API。
  • 避免内联接口;集中管理类型。
  • 将构建输出与源文件分开。

包结构(示例)

packages/
  utils/
    src/
    package.json
    tsconfig.json
  api-client/
    src/
    package.json
    tsconfig.json

导出模式(示例)

{
  "name": "@scope/utils",
  "main": "dist/index.js",
  "types": "dist/index.d.ts",
  "exports": {
    ".": {
      "import": "./dist/index.js",
      "types": "./dist/index.d.ts"
    }
  }
}

TypeScript 引用

  • 使用项目引用管理包间依赖。
  • 本地开发导入优先使用路径别名。
  • 在各个包之间共享 tsconfig 基础配置。

检查清单

  • 导出映射与预期的公共 API 一致
  • 类型与 JS 输出一同构建
  • 无循环依赖
  • lint 和 tsconfig 设置保持一致

评论

支持 Markdown