mcpField
M
maintainable-typescript

maintainable-typescript

github.com/miguelspizza开发12109 次安装2 周前更新
代码仓库

关于 maintainable-typescript

面向 TypeScript 项目维护与审查的技能,提供按任务查阅的原则和工作流。涵盖结构、类型、测试与工具实践,并指导结合 Fallow 进行代码健康检查。

主要功能

  1. 01按任务路由维护指南
  2. 02审查与清理工作流
  3. 03类型与 API 设计原则
  4. 04测试和边界实践
  5. 05Fallow 代码健康检查

适用场景

  1. 01审查 TypeScript 仓库
  2. 02清理过时代码
  3. 03规划模块与包边界
  4. 04改进测试和类型设计

安装

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

$npx skills add https://github.com/miguelspizza/skills --skill maintainable-typescript

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

包含的文件

除 SKILL.md 外,安装时一起下载的参考资料和脚本。

assets/tooling-templates/
.fallowrc.json
doctrine/abstractions/
build-deep-modules-not-shallow-abstractions.md
compose-behavior-do-not-specialize-classes.md
design-around-composable-primitives.md
keep-a-functional-core-and-imperative-shell.md
keep-schemas-minimal.md
make-builders-earn-their-keep.md
no-premature-abstractions.md
ssot-or-die.md
structure-typescript-apps-around-feature-owners.md
use-classes-for-object-apis-not-service-buckets.md
doctrine/boundaries/
assign-cache-invalidation-owners.md
boundaries-validate-internals-trust.md
error-messages-are-ux.md
log-at-boundaries-not-everywhere.md
no-defensive-catches.md
no-defensive-null-checks.md
no-type-casts.md
pass-values-across-boundaries.md
doctrine/deletion/
clean-up-what-you-touch.md
delete-fake-layers.md
delete-obsolete-code.md
edit-real-owners.md
no-backwards-compat-shims.md
doctrine/foundations/
atomic-changes.md
bounded-behavior.md
comments-say-why-not-what.md
commit-messages-describe-why.md
maintainability-equals-correctness.md
naming-is-navigation.md

详细介绍

可维护的 TypeScript

当项目需要可维护性准则,而不只是局部代码更改时,请使用此技能。

加载顺序

默认情况下不要读取整个技能目录。

  1. 首先阅读此文件。
  2. 仅加载与任务匹配的文件。
  3. 如果仓库符合内部技术栈,请阅读 stack/start-here.md。
  4. 将 doctrine/、stack/、prompts/、scripts/ 和 assets/tooling-templates/ 视为参考资料,而非必需上下文。

配套技能

Fallow 技能适用于 Fallow 配置、命令、JSON 输出、修复、CI 门禁和结果解读。如果缺少该技能:

npx skills add https://github.com/fallow-rs/fallow/tree/main/npm/fallow/skills/fallow --skill fallow

任务路由

审计工作流

用于清理或审查:

skill_dir="<path-to-this-skill>"
bash "$skill_dir/scripts/audit-typescript-repo.sh" .

将审计输出视为信号,而非权威依据。删除 API 表面或合并模式前,先检查实际用法。

如果目标仓库使用 Vite+,请使用 vp 作为常规工具链入口:vp lint、vp test、vp fmt、vp pack、vp add 和 vp dlx。

默认原则

  • 结构代价高昂;保留契约、测试和不变量。
  • 优先选择删除而非垫片、真正的负责人而非虚假层,以及稳定的子系统文件而非辅助文件丛林。
  • 将不确定性落实为契约,而非适配器、默认值、可选项、展开操作或捕获逻辑。
  • 优先选择派生类型/模式、持久的集成测试、仅针对外部边界的模拟,以及对可观察结果的断言。
  • 优先使用 Fallow 检查死代码、重复代码、依赖项卫生、健康状况、循环依赖和依赖边界。
  • 让代码库现在变得更加一致。

评论

支持 Markdown