【开源项目】CSharpier - 受 Prettier 启发的 C# 代码格式化工具

[gaufung]

GitHub C# 趋势项目，一款固执己见（opinionated）的 C# 代码格式化器。

[gaufung]

原文链接：https://github.com/belav/csharpier

[gaufung]

CSharpier - 受 Prettier 启发的 C# 代码格式化工具

项目简介

CSharpier 是一款受 JavaScript 生态中 Prettier 启发的 C# 代码格式化工具。它采用"固执己见"（opinionated）的设计理念——尽量减少可配置项，让团队不再为代码格式争论，把精力放在真正重要的事情上。项目目前在 GitHub C# 趋势榜上活跃。

核心特点

1. 基于 Roslyn 解析：使用 Roslyn 编译器平台解析 C# 代码为语法树，确保格式化不会改变代码语义，100% 安全。

2. 最小化配置：核心配置项只有打印宽度（printWidth，默认100）和缩进风格（tab/space）。不纠结大括号换行位置、空行数量等细节，让工具替你决定。

3. CI/CD 友好：支持 --check 模式用于 CI 检查，格式不符则返回非零退出码。

4. 广泛的编辑器集成：

   • Visual Studio 扩展
   • VS Code 扩展
   • JetBrains Rider 插件
   • Neovim 支持

5. dotnet tool 分发：通过标准的 .NET 工具链安装和使用。

使用示例

# 安装为全局工具
dotnet tool install csharpier -g

# 格式化当前目录下所有 C# 文件
dotnet csharpier .

# CI 检查模式
dotnet csharpier --check .

# 安装为项目本地工具（推荐）
dotnet tool install csharpier
dotnet csharpier .

格式化前后对比：

// 格式化前
public void MyMethod(string longParameterName, string anotherLongParameter, int yetAnotherParameter) { Console.WriteLine("Hello"); }

// 格式化后
public void MyMethod(
    string longParameterName,
    string anotherLongParameter,
    int yetAnotherParameter
)
{
    Console.WriteLine("Hello");
}

意义

代码格式化工具在团队协作中至关重要。JavaScript/TypeScript 生态有 Prettier，Go 有 gofmt，Rust 有 rustfmt，而 CSharpier 正在填补 C# 生态中这个重要空缺。与传统的 EditorConfig + StyleCop 方案相比，CSharpier 更加简洁高效，特别适合追求一致代码风格的团队。结合 Git pre-commit hook 或 CI 流程使用，可以彻底消除代码评审中的格式讨论。