CSharpier 格式化工具中集合表达式的缩进问题分析

背景介绍

CSharpier 是一个流行的 C# 代码格式化工具，它帮助开发者自动保持代码风格的一致性。在最新版本中，开发者发现了一个关于集合表达式缩进格式的问题，值得深入探讨。

问题描述

在 C# 12 中引入的集合表达式语法（使用方括号 []）在格式化时出现了不一致的缩进行为。当集合表达式跨越多行时，CSharpier 会额外添加一层缩进，这与对象初始化器的格式化风格不匹配。

技术细节分析

当前格式化行为

当前版本的 CSharpier 对多行集合表达式的处理方式如下：

internal static List<string> Urls { get; } =
    [
        "https://google.com",
        "https://bing.com",
        // 更多元素...
    ];

可以看到，整个集合表达式相对于属性声明多了一层缩进。

期望的格式化行为

开发者期望的格式化方式应该与对象初始化器保持一致：

internal static List<string> Urls { get; } =
[
    "https://google.com",
    "https://bing.com",
    // 更多元素...
];

这种格式更符合 C# 社区中常见的代码风格约定。

解决方案与实现

CSharpier 维护者已经确认这是一个需要修复的问题，并计划使其行为与对象初始化器的格式化保持一致。这种改变将使代码风格更加统一，特别是当代码中同时包含集合表达式和对象初始化器时。

对其他情况的影响

值得注意的是，对于单行或较短集合表达式的情况，CSharpier 的处理方式已经符合预期：

// 单行短集合表达式
internal static List<string> Urls { get; } = ["url1", "url2"];

// 单行较长集合表达式
internal static List<string> Urls { get; } =
    ["url1", "url2", "url3", "url4"];

这些情况不需要任何改变，因为它们已经采用了合理的格式化方式。

结论

代码格式化工具的规则需要不断演进以适应语言特性的发展。CSharpier 对集合表达式缩进规则的调整体现了工具维护者对代码风格一致性的重视。这一改变将使 C# 代码在各种初始化表达式之间保持一致的视觉风格，提高代码的可读性和维护性。