mirror of
https://github.com/realm/SwiftLint.git
synced 2026-06-06 20:18:40 +00:00
2bcea4b04d
* Add LintableFilesVisitor * Move LintCommand logic into LintOrAnalyzeCommand to prepare for the upcoming analyze command * Add AnalyzeCommand (not fully implemented yet in SwiftLintFramework) * Add analyzerRules configuration member * Add AnalyzerRule protocol * Pass compiler arguments to validate/correct * Add requiresFileOnDisk member to RuleDescription This will be used by AnalyzerRules because they need a file on disk to pass in the compiler arguments to SourceKit. * Exclusively run AnalyzerRules when the Linter has compiler arguments * Enable testing AnalyzerRules in TestHelpers * Add ExplicitSelfRule * Update documentation * Fix `analyze --autocorrect` * Improve performance of CompilerArgumentsExtractor * Fix lint command actually running analyze * Move File operations in TestHelpers into a private extension * Add analyzer column to rules command and markdown documentation * Use a Set literal * Make AnalyzerRule inherit from OptInRule * Mention analyzer_rules in readme * Mention that analyzer rules are slow
92 lines
4.6 KiB
Swift
92 lines
4.6 KiB
Swift
import Commandant
|
|
import Result
|
|
import SwiftLintFramework
|
|
|
|
struct AnalyzeCommand: CommandProtocol {
|
|
let verb = "analyze"
|
|
let function = "[Experimental] Run analysis rules"
|
|
|
|
func run(_ options: AnalyzeOptions) -> Result<(), CommandantError<()>> {
|
|
let options = LintOrAnalyzeOptions(options)
|
|
if options.autocorrect {
|
|
return autocorrect(options)
|
|
} else {
|
|
return LintOrAnalyzeCommand.run(options)
|
|
}
|
|
}
|
|
|
|
private func autocorrect(_ options: LintOrAnalyzeOptions) -> Result<(), CommandantError<()>> {
|
|
return Configuration(options: options).visitLintableFiles(options: options, cache: nil) { linter in
|
|
let corrections = linter.correct()
|
|
if !corrections.isEmpty && !options.quiet {
|
|
let correctionLogs = corrections.map({ $0.consoleDescription })
|
|
queuedPrint(correctionLogs.joined(separator: "\n"))
|
|
}
|
|
}.flatMap { files in
|
|
if !options.quiet {
|
|
let pluralSuffix = { (collection: [Any]) -> String in
|
|
return collection.count != 1 ? "s" : ""
|
|
}
|
|
queuedPrintError("Done correcting \(files.count) file\(pluralSuffix(files))!")
|
|
}
|
|
return .success(())
|
|
}
|
|
}
|
|
}
|
|
|
|
struct AnalyzeOptions: OptionsProtocol {
|
|
let paths: [String]
|
|
let configurationFile: String
|
|
let strict: Bool
|
|
let lenient: Bool
|
|
let forceExclude: Bool
|
|
let useScriptInputFiles: Bool
|
|
let benchmark: Bool
|
|
let reporter: String
|
|
let quiet: Bool
|
|
let enableAllRules: Bool
|
|
let autocorrect: Bool
|
|
let compilerLogPath: String
|
|
|
|
// swiftlint:disable line_length
|
|
static func create(_ path: String) -> (_ configurationFile: String) -> (_ strict: Bool) -> (_ lenient: Bool) -> (_ forceExclude: Bool) -> (_ useScriptInputFiles: Bool) -> (_ benchmark: Bool) -> (_ reporter: String) -> (_ quiet: Bool) -> (_ enableAllRules: Bool) -> (_ autocorrect: Bool) -> (_ compilerLogPath: String) -> (_ paths: [String]) -> AnalyzeOptions {
|
|
return { configurationFile in { strict in { lenient in { forceExclude in { useScriptInputFiles in { benchmark in { reporter in { quiet in { enableAllRules in { autocorrect in { compilerLogPath in { paths in
|
|
let allPaths: [String]
|
|
if !path.isEmpty {
|
|
allPaths = [path]
|
|
} else {
|
|
allPaths = paths
|
|
}
|
|
return self.init(paths: allPaths, configurationFile: configurationFile, strict: strict, lenient: lenient, forceExclude: forceExclude, useScriptInputFiles: useScriptInputFiles, benchmark: benchmark, reporter: reporter, quiet: quiet, enableAllRules: enableAllRules, autocorrect: autocorrect, compilerLogPath: compilerLogPath)
|
|
// swiftlint:enable line_length
|
|
}}}}}}}}}}}}
|
|
}
|
|
|
|
static func evaluate(_ mode: CommandMode) -> Result<AnalyzeOptions, CommandantError<CommandantError<()>>> {
|
|
return create
|
|
<*> mode <| pathOption(action: "analyze")
|
|
<*> mode <| configOption
|
|
<*> mode <| Option(key: "strict", defaultValue: false,
|
|
usage: "fail on warnings")
|
|
<*> mode <| Option(key: "lenient", defaultValue: false,
|
|
usage: "downgrades serious violations to warnings, warning threshold is disabled")
|
|
<*> mode <| Option(key: "force-exclude", defaultValue: false,
|
|
usage: "exclude files in config `excluded` even if their paths are explicitly specified")
|
|
<*> mode <| useScriptInputFilesOption
|
|
<*> mode <| Option(key: "benchmark", defaultValue: false,
|
|
usage: "save benchmarks to benchmark_files.txt " +
|
|
"and benchmark_rules.txt")
|
|
<*> mode <| Option(key: "reporter", defaultValue: "",
|
|
usage: "the reporter used to log errors and warnings")
|
|
<*> mode <| quietOption(action: "linting")
|
|
<*> mode <| Option(key: "enable-all-rules", defaultValue: false,
|
|
usage: "run all rules, even opt-in and disabled ones, ignoring `whitelist_rules`")
|
|
<*> mode <| Option(key: "autocorrect", defaultValue: false,
|
|
usage: "correct violations whenever possible")
|
|
<*> mode <| Option(key: "compiler-log-path", defaultValue: "",
|
|
usage: "the path of the full xcodebuild log to use when linting AnalyzerRules")
|
|
// This should go last to avoid eating other args
|
|
<*> mode <| pathsArgument(action: "analyze")
|
|
}
|
|
}
|