66 lines
2.9 KiB
Swift
66 lines
2.9 KiB
Swift
/// The configuration payload mapping an imported module to a set of modules that are allowed to be
|
|
/// transitively imported.
|
|
struct TransitiveModuleConfiguration: Equatable {
|
|
/// The module imported in a source file.
|
|
let importedModule: String
|
|
/// The set of modules that can be transitively imported by `importedModule`.
|
|
let transitivelyImportedModules: [String]
|
|
|
|
init(configuration: Any) throws {
|
|
guard let configurationDict = configuration as? [String: Any],
|
|
Set(configurationDict.keys) == ["module", "allowed_transitive_imports"],
|
|
let importedModule = configurationDict["module"] as? String,
|
|
let transitivelyImportedModules = configurationDict["allowed_transitive_imports"] as? [String]
|
|
else {
|
|
throw Issue.unknownConfiguration
|
|
}
|
|
self.importedModule = importedModule
|
|
self.transitivelyImportedModules = transitivelyImportedModules
|
|
}
|
|
}
|
|
|
|
struct UnusedImportConfiguration: RuleConfiguration, Equatable {
|
|
var consoleDescription: String {
|
|
return [
|
|
"severity: \(severity.consoleDescription)",
|
|
"require_explicit_imports: \(requireExplicitImports)",
|
|
"allowed_transitive_imports: \(allowedTransitiveImports)",
|
|
"always_keep_imports: \(alwaysKeepImports)"
|
|
].joined(separator: ", ")
|
|
}
|
|
|
|
private(set) var severity: SeverityConfiguration
|
|
private(set) var requireExplicitImports: Bool
|
|
private(set) var allowedTransitiveImports: [TransitiveModuleConfiguration]
|
|
/// A set of modules to never remove the imports of.
|
|
private(set) var alwaysKeepImports: [String]
|
|
|
|
init(severity: ViolationSeverity, requireExplicitImports: Bool,
|
|
allowedTransitiveImports: [TransitiveModuleConfiguration],
|
|
alwaysKeepImports: [String]) {
|
|
self.severity = SeverityConfiguration(severity)
|
|
self.requireExplicitImports = requireExplicitImports
|
|
self.allowedTransitiveImports = allowedTransitiveImports
|
|
self.alwaysKeepImports = alwaysKeepImports
|
|
}
|
|
|
|
mutating func apply(configuration: Any) throws {
|
|
guard let configurationDict = configuration as? [String: Any] else {
|
|
throw Issue.unknownConfiguration
|
|
}
|
|
|
|
if let severityConfiguration = configurationDict["severity"] {
|
|
try severity.apply(configuration: severityConfiguration)
|
|
}
|
|
if let requireExplicitImports = configurationDict["require_explicit_imports"] as? Bool {
|
|
self.requireExplicitImports = requireExplicitImports
|
|
}
|
|
if let allowedTransitiveImports = configurationDict["allowed_transitive_imports"] as? [Any] {
|
|
self.allowedTransitiveImports = try allowedTransitiveImports.map(TransitiveModuleConfiguration.init)
|
|
}
|
|
if let alwaysKeepImports = configurationDict["always_keep_imports"] as? [String] {
|
|
self.alwaysKeepImports = alwaysKeepImports
|
|
}
|
|
}
|
|
}
|