5t111111/code-conventions:Deno 项目代码规范与文档风格 Skill Skill 技能

用 mise run fmt + 英文符号文档注释统一 Deno 团队代码气质。

技能简介

5t111111/code-conventions 是面向 Deno 项目的轻量级"代码规范与文档风格" Skill。它解决的是"Deno 项目里谁也不确定 function/class/property 该不该加 JSDoc、格式化用 deno fmt 还是 prettier、Cron 任务跑哪条命令"这类新成员 onboarding 痛点。Skill 通过强制 Agent 在提交前跑 mise run fmt + 自动产出英文符号文档注释,统一团队代码气质。来源仓库 5t111111/tailwind-theme-figma-variables/.github/skills/code-conventions,MIT 协议。

核心能力

  • Deno 风格格式化:强制 Agent 用 mise run fmt(deno fmt 包装)而不是 prettier,避免格式漂移。
  • 符号文档规范:要求 function、class、property 都加英文 doc comment,给出最小可接受的注释模板。
  • 提交前强制:在 Agent 内部 hook 中调用 fmt,未跑通不允许 commit message 收尾。
  • 反通用化检查:内置"命名一致性 / 缩进 / 引号风格 / 文件头注释"清单项。
  • Agent 友好提示:提供机读的 lint failure 解释,让 Claude / Codex / Claude Code 直接对齐错误并修复。
  • 最小依赖:只要求 mise 与 deno 两个 CLI,不需要额外配置 editor plugin。

安装配置

  1. 安装 mise:curl https://mise.run | sh(或按平台包管理器装)。
  2. 安装 Deno:curl -fsSL https://deno.land/install.sh | sh。
  3. 安装 Skill:npx skillstore add 5t111111/code-conventions。
  4. 在仓库根目录添加 mise.toml / .mise.toml,配置 run = "deno fmt" 等任务,让 Skill 的命令可直接执行。
  5. 配置 Agent 的工具白名单允许 mise run fmt 和 deno fmt --check 两条外部命令。

使用步骤

  1. 在 Agent 对话中给出变更需求,让 Agent 写出 Deno 风格代码。
  2. Agent 提交前自动调用 Skill 中定义的 fmt 步骤,发现格式问题直接本地修复。
  3. 同时触发"符号文档注释"检查:未注明意图/参数/返回值的 export 符号被标红。
  4. Agent 把 lint 结果按 Skill 模板改写成 PR 描述里的"Conventions Check" 一节。
  5. CI 通过 deno fmt --check + deno lint + deno test 三件套守住底线。

适用场景

  • Deno + Fresh / Hono / Oak 项目维护者要统一代码风格。
  • 团队从 Node 迁移到 Deno,需要把现有 prettier 习惯换成 deno fmt 范式。
  • 开源 Deno 库想给贡献者一份清晰、机器可读的代码规范。
  • AI Coding Agent 在生成 Deno 代码时缺少上下文规范,装上 Skill 即可。
  • 个人 Deno 玩具项目想避免"半年后自己都看不懂"。

适用人群

  • Deno 项目维护者与贡献者。
  • 在 Deno 上做 AI Coding 的 Agent 工程师。
  • 想从零规范化 Deno 项目的 Tech Lead。

工作原理

Skill 把"调用 mise run fmt 的命令模板 + JSDoc 注释最小集 + 提交前自检流程"打包到一个 SKILL.md,Agent 在创建新文件或修改 export 符号时自动套用模板;CI 通过 --check 模式守住不变量,避免代码风格漂移。

官方链接

团队信息

由 AI 猎手自动发现

评论与建议

0 条评论