mirror of
https://github.com/realm/SwiftLint.git
synced 2026-06-06 20:18:40 +00:00
Danny Mösch
152355e36f
The current algorithm is like "collect all included files and subtract all excluded files". Collecting all included and all excluded files relies on the file system. This can become slow when the patterns used to exclude files resolve to a large number of files. The new approach only collects all lintable files and checks them against the exclude patterns. This can be done by in-memory string-regex-match and does therefore not require file system accesses.
93 lines
4.2 KiB
Swift
93 lines
4.2 KiB
Swift
import Foundation
|
|
|
|
extension Configuration {
|
|
// MARK: Lintable Paths
|
|
|
|
/// Returns the files that can be linted by SwiftLint in the specified parent path.
|
|
///
|
|
/// - parameter path: The parent path in which to search for lintable files. Can be a directory or a
|
|
/// file.
|
|
/// - parameter forceExclude: Whether or not excludes defined in this configuration should be applied even if
|
|
/// `path` is an exact match.
|
|
/// - parameter excludeByPrefix: Whether or not it uses the exclude-by-prefix algorithm.
|
|
///
|
|
/// - returns: Files to lint.
|
|
public func lintableFiles(inPath path: String,
|
|
forceExclude: Bool,
|
|
excludeByPrefix: Bool) -> [SwiftLintFile] {
|
|
lintablePaths(inPath: path, forceExclude: forceExclude, excludeByPrefix: excludeByPrefix)
|
|
.compactMap(SwiftLintFile.init(pathDeferringReading:))
|
|
}
|
|
|
|
/// Returns the paths for files that can be linted by SwiftLint in the specified parent path.
|
|
///
|
|
/// - parameter path: The parent path in which to search for lintable files. Can be a directory or a
|
|
/// file.
|
|
/// - parameter forceExclude: Whether or not excludes defined in this configuration should be applied even if
|
|
/// `path` is an exact match.
|
|
/// - parameter excludeByPrefix: Whether or not it uses the exclude-by-prefix algorithm.
|
|
/// - parameter fileManager: The lintable file manager to use to search for lintable files.
|
|
///
|
|
/// - returns: Paths for files to lint.
|
|
internal func lintablePaths(
|
|
inPath path: String,
|
|
forceExclude: Bool,
|
|
excludeByPrefix: Bool,
|
|
fileManager: some LintableFileManager = FileManager.default
|
|
) -> [String] {
|
|
if fileManager.isFile(atPath: path) {
|
|
if forceExclude {
|
|
return excludeByPrefix
|
|
? filterExcludedPathsByPrefix(in: [path.normalized])
|
|
: filterExcludedPaths(in: [path.normalized])
|
|
}
|
|
// If path is a file and we're not forcing excludes, skip filtering with excluded/included paths
|
|
return [path]
|
|
}
|
|
|
|
let pathsForPath = includedPaths.isEmpty ? fileManager.filesToLint(inPath: path, rootDirectory: nil) : []
|
|
let includedPaths = self.includedPaths
|
|
.flatMap(Glob.resolveGlob)
|
|
.parallelFlatMap { fileManager.filesToLint(inPath: $0, rootDirectory: rootDirectory) }
|
|
|
|
return excludeByPrefix
|
|
? filterExcludedPathsByPrefix(in: pathsForPath + includedPaths)
|
|
: filterExcludedPaths(in: pathsForPath + includedPaths)
|
|
}
|
|
|
|
/// Returns an array of file paths after removing the excluded paths as defined by this configuration.
|
|
///
|
|
/// - parameter paths: The input paths to filter.
|
|
///
|
|
/// - returns: The input paths after removing the excluded paths.
|
|
public func filterExcludedPaths(in paths: [String]) -> [String] {
|
|
#if os(Linux)
|
|
let result = NSMutableOrderedSet(capacity: paths.count)
|
|
result.addObjects(from: paths)
|
|
#else
|
|
let result = NSMutableOrderedSet(array: paths)
|
|
#endif
|
|
let exclusionPatterns = self.excludedPaths.flatMap {
|
|
Glob.createFilenameMatchers(root: rootDirectory, pattern: $0)
|
|
}
|
|
return result.array
|
|
.parallelCompactMap { exclusionPatterns.anyMatch(filename: $0 as! String) ? nil : $0 as? String }
|
|
// swiftlint:disable:previous force_cast
|
|
}
|
|
|
|
/// Returns the file paths that are excluded by this configuration using filtering by absolute path prefix.
|
|
///
|
|
/// For cases when excluded directories contain many lintable files (e. g. Pods) it works faster than default
|
|
/// algorithm `filterExcludedPaths`.
|
|
///
|
|
/// - returns: The input paths after removing the excluded paths.
|
|
public func filterExcludedPathsByPrefix(in paths: [String]) -> [String] {
|
|
let excludedPaths = self.excludedPaths
|
|
.parallelFlatMap { Glob.resolveGlob($0) }
|
|
.map(\.normalized)
|
|
return paths.filter { path in
|
|
!excludedPaths.contains { path.hasPrefix($0) }
|
|
}
|
|
}
|
|
}
|