code-format

代码格式化技能（入口地图）

目标： 指导 Agent 找到所需的准确格式化流程。

快速开始（请选择一项）

• .NET 代码格式化（C#） → references/dotnet-format.md
• JSON/YAML/Markdown 格式化 → references/prettier-format.md
• 格式化所有内容 → references/fix-all.md

适用场景

• 修复代码风格违规（缩进、空格、换行等）
• 一致地应用 .editorconfig 规则
• 为提交准备代码（pre-commit hook 格式化）
• 遵守团队编码标准
• 格式化特定文件或整个代码库

**不适用于：**构建（dotnet-build）、测试（dotnet-test）或 lint（code-analyze）

输入与输出

输入： target（dotnet/prettier/all）、files（特定文件或目录）、verify（仅检查模式）

**输出：**格式化后的文件（直接修改文件）、退出代码（0=成功，非零=存在违规）

**防护措施：**采用非破坏性方式（可使用 --verify-no-changes 在不进行更改的情况下检查）、遵循 .editorconfig、与 pre-commit 集成

导航

1. 格式化 .NET 代码 → references/dotnet-format.md

• 格式化 C# 文件（.cs）、应用 dotnet format 规则、修复代码风格问题

2. 使用 Prettier 格式化 → references/prettier-format.md

• 格式化 JSON、YAML、Markdown、JavaScript、TypeScript 文件

3. 格式化所有代码 → references/fix-all.md

• 依次运行所有格式化工具（dotnet + prettier），进行全面格式化

常见模式

快速格式化（.NET）

cd ./dotnet
dotnet format PigeonPea.sln

快速格式化（Prettier）

npx prettier --write "**/*.{json,yml,yaml,md}"

格式化所有内容

./.agent/skills/code-format/scripts/format-all.sh

仅验证（检查模式）

cd ./dotnet
dotnet format PigeonPea.sln --verify-no-changes

格式化特定文件

# .NET
dotnet format --include ./console-app/Program.cs

# Prettier
npx prettier --write ./README.md

故障排查

**格式化失败：**请检查错误消息。有关详细的错误处理，请查看相关参考文件。

**文件未格式化：**请检查 .editorconfig 规则、文件扩展名和 ignore 模式。

**Pre-commit hook 失败：**请先手动运行格式化工具，然后再提交。请参阅 references/fix-all.md。

样式冲突：.editorconfig 优先级最高。请检查配置文件。

**性能问题：**请针对特定项目或文件进行格式化，而不是整个解决方案。

成功标志

dotnet format

Format complete in X ms.

如果已完成格式化，则不会有文件更改；否则会显示已格式化文件的列表。

prettier

✔ Formatted X files

或者，如果所有文件都已完成格式化，则不会有输出。

集成

**提交前：**使用 pre-commit hook 自动格式化（在 .pre-commit-config.yaml 中配置） **手动格式化：**在推送代码、创建 PR 前运行 **CI/CD：**在 CI 中验证格式（使用 --verify-no-changes / --check 模式）

与其他 SKILL 配合使用：

• 上一步：code-analyze（先修复样式）
• 下一步：dotnet-build（构建整洁的代码）

配置文件

• .editorconfig：定义格式化规则（缩进大小、行尾符等）
• .prettierrc.json：Prettier 配置（打印宽度、引号等）
• .pre-commit-config.yaml：Pre-commit hook 配置
• .prettierignore：从 Prettier 格式化中排除的文件

相关内容

• .editorconfig - 格式化规则
• .prettierrc.json - Prettier 设置
• .pre-commit-config.yaml - Pre-commit hooks
• setup-pre-commit.sh - Pre-commit 设置脚本