swiftformat.yaml字段释义

swiftformat.yaml 文件是用来配置 SwiftFormat 的格式化规则和选项。以下是各个字段的详细说明：

Rules (规则)

1. blankLinesAroundMark: 在标记（如 #pragma mark）前后添加空行。
2. blankLinesAtEndOfScope: 在作用域末尾添加空行。
3. blankLinesAtStartOfScope: 在作用域开始处添加空行。
4. blankLinesBetweenScopes: 在不同作用域之间添加空行。
5. braces: 控制大括号的位置，通常是开括号与语句在同一行。
6. consecutiveBlankLines: 限制连续空行的数量。
7. consecutiveSpaces: 限制连续空格的数量。
8. duplicateImports: 检查并移除重复的导入语句。
9. elseOnSameLine: 控制 else 语句是否在同一行。
10. fileHeader: 添加文件头注释。
11. hoistPatternLet: 提升使用 let 定义的模式。
12. indent: 控制代码缩进的空格数（在此为 2）。
13. linebreakAtEndOfFile: 确保文件末尾有一个换行符。
14. linebreaks: 控制使用的换行符类型（如 LF）。
15. numberFormatting: 控制数字的格式化规则。
16. redundantBackticks: 移除冗余的反引号。
17. redundantGet: 移除冗余的 get 关键字。
18. redundantInit: 移除冗余的构造函数声明。
19. redundantLet: 移除冗余的 let 声明。
20. redundantNilInit: 移除冗余的 nil 初始化。
21. redundantParens: 移除冗余的括号。
22. redundantPattern: 移除冗余的模式匹配。
23. redundantRawValues: 移除冗余的原始值。
24. redundantReturn: 移除冗余的返回语句。
25. redundantSelf: 移除冗余的 self 引用。
26. redundantVoidReturnType: 移除冗余的 Void 返回类型。
27. semicolons: 控制分号的使用（如是否允许）。
28. sortedImports: 对导入语句进行排序。
29. spaceAroundBraces: 控制大括号周围的空格。
30. spaceAroundBrackets: 控制方括号周围的空格。
31. spaceAroundComments: 控制注释周围的空格。
32. spaceAroundGenerics: 控制泛型类型周围的空格。
33. spaceAroundOperators: 控制运算符周围的空格。
34. spaceAroundParens: 控制括号周围的空格。
35. spaceInsideBraces: 控制大括号内部的空格。
36. spaceInsideBrackets: 控制方括号内部的空格。
37. spaceInsideComments: 控制注释内部的空格。
38. spaceInsideGenerics: 控制泛型类型内部的空格。
39. spaceInsideParens: 控制括号内部的空格。
40. specifiers: 控制修饰符的格式。
41. strongOutlets: 强制使用强引用的 Outlet。
42. todos: 控制 TODO 注释的格式。
43. trailingCommas: 控制尾随逗号的使用。
44. trailingSpace: 移除行末的空格。
45. unusedArguments: 检查并移除未使用的函数参数。
46. void: 控制 Void 类型的使用。
47. wrapArguments: 控制函数参数的换行方式。

Options (选项)

1. allman: 是否使用 Allman 风格（大括号在新行）。
2. binarygrouping: 控制二进制数字的分组（如无分组）。
3. commas: 控制逗号的使用（在此始终使用）。
4. decimalgrouping: 控制十进制数字的分组（如无分组）。
5. elseposition: 控制 else 语句位置（这里为同一行）。
6. exponentcase: 控制科学计数法中的字母大小写（小写）。
7. header: 控制文件头的处理方式（忽略）。
8. hexgrouping: 控制十六进制数字的分组（如无分组）。
9. hexliteralcase: 控制十六进制文字的字母大小写（大写）。
10. ifdef: 控制条件编译指令的缩进（在此为缩进）。
11. indent: 设置缩进的空格数（在此为 2）。
12. indentcase: 控制 case 语句的缩进。
13. linebreaks: 设置换行符的类型（在此为 LF）。
14. octalgrouping: 控制八进制数字的分组（如无分组）。
15. operatorfunc: 控制运算符函数的空格（有空格）。
16. patternlet: 控制 let 定义的模式的处理方式（在此为提升）。
17. ranges: 控制范围的空格（有空格）。
18. self: 控制 self 的处理方式（移除）。
19. semicolons: 控制分号的使用（内联）。
20. stripunusedargs: 处理未使用参数的方式（仅在闭包中）。
21. trimwhitespace: 控制是否去除多余的空白（总是）。
22. voidtype: 控制 Void 类型的使用（在此为 void）。
23. wraparguments: 控制函数参数的换行（禁用）。
24. wrapcollections: 控制集合的换行（禁用）。

总结

这个配置文件定义了 SwiftFormat 在格式化 Swift 代码时所遵循的具体规则和选项，从而帮助保持代码的一致性和可读性。根据团队的需求和个人偏好，可以调整这些规则和选项。