Merge branch 'main' into jgrubb-redundant-type-interfaces

Author: SimplyDanny

CHANGELOG.md

@@ -24,10 +24,15 @@
 * The `redundant_type_annotation` rule gains a new option,
   `ignore_properties`, that skips enforcement on members in a
   type declaration (like a `struct`). This helps the rule coexist with
-  the `explicit_type_interface` rule that requires such redundancy.
+  the `explicit_type_interface` rule that requires such redundancy.  
   [jaredgrubb](https://github.com/jaredgrubb)
   [#3750](https://github.com/realm/SwiftLint/issues/3750)
 
+* Adds a `lenient` configuration file setting, equivalent to the `--lenient`
+  command line option.  
+  [Martin Redington](https://github.com/mildm8nnered)
+  [#5801](https://github.com/realm/SwiftLint/issues/5801)
+
 #### Bug Fixes
 
 * Run command plugin in whole package if no targets are defined in the
@@ -46,6 +51,11 @@
   [SimplyDanny](https://github.com/SimplyDanny)
   [#5167](https://github.com/realm/SwiftLint/issues/5167)
 
+* Only pass cache path and directory paths to commands that accept these arguments
+  in the command plugin.  
+  [SimplyDanny](https://github.com/SimplyDanny)
+  [#5848](https://github.com/realm/SwiftLint/issues/5848)
+
 * Do not throw deprecation warning if deprecated property is not
   presented in configuration.  
   [chipp](https://github.com/chipp)

Gemfile.lock

@@ -122,8 +122,7 @@ GEM
     public_suffix (4.0.7)
     rchardet (1.8.0)
     redcarpet (3.6.0)
-    rexml (3.3.6)
-      strscan
+    rexml (3.3.9)
     rouge (4.3.0)
     ruby-macho (2.5.1)
     ruby2_keywords (0.0.5)
@@ -134,7 +133,6 @@ GEM
       faraday (>= 0.17.3, < 3)
     sqlite3 (1.7.3-arm64-darwin)
     sqlite3 (1.7.3-x86_64-linux)
-    strscan (3.1.0)
     terminal-table (3.0.2)
       unicode-display_width (>= 1.1.1, < 3)
     typhoeus (1.4.0)

Plugins/SwiftLintCommandPlugin/SwiftLintCommandPlugin.swift

@@ -1,6 +1,19 @@
 import Foundation
 import PackagePlugin
 
+private let commandsNotExpectingPaths: Set<String> = [
+    "docs",
+    "generate-docs",
+    "baseline",
+    "reporters",
+    "rules",
+    "version",
+]
+
+private let commandsWithoutCachPathOption: Set<String> = commandsNotExpectingPaths.union([
+    "analyze",
+])
+
 @main
 struct SwiftLintCommandPlugin: CommandPlugin {
     func performCommand(context: PluginContext, arguments: [String]) throws {
@@ -13,7 +26,7 @@ struct SwiftLintCommandPlugin: CommandPlugin {
         let targets = targetNames.isEmpty
             ? context.package.targets
             : try context.package.targets(named: targetNames)
-        guard !targets.isEmpty else {
+        if targets.isEmpty || !commandsNotExpectingPaths.isDisjoint(with: arguments) {
             try run(with: context, arguments: arguments)
             return
         }
@@ -34,11 +47,12 @@ struct SwiftLintCommandPlugin: CommandPlugin {
         process.currentDirectoryURL = URL(fileURLWithPath: context.package.directory.string)
         process.executableURL = URL(fileURLWithPath: try context.tool(named: "swiftlint").path.string)
         process.arguments = arguments
-        if !arguments.contains("analyze") {
-            // The analyze command does not support the `--cache-path` argument.
+        if commandsWithoutCachPathOption.isDisjoint(with: arguments) {
             process.arguments! += ["--cache-path", "\(context.pluginWorkDirectory.string)"]
         }
-        process.arguments! += [directory]
+        if commandsNotExpectingPaths.isDisjoint(with: arguments) {
+            process.arguments! += [directory]
+        }
 
         try process.run()
         process.waitUntilExit()

README.md

@@ -723,6 +723,9 @@ allow_zero_lintable_files: false
 # If true, SwiftLint will treat all warnings as errors.
 strict: false
 
+# If true, SwiftLint will treat all errors as warnings.
+lenient: false
+
 # The path to a baseline file, which will be used to filter out detected violations.
 baseline: Baseline.json
 

Source/SwiftLintBuiltInRules/Rules/Lint/CaptureVariableRule.swift

@@ -264,7 +264,7 @@ private extension SwiftLintFile {
             let path = self.path,
             let response = try? Request.index(file: path, arguments: compilerArguments).sendIfNotDisabled()
         else {
-            Issue.indexingError(path: path, ruleID: CaptureVariableRule.description.identifier).print()
+            Issue.indexingError(path: path, ruleID: CaptureVariableRule.identifier).print()
             return nil
         }
 

Source/SwiftLintBuiltInRules/Rules/Lint/InertDeferRule.swift

@@ -2,7 +2,7 @@ import SwiftSyntax
 
 // TODO: [12/23/2024] Remove deprecation warning after ~2 years.
 private let warnDeprecatedOnceImpl: Void = {
-    Issue.ruleDeprecated(ruleID: InertDeferRule.description.identifier).print()
+    Issue.ruleDeprecated(ruleID: InertDeferRule.identifier).print()
 }()
 
 private func warnDeprecatedOnce() {

Source/SwiftLintBuiltInRules/Rules/Lint/TypesafeArrayInitRule.swift

@@ -67,7 +67,7 @@ struct TypesafeArrayInitRule: AnalyzerRule {
             return []
         }
         guard compilerArguments.isNotEmpty else {
-            Issue.missingCompilerArguments(path: file.path, ruleID: Self.description.identifier).print()
+            Issue.missingCompilerArguments(path: file.path, ruleID: Self.identifier).print()
             return []
         }
         return Self.parentRule.validate(file: file)

Source/SwiftLintBuiltInRules/Rules/Lint/UnusedCaptureListRule.swift

@@ -2,7 +2,7 @@ import SwiftSyntax
 
 // TODO: [12/22/2024] Remove deprecation warning after ~2 years.
 private let warnDeprecatedOnceImpl: Void = {
-    Issue.ruleDeprecated(ruleID: UnusedCaptureListRule.description.identifier).print()
+    Issue.ruleDeprecated(ruleID: UnusedCaptureListRule.identifier).print()
 }()
 
 private func warnDeprecatedOnce() {

Source/SwiftLintBuiltInRules/Rules/Lint/UnusedDeclarationRule.swift

@@ -30,18 +30,18 @@ struct UnusedDeclarationRule: AnalyzerRule, CollectingRule {
 
     func collectInfo(for file: SwiftLintFile, compilerArguments: [String]) -> Self.FileUSRs {
         guard compilerArguments.isNotEmpty else {
-            Issue.missingCompilerArguments(path: file.path, ruleID: Self.description.identifier).print()
+            Issue.missingCompilerArguments(path: file.path, ruleID: Self.identifier).print()
             return .empty
         }
 
         guard let index = file.index(compilerArguments: compilerArguments), index.value.isNotEmpty else {
-            Issue.indexingError(path: file.path, ruleID: Self.description.identifier).print()
+            Issue.indexingError(path: file.path, ruleID: Self.identifier).print()
             return .empty
         }
 
         guard let editorOpen = (try? Request.editorOpen(file: file.file).sendIfNotDisabled())
                 .map(SourceKittenDictionary.init) else {
-            Issue.fileNotReadable(path: file.path, ruleID: Self.description.identifier).print()
+            Issue.fileNotReadable(path: file.path, ruleID: Self.identifier).print()
             return .empty
         }
 

Source/SwiftLintBuiltInRules/Rules/Lint/UnusedImportRule.swift

@@ -84,7 +84,7 @@ struct UnusedImportRule: CorrectableRule, AnalyzerRule {
 
     private func importUsage(in file: SwiftLintFile, compilerArguments: [String]) -> [ImportUsage] {
         guard compilerArguments.isNotEmpty else {
-            Issue.missingCompilerArguments(path: file.path, ruleID: Self.description.identifier).print()
+            Issue.missingCompilerArguments(path: file.path, ruleID: Self.identifier).print()
             return []
         }
 
@@ -178,7 +178,7 @@ private extension SwiftLintFile {
                 file: path!, offset: token.offset, arguments: compilerArguments
             )
             guard let cursorInfo = (try? cursorInfoRequest.sendIfNotDisabled()).map(SourceKittenDictionary.init) else {
-                Issue.missingCursorInfo(path: path, ruleID: UnusedImportRule.description.identifier).print()
+                Issue.missingCursorInfo(path: path, ruleID: UnusedImportRule.identifier).print()
                 continue
             }
             if nextIsModuleImport {
@@ -213,7 +213,7 @@ private extension SwiftLintFile {
     func operatorImports(arguments: [String], processedTokenOffsets: Set<ByteCount>) -> Set<String> {
         guard let index = (try? Request.index(file: path!, arguments: arguments).sendIfNotDisabled())
             .map(SourceKittenDictionary.init) else {
-            Issue.indexingError(path: path, ruleID: UnusedImportRule.description.identifier).print()
+            Issue.indexingError(path: path, ruleID: UnusedImportRule.identifier).print()
             return []
         }
 
@@ -236,7 +236,7 @@ private extension SwiftLintFile {
                 )
                 guard let cursorInfo = (try? cursorInfoRequest.sendIfNotDisabled())
                     .map(SourceKittenDictionary.init) else {
-                    Issue.missingCursorInfo(path: path, ruleID: UnusedImportRule.description.identifier).print()
+                    Issue.missingCursorInfo(path: path, ruleID: UnusedImportRule.identifier).print()
                     continue
                 }