mcpField
C
code-standards

code-standards

github.com/redpanda-data测试与质量4.3k61 次安装今天更新
代码仓库

关于 code-standards

面向开发者的编码规范 Skill，用于处理 lint、格式、代码审查反馈和风格问题，并提供规则指引及 Ultracite 检查与修复命令。

主要功能

  1. 01Lint 与格式规范
  2. 02React 组件及异步代码规则
  3. 03Biome 强制的类型与正则规则
  4. 04Ultracite 修复、检查和诊断命令
  5. 05生产代码控制台日志规范

适用场景

  1. 01修复代码库中的 lint 错误
  2. 02统一代码格式
  3. 03处理代码审查中的风格反馈

安装

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

$npx skills add https://github.com/redpanda-data/console --skill code-standards

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

包含的文件

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

rules/
async-await-promises.md
no-legacy.md
react-functional-only.md

详细介绍

代码规范

编写易于访问、性能出色、类型安全且易于维护的代码。

适用情形

  • 需要修复 Lint 错误
  • 代码格式问题
  • 代码审查反馈
  • 关于风格指南的问题

快速参考

操作规则
编写组件react-functional-only.md
异步代码async-await-promises.md
避免使用旧版库no-legacy.md

Biome 会检查 any 类型和顶层正则表达式（noExplicitAny、useTopLevelRegex）。

命令

bun x ultracite fix     # Format and fix
bun x ultracite check   # Check for issues
bun x ultracite doctor  # Diagnose setup

快速修复

大多数问题都可以自动修复：

bun x ultracite fix

控制台日志

  • 生产代码中绝不使用 console.log、console.debug 或 console.info
  • 仅使用 console.error 和 console.warn 记录需要采取行动的错误
  • 如需调试日志，请将其放在 if (IsDev) { ... } 中
  • 不要使用 biome-ignore 来屏蔽控制台警告，而应直接移除日志

规则

详细指南请参阅 rules/ 目录。

评论

支持 Markdown