Back to Details

code-format

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Code Format Skill (Entry Map)

代码格式化Skill（入口指南）

Goal: 에이전트가 필요한 정확한 포맷팅 절차를 찾을 수 있도록 가이드합니다.
目标： 引导Agent找到所需的准确格式化流程。

Quick Start (하나를 선택하세요)

快速开始（请选择其中一项）

  • .NET 코드 포맷팅 (C#) → 
    references/dotnet-format.md
  • JSON/YAML/Markdown 포맷팅 → 
    references/prettier-format.md
  • 모든 항목 포맷팅 → 
    references/fix-all.md
  • .NET代码格式化（C#） → 
    references/dotnet-format.md
  • JSON/YAML/Markdown格式化 → 
    references/prettier-format.md
  • 全量格式化 → 
    references/fix-all.md

When to Use

适用场景

  • 코드 스타일 위반 수정 (들여쓰기, 공백, 줄 바꿈 등)
  • .editorconfig 규칙을 일관되게 적용
  • 커밋을 위한 코드 준비 (pre-commit hook 포맷팅)
  • 팀 코딩 표준 준수
  • 특정 파일 또는 전체 코드베이스 포맷팅
다음을 위한 것이 아님: 빌드 (dotnet-build), 테스트 (dotnet-test), 또는 린팅 (code-analyze)
  • 修复代码风格违规问题（缩进、空格、换行等）
  • 统一应用.editorconfig规则
  • 为提交代码做准备（pre-commit hook格式化）
  • 遵循团队编码标准
  • 格式化特定文件或整个代码库
不适用于： 构建（dotnet-build）、测试（dotnet-test）或代码分析（code-analyze）

Inputs & Outputs

输入与输出

Inputs: 
target
(dotnet/prettier/all), 
files
(특정 파일 또는 디렉토리), 
verify
(체크 전용 모드)
Outputs: 포맷팅된 파일 (파일 내에서 직접 수정), exit code (0=success, non-zero=violations)
Guardrails: 비파괴적 방식 (변경 없이 확인하는 --verify-no-changes 가능), .editorconfig 존중, pre-commit과 통합
输入： 
target
（dotnet/prettier/all）、
files
（特定文件或目录）、
verify
（仅检查模式）
输出： 已格式化的文件（直接在文件内修改）、退出码（0=成功，非0=存在违规）
防护机制： 非破坏性方式（支持--verify-no-changes参数仅检查不修改）、遵循.editorconfig配置、与pre-commit集成

Navigation

导航

1. Format .NET Code → 
references/dotnet-format.md
  • C# 파일(.cs) 포맷팅, dotnet format 규칙 적용, 코드 스타일 이슈 수정
2. Format with Prettier → 
references/prettier-format.md
  • JSON, YAML, Markdown, JavaScript, TypeScript 파일 포맷팅
3. Format All Code → 
references/fix-all.md
  • 모든 포맷터(dotnet + prettier)를 순차적으로 실행, 포괄적인 포맷팅 수행
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），完成全面格式化

Common Patterns

常见用法示例

Quick Format (.NET)

快速格式化（.NET）

bash
cd ./dotnet
dotnet format PigeonPea.sln
bash
cd ./dotnet
dotnet format PigeonPea.sln

Quick Format (Prettier)

快速格式化（Prettier）

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

Format Everything

全量格式化

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

Verify Only (체크 모드)

仅检查模式

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

특정 파일 포맷팅

格式化特定文件

bash
undefined
bash
undefined

.NET

.NET

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

Prettier

Prettier

npx prettier --write ./README.md
undefined
npx prettier --write ./README.md
undefined

Troubleshooting

故障排查

포맷팅 실패: 에러 메시지를 확인하십시오. 상세한 에러 처리는 관련 참조 파일을 확인하세요.
파일이 포맷팅되지 않음: .editorconfig 규칙, 파일 확장자, ignore 패턴을 확인하십시오.
Pre-commit hook 실패: 먼저 포맷터를 수동으로 실행한 후 커밋하십시오. 
references/fix-all.md
를 참조하세요.
스타일 충돌: .editorconfig가 우선순위를 가집니다. 구성 파일을 확인하십시오.
성능 이슈: 전체 솔루션 대신 특정 프로젝트나 파일에 대해 포맷팅을 수행하십시오.
格式化失败： 请查看错误信息。详细的错误处理请参考相关文档文件。
文件未被格式化： 请检查.editorconfig规则、文件扩展名、忽略模式。
Pre-commit hook执行失败： 请先手动运行格式化工具，再提交代码。参考
references/fix-all.md
。
风格冲突： .editorconfig拥有最高优先级，请检查配置文件。
性能问题： 请针对特定项目或文件执行格式化，而非整个解决方案。
成功标识

Success Indicators

dotnet format

dotnet format

—
Format complete in X ms.
이미 포맷팅된 경우 변경된 파일이 없거나, 포맷팅된 파일 목록이 표시됩니다.
Format complete in X ms.
如果文件已格式化，则显示无修改文件，或列出已格式化的文件。

prettier

prettier

✔ Formatted X files
또는 모든 파일이 이미 포맷팅된 경우 출력이 없습니다.
✔ Formatted X files
或者如果所有文件已格式化，则无输出。

Integration

集成方式

커밋 전: pre-commit hook을 사용하여 자동 포맷팅(
.pre-commit-config.yaml
에 구성됨) 수동 포맷팅: 코드 푸시 전, PR 생성 전 실행 CI/CD: CI에서 포맷팅 검증 (--verify-no-changes / --check 모드 사용)
다른 SKILL과 함께 사용:
  • 이전 단계: code-analyze (스타일 먼저 수정)
  • 다음 단계: dotnet-build (깔끔한 코드 빌드)
提交前： 使用pre-commit hook自动格式化（配置在
.pre-commit-config.yaml
中） 手动格式化： 在推送代码、创建PR前执行 CI/CD： 在CI中进行格式化验证（使用--verify-no-changes / --check模式）
与其他Skill配合使用：
  • 前置步骤：code-analyze（先修复风格问题）
  • 后续步骤：dotnet-build（构建整洁代码）

Configuration Files

配置文件

  • .editorconfig
    : 포맷팅 규칙 정의 (indent size, line endings 등)
  • .prettierrc.json
    : Prettier 구성 (print width, quotes 등)
  • .pre-commit-config.yaml
    : Pre-commit hook 구성
  • .prettierignore
    : Prettier 포맷팅에서 제외할 파일
  • .editorconfig
    ：定义格式化规则（缩进大小、行尾格式等）
  • .prettierrc.json
    ：Prettier配置（打印宽度、引号规则等）
  • .pre-commit-config.yaml
    ：Pre-commit hook配置
  • .prettierignore
    ：Prettier格式化需排除的文件

Related

相关资源

  • .editorconfig
     - 포맷팅 규칙
  • .prettierrc.json
     - Prettier 설정
  • .pre-commit-config.yaml
     - Pre-commit hooks
  • setup-pre-commit.sh
     - Pre-commit 설정 스크립트
  • .editorconfig
     - 格式化规则
  • .prettierrc.json
     - Prettier配置
  • .pre-commit-config.yaml
     - Pre-commit钩子
  • setup-pre-commit.sh
     - Pre-commit设置脚本