Improve names of some existing options

Author: calda

Rules.md

@@ -306,12 +306,12 @@ Remove blank lines between consecutive guard statements, and insert a blank afte
 
 Option | Description
 --- | ---
-`--linebtwnguards` | Insert line between guards: "true" or "false" (default)
+`--linebetweenguards` | Insert line between guards: "true" or "false" (default)
 
 <details>
 <summary>Examples</summary>
 
-`--linebtwnguards false` (default)
+`--linebetweenguards false` (default)
 
 ```diff
     // Multiline guard
@@ -338,7 +338,7 @@ Option | Description
     let doTheJob = nikekov()
 ```
 
-`--linebtwnguards true`
+`--linebetweenguards true`
 
 ```diff
     // Multiline guard
@@ -621,7 +621,7 @@ Assign properties using if / switch expressions.
 
 Option | Description
 --- | ---
-`--condassignment` | Use cond. assignment: "after-property" (default) or "always"
+`--conditionalassignment` | Use if/switch expressions for conditional assignment: "after-property" (default) or "always"
 
 <details>
 <summary>Examples</summary>
@@ -766,7 +766,7 @@ Use doc comments for API declarations, otherwise use regular comments.
 
 Option | Description
 --- | ---
-`--doccomments` | Doc comments: "before-declarations" (default) or "preserve"
+`--doccomments` | Convert standard comments to doc comments: "before-declarations" (default) or "preserve"
 
 <details>
 <summary>Examples</summary>
@@ -1152,7 +1152,7 @@ instead of type constraints (`extension Array where Element == Foo`).
 
 Option | Description
 --- | ---
-`--generictypes` | Semicolon-delimited list of generic types and type parameters
+`--generictypes` | Semicolon-delimited list of generic types and type parameters. For example: "LinkedList<Element>;StateStore<State, Action>"
 
 <details>
 <summary>Examples</summary>
@@ -1606,14 +1606,14 @@ Option | Description
 `--structthreshold` | Minimum line count to organize struct body. Defaults to 0
 `--classthreshold` | Minimum line count to organize class body. Defaults to 0
 `--enumthreshold` | Minimum line count to organize enum body. Defaults to 0
-`--extensionlength` | Minimum line count to organize extension body. Defaults to 0
+`--extensionthreshold` | Minimum line count to organize extension body. Defaults to 0
 `--organizationmode` | Organize declarations by "visibility" (default) or "type"
 `--visibilityorder` | Order for visibility groups inside declaration
 `--typeorder` | Order for declaration type groups inside declaration
 `--visibilitymarks` | Marks for visibility groups (public:Public Fields,..)
 `--typemarks` | Marks for declaration type groups (classMethod:Baaz,..)
 `--groupblanklines` | Require a blank line after each subgroup. Default: true
-`--sortswiftuiprops` | Sort SwiftUI props: none, alphabetize, first-appearance-sort
+`--sortswiftuiproperties` | Sort SwiftUI props: "none", "alphabetize", "first-appearance-sort"
 
 <details>
 <summary>Examples</summary>
@@ -1762,8 +1762,8 @@ Convert functional `forEach` calls to for loops.
 
 Option | Description
 --- | ---
-`--anonymousforeach` | Convert anonymous forEach: "convert" (default) or "ignore"
-`--inlinedforeach` | Convert inline forEach to for: "convert", "ignore" (default)
+`--anonymousforeach` | Convert anonymous forEach closures to for loops: "convert" (default) or "ignore"
+`--singlelineforeach` | Convert single-line forEach closures to for loop: "convert", "ignore" (default)
 
 <details>
 <summary>Examples</summary>
@@ -1919,7 +1919,7 @@ Option | Description
 --- | ---
 `--propertytypes` | "inferred", "explicit", or "infer-locals-only" (default)
 `--inferredtypes` | "exclude-cond-exprs" (default) or "always"
-`--preservedsymbols` | Comma-delimited list of symbols to be ignored by the rule
+`--preservedpropertytypes` | Comma-delimited list of symbols to be ignored and preserved as-is by the propertyTypes rule
 
 <details>
 <summary>Examples</summary>
@@ -3427,10 +3427,10 @@ Option | Description
 --- | ---
 `--funcattributes` | Function @attributes: "preserve", "prev-line", or "same-line"
 `--typeattributes` | Type @attributes: "preserve", "prev-line", or "same-line"
-`--storedvarattrs` | Stored var @attribs: "preserve", "prev-line", or "same-line"
-`--computedvarattrs` | Computed var @attribs: "preserve", "prev-line", "same-line"
-`--complexattrs` | Complex @attributes: "preserve", "prev-line", or "same-line"
-`--noncomplexattrs` | List of @attributes to exclude from complexattrs rule
+`--storedvarattributes` | Stored var @attributes: "preserve", "prev-line", or "same-line"
+`--computedvarattributes` | Computed var @attributes: "preserve", "prev-line", "same-line"
+`--complexattributes` | Complex @attributes: "preserve", "prev-line", or "same-line"
+`--noncomplexattributes` | List of @attributes to exclude from --complexattributes options
 
 <details>
 <summary>Examples</summary>

Sources/OptionDescriptor.swift

@@ -93,7 +93,6 @@ class OptionDescriptor {
          trueValues: [String],
          falseValues: [String])
     {
-        assert(argumentName.count <= Options.maxArgumentNameLength)
         assert(argumentName == argumentName.lowercased())
         self.argumentName = argumentName
         self.displayName = displayName
@@ -968,7 +967,7 @@ struct _Descriptors {
         keyPath: \.organizeEnumThreshold
     )
     let organizeExtensionThreshold = OptionDescriptor(
-        argumentName: "extensionlength",
+        argumentName: "extensionthreshold",
         displayName: "Organize Extension Threshold",
         help: "Minimum line count to organize extension body. Defaults to 0",
         keyPath: \.organizeExtensionThreshold
@@ -1068,27 +1067,27 @@ struct _Descriptors {
         keyPath: \.typeAttributes
     )
     let storedVarAttributes = OptionDescriptor(
-        argumentName: "storedvarattrs",
+        argumentName: "storedvarattributes",
         displayName: "Stored Property Attributes",
-        help: "Stored var @attribs: \"preserve\", \"prev-line\", or \"same-line\"",
+        help: "Stored var @attributes: \"preserve\", \"prev-line\", or \"same-line\"",
         keyPath: \.storedVarAttributes
     )
     let computedVarAttributes = OptionDescriptor(
-        argumentName: "computedvarattrs",
+        argumentName: "computedvarattributes",
         displayName: "Computed Property Attributes",
-        help: "Computed var @attribs: \"preserve\", \"prev-line\", \"same-line\"",
+        help: "Computed var @attributes: \"preserve\", \"prev-line\", \"same-line\"",
         keyPath: \.computedVarAttributes
     )
     let complexAttributes = OptionDescriptor(
-        argumentName: "complexattrs",
+        argumentName: "complexattributes",
         displayName: "Complex Attributes",
         help: "Complex @attributes: \"preserve\", \"prev-line\", or \"same-line\"",
         keyPath: \.complexAttributes
     )
     let complexAttributesExceptions = OptionDescriptor(
-        argumentName: "noncomplexattrs",
+        argumentName: "noncomplexattributes",
         displayName: "Complex Attribute exceptions",
-        help: "List of @attributes to exclude from complexattrs rule",
+        help: "List of @attributes to exclude from --complexattributes options",
         keyPath: \.complexAttributesExceptions
     )
     let yodaSwap = OptionDescriptor(
@@ -1166,7 +1165,7 @@ struct _Descriptors {
     let genericTypes = OptionDescriptor(
         argumentName: "generictypes",
         displayName: "Additional generic types",
-        help: "Semicolon-delimited list of generic types and type parameters",
+        help: "Semicolon-delimited list of generic types and type parameters. For example: \"LinkedList<Element>;StateStore<State, Action>\"",
         keyPath: \.genericTypes,
         fromArgument: { $0 },
         toArgument: { $0 }
@@ -1182,31 +1181,31 @@ struct _Descriptors {
     let preserveAnonymousForEach = OptionDescriptor(
         argumentName: "anonymousforeach",
         displayName: "Anonymous forEach closures",
-        help: "Convert anonymous forEach: \"convert\" (default) or \"ignore\"",
+        help: "Convert anonymous forEach closures to for loops: \"convert\" (default) or \"ignore\"",
         keyPath: \.preserveAnonymousForEach,
         trueValues: ["ignore", "preserve"],
         falseValues: ["convert"]
     )
     let preserveSingleLineForEach = OptionDescriptor(
-        argumentName: "inlinedforeach",
-        displayName: "Inlined forEach closures",
-        help: "Convert inline forEach to for: \"convert\", \"ignore\" (default)",
+        argumentName: "singlelineforeach",
+        displayName: "Single-line forEach closures",
+        help: "Convert single-line forEach closures to for loop: \"convert\", \"ignore\" (default)",
         keyPath: \.preserveSingleLineForEach,
         trueValues: ["ignore", "preserve"],
         falseValues: ["convert"]
     )
     let preserveDocComments = OptionDescriptor(
         argumentName: "doccomments",
         displayName: "Doc comments",
-        help: "Doc comments: \"before-declarations\" (default) or \"preserve\"",
+        help: "Convert standard comments to doc comments: \"before-declarations\" (default) or \"preserve\"",
         keyPath: \.preserveDocComments,
         trueValues: ["preserve"],
         falseValues: ["before-declarations", "declarations"]
     )
     let conditionalAssignmentOnlyAfterNewProperties = OptionDescriptor(
-        argumentName: "condassignment",
+        argumentName: "conditionalassignment",
         displayName: "Apply conditionalAssignment rule",
-        help: "Use cond. assignment: \"after-property\" (default) or \"always\"",
+        help: "Use if/switch expressions for conditional assignment: \"after-property\" (default) or \"always\"",
         keyPath: \.conditionalAssignmentOnlyAfterNewProperties,
         trueValues: ["after-property"],
         falseValues: ["always"]
@@ -1247,11 +1246,11 @@ struct _Descriptors {
         help: "Comma separated list of declaration names to exclude",
         keyPath: \.preservedPrivateDeclarations
     )
-    let preservedSymbols = OptionDescriptor(
-        argumentName: "preservedsymbols",
-        displayName: "Preserved Symbols",
-        help: "Comma-delimited list of symbols to be ignored by the rule",
-        keyPath: \.preservedSymbols
+    let preservedPropertyTypes = OptionDescriptor(
+        argumentName: "preservedpropertytypes",
+        displayName: "Preserved Property Types",
+        help: "Comma-delimited list of symbols to be ignored and preserved as-is by the propertyTypes rule",
+        keyPath: \.preservedPropertyTypes
     )
     let additionalXCTestSymbols = OptionDescriptor(
         argumentName: "xctestsymbols",
@@ -1260,9 +1259,9 @@ struct _Descriptors {
         keyPath: \.additionalXCTestSymbols
     )
     let swiftUIPropertiesSortMode = OptionDescriptor(
-        argumentName: "sortswiftuiprops",
+        argumentName: "sortswiftuiproperties",
         displayName: "Sort SwiftUI Dynamic Properties",
-        help: "Sort SwiftUI props: none, alphabetize, first-appearance-sort",
+        help: "Sort SwiftUI props: \"none\", \"alphabetize\", \"first-appearance-sort\"",
         keyPath: \.swiftUIPropertiesSortMode
     )
     let equatableMacro = OptionDescriptor(
@@ -1280,7 +1279,7 @@ struct _Descriptors {
         falseValues: ["#fileID", "fileID"]
     )
     let lineBetweenConsecutiveGuards = OptionDescriptor(
-        argumentName: "linebtwnguards",
+        argumentName: "linebetweenguards",
         displayName: "Blank Line Between Consecutive Guards",
         help: "Insert line between guards: \"true\" or \"false\" (default)",
         keyPath: \.lineBetweenConsecutiveGuards,
@@ -1361,7 +1360,7 @@ struct _Descriptors {
         argumentName: "varattributes",
         displayName: "Var Attributes",
         help: "Property @attributes: \"preserve\", \"prev-line\", or \"same-line\"",
-        deprecationMessage: "Use with `--storedvarattrs` or `--computedvarattrs` instead.",
+        deprecationMessage: "Use with `--storedvarattributes` or `--computedvarattributes` instead.",
         keyPath: \.varAttributes
     )
 
@@ -1411,12 +1410,79 @@ struct _Descriptors {
         keyPath: \.preserveSingleLineForEach,
         trueValues: ["ignore", "preserve"],
         falseValues: ["convert"]
-    ).renamed(to: "inlinedforeach")
+    ).renamed(to: "singlelineforeach")
 
     let redundantType = OptionDescriptor(
         argumentName: "redundanttype",
         displayName: "Redundant Type",
         help: "deprecated",
         keyPath: \.propertyTypes
     ).renamed(to: "propertytypes")
+
+    let inlinedForEach = OptionDescriptor(
+        argumentName: "inlinedforeach",
+        displayName: "Inlined forEach closures",
+        help: "deprecated",
+        keyPath: \.preserveSingleLineForEach,
+        trueValues: ["ignore", "preserve"],
+        falseValues: ["convert"]
+    ).renamed(to: "singlelineforeach")
+
+    let condAssignment = OptionDescriptor(
+        argumentName: "condassignment",
+        displayName: "Apply conditionalAssignment rule",
+        help: "deprecated",
+        keyPath: \.conditionalAssignmentOnlyAfterNewProperties,
+        trueValues: ["after-property"],
+        falseValues: ["always"]
+    ).renamed(to: "conditionalassignment")
+
+    let storedVarAttrs = OptionDescriptor(
+        argumentName: "storedvarattrs",
+        displayName: "Stored Property Attributes",
+        help: "deprecated",
+        keyPath: \.storedVarAttributes
+    ).renamed(to: "storedvarattributes")
+
+    let computedVarAttrs = OptionDescriptor(
+        argumentName: "computedvarattrs",
+        displayName: "Computed Property Attributes",
+        help: "deprecated",
+        keyPath: \.computedVarAttributes
+    ).renamed(to: "computedvarattributes")
+
+    let complexAttrs = OptionDescriptor(
+        argumentName: "complexattrs",
+        displayName: "Complex Attributes",
+        help: "deprecated",
+        keyPath: \.complexAttributes
+    ).renamed(to: "complexattributes")
+
+    let complexAttrsExceptions = OptionDescriptor(
+        argumentName: "noncomplexattrs",
+        displayName: "Complex Attribute exceptions",
+        help: "deprecated",
+        keyPath: \.complexAttributesExceptions
+    ).renamed(to: "noncomplexattributes")
+
+    let preservedSymbols = OptionDescriptor(
+        argumentName: "preservedsymbols",
+        displayName: "Preserved Symbols",
+        help: "deprecated",
+        keyPath: \.preservedPropertyTypes
+    ).renamed(to: "preservedpropertytypes")
+
+    let swiftUIPropsSortMode = OptionDescriptor(
+        argumentName: "sortswiftuiprops",
+        displayName: "Sort SwiftUI Dynamic Properties",
+        help: "deprecated",
+        keyPath: \.swiftUIPropertiesSortMode
+    ).renamed(to: "sortswiftuiproperties")
+
+    let organizeExtensionLength = OptionDescriptor(
+        argumentName: "extensionlength",
+        displayName: "Organize Extension Threshold",
+        help: "deprecated",
+        keyPath: \.organizeExtensionThreshold
+    ).renamed(to: "extensionthreshold")
 }

Sources/Options.swift

@@ -723,7 +723,7 @@ public struct FormatOptions: CustomStringConvertible {
     public var yodaSwap: YodaMode
     public var extensionACLPlacement: ExtensionACLPlacement
     public var propertyTypes: PropertyTypes
-    public var preservedSymbols: Set<String>
+    public var preservedPropertyTypes: Set<String>
     public var inferredTypesInConditionalExpressions: Bool
     public var emptyBracesSpacing: EmptyBracesSpacing
     public var acronyms: Set<String>
@@ -855,7 +855,7 @@ public struct FormatOptions: CustomStringConvertible {
                 yodaSwap: YodaMode = .always,
                 extensionACLPlacement: ExtensionACLPlacement = .onExtension,
                 propertyTypes: PropertyTypes = .inferLocalsOnly,
-                preservedSymbols: Set<String> = ["Package"],
+                preservedPropertyTypes: Set<String> = ["Package"],
                 inferredTypesInConditionalExpressions: Bool = false,
                 emptyBracesSpacing: EmptyBracesSpacing = .noSpace,
                 acronyms: Set<String> = ["ID", "URL", "UUID"],
@@ -977,7 +977,7 @@ public struct FormatOptions: CustomStringConvertible {
         self.yodaSwap = yodaSwap
         self.extensionACLPlacement = extensionACLPlacement
         self.propertyTypes = propertyTypes
-        self.preservedSymbols = preservedSymbols
+        self.preservedPropertyTypes = preservedPropertyTypes
         self.inferredTypesInConditionalExpressions = inferredTypesInConditionalExpressions
         self.emptyBracesSpacing = emptyBracesSpacing
         self.acronyms = acronyms

Sources/Rules/BlankLinesAfterGuardStatements.swift

@@ -7,7 +7,7 @@ public extension FormatRule {
     static let blankLinesAfterGuardStatements = FormatRule(
         help: "Remove blank lines between consecutive guard statements, and insert a blank after the last guard statement.",
         disabledByDefault: true,
-        options: ["linebtwnguards"]
+        options: ["linebetweenguards"]
     ) { formatter in
         formatter.forEach(.keyword("guard")) { guardIndex, _ in
             guard var elseIndex = formatter.index(of: .keyword("else"), after: guardIndex) else {
@@ -47,7 +47,7 @@ public extension FormatRule {
         }
     } examples: {
         """
-        `--linebtwnguards false` (default)
+        `--linebetweenguards false` (default)
 
         ```diff
             // Multiline guard
@@ -74,7 +74,7 @@ public extension FormatRule {
             let doTheJob = nikekov()
         ```
 
-        `--linebtwnguards true`
+        `--linebetweenguards true`
 
         ```diff
             // Multiline guard

Sources/Rules/ConditionalAssignment.swift

@@ -12,7 +12,7 @@ public extension FormatRule {
     static let conditionalAssignment = FormatRule(
         help: "Assign properties using if / switch expressions.",
         orderAfter: [.redundantReturn],
-        options: ["condassignment"]
+        options: ["conditionalassignment"]
     ) { formatter in
         // If / switch expressions were added in Swift 5.9 (SE-0380)
         guard formatter.options.swiftVersion >= "5.9" else {