工程开发
code-formatting avatar

code-formatting

使用 Biome 格式化并检查当前分支上的 JS、TS 和 JSON 文件。适用于提交或建立 PR 前的代码清理。

简介

code-formatting 技能提供了一种自动化解决方案,用于维护干净、一致且高效的代码库。该工具基于专为 Web 项目设计的高性能工具链 Biome,简化了检查和格式化源代码的流程。它的设计目的是直接在存储库环境中执行,确保代码风格在不同的开发人员和分支之间保持统一。

通过仅针对当前分支与基底分支(默认为 'main')相比已修改的文件进行处理,该工具优化了性能,避免了对整个代码库进行不必要的扫描。这使得它成为针对 JavaScript、TypeScript、JSX、TSX 和 JSON 文件的开发人员,在提交 (commit) 或推送 (push) 前进行清理的理想工具。它严格遵守存储库中 biome.jsonc 定义的配置,确保自动化更改符合既定的项目标准。

  • 自动识别并格式化已修改的 JS、TS、JSX、TSX 和 JSON 文件。

  • 支持自定义基底分支比较,以适应不同的开发工作流程(例如 develop 或 feature 分支)。

  • 直接与现有的 Biome 配置整合,以保持与 CI/CD 流水线的一致性。

  • 需要 Node.js 和 npx,提供轻量级的依赖占用。

  • 通过在代码审查前自动化 linting 和格式化流程,减少手动操作。

  • 在文件系统上进行原地操作 (in-place),实现即时反馈和快速迭代。

  • 确保开发环境中已安装 Node.js 以执行 npx 命令。

  • 请从存储库根目录执行脚本,以确保正确的路径解析。

  • 使用位于 .claude/skills/code-formatting/scripts/format-branch.sh 的脚本来触发格式化。

  • 对于自定义工作流程,请将目标基底分支作为参数传递给脚本。

  • 请注意,此工具目前专注于 biome-check.yml 工作流程中定义的代码格式化和 linting;它不是一个全面的静态分析或安全扫描工具。

仓库统计

Star 数
4,401
Fork 数
754
Open Issue 数
770
主要语言
TypeScript
默认分支
main
同步状态
空闲
最近同步时间
2026年4月29日 08:06
在 GitHub 查看