Agent Skills
› managedcode/dotnet-skills
› format
format
GitHub基于 .NET SDK 的 dotnet format 命令,用于格式化或验证 .NET 项目代码风格。支持依据 .editorconfig 进行空白、样式及分析器修复,提供 CI 门禁检查,并严格遵循仓库既定格式化工具所有权,避免冲突。
Trigger Scenarios
需要对 .NET 项目进行代码风格格式化
执行 CI 安全的代码格式校验
诊断格式化工具范围或加载失败问题
Install
npx skills add managedcode/dotnet-skills --skill format -g -y
SKILL.md
Frontmatter
{
"name": "format",
"description": "Format or verify trusted .NET projects with the SDK-provided `dotnet format` command. USE FOR: applying or checking `.editorconfig`-driven whitespace, code-style, or analyzer fixes; adding a `--verify-no-changes` CI gate; diagnosing formatter scope or load failures. DO NOT USE FOR: repositories where another formatter exclusively owns the affected files; analyzer policy with no formatter work; mutating files when the user requested only diagnosis."
}
dotnet format
Use the formatter already shipped with the selected .NET SDK. Preserve the repository's formatter ownership, existing changes, and configured style instead of introducing new preferences.
Workflow
- Read the nearest
AGENTS.md,global.json, solution/project files,.editorconfig, and current Git status. - Confirm the exact trusted workspace to load.
dotnet formatmay restore, compile, and run analyzers from that workspace. - Determine whether the request is read-only verification or permission to apply fixes. Do not run a mutating command for a review, explanation, or diagnosis request.
- Preserve the current diff before formatting. When scope is uncertain, begin with
--verify-no-changesor a narrow--includelist. - Choose the smallest formatter surface that matches the request:
whitespacefor indentation, spacing, and line-ending rules;stylefor built-in .NET code-style diagnostics;analyzersfor fixable non-style analyzer diagnostics;- the command without a subcommand only when all applicable surfaces are intended.
- Treat
--includeand--excludevalues as workspace-relative file or directory paths, not shell globs. Use--diagnosticsto narrow style or analyzer fixes by rule ID. - After a mutating run, inspect
git diff --stat, representative diffs, line endings, and every changed file. If scope is unexpectedly broad, stop and narrow the command; never discard pre-existing user changes. - Rerun the matching command with
--verify-no-changes. When analyzer fixes were applied, also build and run the tests relevant to the changed behavior.
Invariants
.editorconfigand existing MSBuild analyzer configuration are the source of truth. Do not add an arbitrary style template unless the user asks for one.- Use
--no-restoreonly after dependencies have already been restored successfully. - Generated files stay excluded unless the repository explicitly owns and formats them.
- A successful formatter process does not prove that every diagnostic has an automatic fix. Review its output or JSON report and use build/analyzer results as the final evidence.
- Keep formatter responsibilities explicit when CSharpier, ReSharper cleanup, generated-code tools, or other formatters coexist.
References
- Read references/commands.md for precise local, CI, filtering, and troubleshooting commands.
- Read references/config.md when changing
.editorconfig, analyzer severity, or formatter ownership.
Version History
-
6cd8621
Current 2026-09-03 08:02
重构技能结构,移除旧版 Ralph Loop 和 Bootstrap 逻辑,增强对 .editorconfig 和工作区范围的精确控制,明确只读与修改模式边界。
- 7ab7f03 2026-07-25 05:26


