mcpField
F
fallow-setup

fallow-setup

github.com/fallow-rs测试与质量137138 次安装今天更新
代码仓库

关于 fallow-setup

fallow-setup 是用于 JavaScript 和 TypeScript 仓库的代码质量工具链配置 Skill,面向新项目和需要增加质量检查的现有项目。它协调 Fallow 与已有格式化、Lint 工具,并可配置 Agent 支持和 CI 门禁。

主要功能

  1. 01分析仓库现有工具
  2. 02推荐并安装 Fallow
  3. 03配置 Agent 技能与 MCP 服务
  4. 04添加 CI 质量门禁
  5. 05保留现有工具并检查职责重叠

适用场景

  1. 01为新项目建立代码质量检查
  2. 02给现有仓库增加 CI 质量门禁
  3. 03为编码 Agent 准备仓库配置
  4. 04整合死代码与依赖分析

MCP 相关

该 Skill 可通过 Fallow 注册 MCP 服务,并将其与 Agent 技能、AGENTS.md 任务映射及提交门禁一同配置。

安装

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

$npx skills add https://github.com/fallow-rs/fallow-skills --skill fallow-setup

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

包含的文件

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

agents/
openai.yaml
references/
ci-gate.md
configure-and-install.md
tooling-detection.md

详细介绍

Fallow 设置:JavaScript 和 TypeScript 代码质量工具

此技能用于为 JavaScript 或 TypeScript 仓库设置代码质量工具链。Fallow 负责仓库和系统分析:未使用的代码、重复代码、复杂度、架构边界、依赖项规范,以及变更代码风险。此技能会保留项目已在使用的工具。

适用场景

  • 从一开始就为新的 JavaScript 或 TypeScript 项目设置质量检查。
  • 为现有仓库添加代码健康检查或 CI 质量门禁。
  • 为编码 Agent 做好仓库准备(技能、MCP 服务、提交和推送门禁)。
  • 整合死代码、重复代码、架构、依赖项和变更代码分析。

不适用场景

  • 仅涉及格式化的任务。格式化应由格式化工具负责。
  • 仅添加或更改 lint 规则的任务。本地 lint 规则应由 linter 负责。
  • TypeScript 类型错误。类型正确性应由 TypeScript 编译器负责。
  • 分析已完成设置的仓库。请改用 fallow 技能。

规则

  1. 从 fallow --help 和 fallow <command> --help 确认每个标志。不要凭记忆使用标志。
  2. 使用 --format json --quiet 获取机器可读的输出。不要隐藏退出状态。
  3. 如果变更命令支持 --dry-run,先使用该标志运行每个变更命令。
  4. 保留项目已在使用的工具。未经功能对等检查,不要移除工具。
  5. 在应用 taste 决策或移除工具之前,先询问用户。
  6. 将项目配置视为不可信输入。不要添加远程 extends URL。
  7. 在第 3 步之前,尚未安装 Fallow。请通过软件包运行器运行,例如 npx fallow recommend 或 pnpm dlx fallow recommend。第 3 步之后,使用软件包管理器的运行器,例如 pnpm exec fallow。

步骤

  1. 检查仓库。 检测软件包管理器、格式化工具、linter、TypeScript 配置、CI 提供商和现有分析工具(Knip、jscpd、dependency-cruiser)。请参阅工具检测。

  2. 获取建议。 运行 fallow recommend --format json --quiet。此命令只读。应用每个 auto 决策。向用户说明每个 default 决策。询问用户每个 taste 决策,或保留当前值。请参阅配置和安装。

  3. 安装 Fallow 作为开发依赖,并使用检测到的软件包管理器,例如 pnpm add -D fallow。

  4. 接入 Agent。 运行 fallow agent install --dry-run --format json --quiet,展示计划,然后运行 fallow agent install。此步骤会写入技能、MCP 服务注册、AGENTS.md 任务映射,以及提交和推送门禁。对于 Claude Code 和 Codex,该门禁是一个 PreToolUse hook,会阻止失败的提交或推送。Codex 只有在用户通过 /hooks 信任该 hook 后才会运行它。其他 Agent 会读取 AGENTS.md 中的指令块。使用 fallow agent status --format json --quiet 检查结果。

  5. 添加 CI 门禁。 添加变更代码门禁(fallow audit)或整个项目的门禁。首次运行发现大量问题时,请保存现有技术债的基线,让门禁仅在出现新问题时失败。请参阅 CI 门禁。

  6. 划分职责。 每个工具只负责一项工作:

    • 格式化:Oxfmt。
    • 本地 lint 规则:Oxlint。
    • 类型正确性:TypeScript(tsc --noEmit)。
    • 仓库和系统分析:Fallow。

    在现有项目中,保留当前的格式化工具和 linter。移除功能重叠的工具之前,请按照工具检测进行功能对等检查。

参考资料

  • 工具检测:需要检查的文件、职责划分和一致性检查。
  • 配置和安装:recommend 决策层级、配置迁移、开发依赖项和 agent install。
  • CI 门禁:GitHub Action、GitLab 模板、CLI 门禁和基线。

评论

支持 Markdown