工程開發
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 查看