Merge pull request #583 from allevato/improve-diagnostics

Improve a bunch of diagnostic messages.

Author: allevato

Sources/SwiftFormatRules/AlwaysUseLowerCamelCase.swift

@@ -217,6 +217,6 @@ extension Finding.Message {
   public static func nameMustBeLowerCamelCase(
     _ name: String, description: String
   ) -> Finding.Message {
-    "rename \(description) '\(name)' using lower-camel-case"
+    "rename the \(description) '\(name)' using lowerCamelCase"
   }
 }

Sources/SwiftFormatRules/AmbiguousTrailingClosureOverload.swift

@@ -74,7 +74,7 @@ public final class AmbiguousTrailingClosureOverload: SyntaxLintRule {
 
 extension Finding.Message {
   public static func ambiguousTrailingClosureOverload(_ decl: String) -> Finding.Message {
-    "rename '\(decl)' so it is no longer ambiguous with a trailing closure"
+    "rename '\(decl)' so it is no longer ambiguous when called with a trailing closure"
   }
 
   public static func otherAmbiguousOverloadHere(_ decl: String) -> Finding.Message {

Sources/SwiftFormatRules/DontRepeatTypeInStaticProperties.swift

@@ -104,6 +104,6 @@ public final class DontRepeatTypeInStaticProperties: SyntaxLintRule {
 
 extension Finding.Message {
   public static func removeTypeFromName(name: String, type: Substring) -> Finding.Message {
-    "remove '\(type)' from '\(name)'"
+    "remove the suffix '\(type)' from the name of the variable '\(name)'"
   }
 }

Sources/SwiftFormatRules/FullyIndirectEnum.swift

@@ -109,6 +109,6 @@ public final class FullyIndirectEnum: SyntaxFormatRule {
 
 extension Finding.Message {
   public static func moveIndirectKeywordToEnumDecl(name: String) -> Finding.Message {
-    "move 'indirect' to \(name) enum declaration when all cases are indirect"
+    "move 'indirect' before the enum declaration '\(name)' when all cases are indirect"
   }
 }

Sources/SwiftFormatRules/NeverUseImplicitlyUnwrappedOptionals.swift

@@ -65,6 +65,6 @@ public final class NeverUseImplicitlyUnwrappedOptionals: SyntaxLintRule {
 
 extension Finding.Message {
   public static func doNotUseImplicitUnwrapping(identifier: String) -> Finding.Message {
-    "use \(identifier) or \(identifier)? instead of \(identifier)!"
+    "use '\(identifier)' or '\(identifier)?' instead of '\(identifier)!'"
   }
 }

Sources/SwiftFormatRules/NoAccessLevelOnExtensionDeclaration.swift

@@ -102,10 +102,10 @@ public final class NoAccessLevelOnExtensionDeclaration: SyntaxFormatRule {
 
 extension Finding.Message {
   public static func removeRedundantAccessKeyword(name: String) -> Finding.Message {
-    "remove redundant 'internal' access keyword from \(name)"
+    "remove redundant 'internal' access keyword from '\(name)'"
   }
 
   public static func moveAccessKeyword(keyword: String) -> Finding.Message {
-    "specify \(keyword) access level for each member inside the extension"
+    "move the '\(keyword)' access keyword to precede each member inside the extension"
   }
 }

Sources/SwiftFormatRules/NoAssignmentInExpressions.swift

@@ -163,5 +163,5 @@ public final class NoAssignmentInExpressions: SyntaxFormatRule {
 
 extension Finding.Message {
   public static let moveAssignmentToOwnStatement: Finding.Message =
-    "move assignment expression into its own statement"
+    "move this assignment expression into its own statement"
 }

Sources/SwiftFormatRules/NoBlockComments.swift

@@ -30,5 +30,5 @@ public final class NoBlockComments: SyntaxLintRule {
 
 extension Finding.Message {
   public static let avoidBlockComment: Finding.Message =
-    "replace block comment with line comments"
+    "replace this block comment with line comments"
 }

Sources/SwiftFormatRules/NoCasesWithOnlyFallthrough.swift

@@ -183,7 +183,7 @@ public final class NoCasesWithOnlyFallthrough: SyntaxFormatRule {
       // Diagnose the cases being collapsed. We do this for all but the last one in the array; the
       // last one isn't diagnosed because it will contain the body that applies to all the previous
       // cases.
-      diagnose(.collapseCase(name: label.caseItems.with(\.leadingTrivia, []).with(\.trailingTrivia, []).description), on: label)
+      diagnose(.collapseCase, on: label)
     }
     newCaseItems.append(contentsOf: labels.last!.caseItems)
 
@@ -219,7 +219,7 @@ extension TriviaPiece {
 }
 
 extension Finding.Message {
-  public static func collapseCase(name: String) -> Finding.Message {
-    "combine fallthrough-only case \(name) with a following case"
+  public static var collapseCase: Finding.Message {
+    "combine this fallthrough-only 'case' and the following 'case' into a single 'case'"
   }
 }

Sources/SwiftFormatRules/NoEmptyTrailingClosureParentheses.swift

@@ -53,6 +53,6 @@ public final class NoEmptyTrailingClosureParentheses: SyntaxFormatRule {
 
 extension Finding.Message {
   public static func removeEmptyTrailingParentheses(name: String) -> Finding.Message {
-    "remove '()' after \(name)"
+    "remove the empty parentheses following '\(name)'"
   }
 }