dnrops
/
SwiftLint
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Omit "Rule" in configuration names (#5024)

This commit is contained in:
Danny Mösch 2023-05-20 10:39:04 +02:00 committed by GitHub
parent 1094a3b70e
commit a2ba0a0626
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
24 changed files with 59 additions and 57 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
CHANGELOG.md
View File

@ -31,7 +31,9 @@
declarations in classes.
[SimplyDanny](https://github.com/SimplyDanny)
[#5009](https://github.com/realm/SwiftLint/issues/5009)
* Fix autocorrect for `CGIntersectionRect` in `legacy_cggeometry_functions`
* Fix autocorrect for `CGIntersectionRect` in `legacy_cggeometry_functions`
rule.
[Haoocen](https://github.com/Haoocen)
[#5023](https://github.com/realm/SwiftLint/pull/5023)

2
Source/SwiftLintBuiltInRules/Rules/Idiomatic/ForWhereRule.swift
View File

@ -1,7 +1,7 @@
import SwiftSyntax
struct ForWhereRule: SwiftSyntaxRule, ConfigurationProviderRule {
var configuration = ForWhereRuleConfiguration()
var configuration = ForWhereConfiguration()
static let description = RuleDescription(
identifier: "for_where",

2
Source/SwiftLintBuiltInRules/Rules/Idiomatic/NoMagicNumbersRule.swift
View File

@ -1,7 +1,7 @@
import SwiftSyntax
struct NoMagicNumbersRule: SwiftSyntaxRule, OptInRule, ConfigurationProviderRule {
var configuration = NoMagicNumbersRuleConfiguration()
var configuration = NoMagicNumbersConfiguration()
static let description = RuleDescription(
identifier: "no_magic_numbers",

2
Source/SwiftLintBuiltInRules/Rules/Idiomatic/PrivateOverFilePrivateRule.swift
View File

@ -1,7 +1,7 @@
import SwiftSyntax
struct PrivateOverFilePrivateRule: ConfigurationProviderRule, SwiftSyntaxCorrectableRule {
var configuration = PrivateOverFilePrivateRuleConfiguration()
var configuration = PrivateOverFilePrivateConfiguration()
static let description = RuleDescription(
identifier: "private_over_fileprivate",

6
Source/SwiftLintBuiltInRules/Rules/Idiomatic/TypeNameRule.swift
View File

@ -2,7 +2,7 @@ import Foundation
import SwiftSyntax
struct TypeNameRule: SwiftSyntaxRule, ConfigurationProviderRule {
var configuration = TypeNameRuleConfiguration()
var configuration = TypeNameConfiguration()
static let description = RuleDescription(
identifier: "type_name",
@ -24,9 +24,9 @@ struct TypeNameRule: SwiftSyntaxRule, ConfigurationProviderRule {
private extension TypeNameRule {
final class Visitor: ViolationsSyntaxVisitor {
private let configuration: TypeNameRuleConfiguration
private let configuration: TypeNameConfiguration
init(configuration: TypeNameRuleConfiguration) {
init(configuration: TypeNameConfiguration) {
self.configuration = configuration
super.init(viewMode: .sourceAccurate)
}

6
Source/SwiftLintBuiltInRules/Rules/Idiomatic/XCTSpecificMatcherRule.swift
View File

@ -2,7 +2,7 @@ import SwiftOperators
import SwiftSyntax
struct XCTSpecificMatcherRule: SwiftSyntaxRule, OptInRule, ConfigurationProviderRule {
var configuration = XCTSpecificMatcherRuleConfiguration()
var configuration = XCTSpecificMatcherConfiguration()
static let description = RuleDescription(
identifier: "xct_specific_matcher",
@ -20,9 +20,9 @@ struct XCTSpecificMatcherRule: SwiftSyntaxRule, OptInRule, ConfigurationProvider
private extension XCTSpecificMatcherRule {
final class Visitor: ViolationsSyntaxVisitor {
let configuration: XCTSpecificMatcherRuleConfiguration
let configuration: XCTSpecificMatcherConfiguration
init(configuration: XCTSpecificMatcherRuleConfiguration) {
init(configuration: XCTSpecificMatcherConfiguration) {
self.configuration = configuration
super.init(viewMode: .sourceAccurate)
}

6
Source/SwiftLintBuiltInRules/Rules/Lint/MissingDocsRule.swift
View File

@ -45,12 +45,12 @@ private extension SwiftLintFile {
struct MissingDocsRule: OptInRule, ConfigurationProviderRule {
init() {
configuration = MissingDocsRuleConfiguration()
configuration = MissingDocsConfiguration()
}
typealias ConfigurationType = MissingDocsRuleConfiguration
typealias ConfigurationType = MissingDocsConfiguration
var configuration: MissingDocsRuleConfiguration
var configuration: MissingDocsConfiguration
static let description = RuleDescription(
identifier: "missing_docs",

2
Source/SwiftLintBuiltInRules/Rules/Lint/PrivateOutletRule.swift
View File

@ -1,7 +1,7 @@
import SwiftSyntax
struct PrivateOutletRule: SwiftSyntaxRule, OptInRule, ConfigurationProviderRule {
var configuration = PrivateOutletRuleConfiguration()
var configuration = PrivateOutletConfiguration()
static let description = RuleDescription(
identifier: "private_outlet",

6
Source/SwiftLintBuiltInRules/Rules/Lint/RequiredEnumCaseRule.swift
View File

@ -68,7 +68,7 @@ import SwiftSyntax
/// }
/// ````
struct RequiredEnumCaseRule: SwiftSyntaxRule, OptInRule, ConfigurationProviderRule {
var configuration = RequiredEnumCaseRuleConfiguration()
var configuration = RequiredEnumCaseConfiguration()
private static let exampleConfiguration = [
"NetworkResponsable": ["success": "warning", "error": "warning", "notConnected": "warning"]
@ -138,9 +138,9 @@ struct RequiredEnumCaseRule: SwiftSyntaxRule, OptInRule, ConfigurationProviderRu
private extension RequiredEnumCaseRule {
final class Visitor: ViolationsSyntaxVisitor {
private let configuration: RequiredEnumCaseRuleConfiguration
private let configuration: RequiredEnumCaseConfiguration
init(configuration: RequiredEnumCaseRuleConfiguration) {
init(configuration: RequiredEnumCaseConfiguration) {
self.configuration = configuration
super.init(viewMode: .sourceAccurate)
}

2
Source/SwiftLintBuiltInRules/Rules/Metrics/FileLengthRule.swift
View File

@ -1,7 +1,7 @@
import SourceKittenFramework
struct FileLengthRule: ConfigurationProviderRule {
var configuration = FileLengthRuleConfiguration()
var configuration = FileLengthConfiguration()
static let description = RuleDescription(
identifier: "file_length",

2
Source/SwiftLintBuiltInRules/Rules/RuleConfigurations/ComputedAccessorsOrderRuleConfiguration.swift → Source/SwiftLintBuiltInRules/Rules/RuleConfigurations/ComputedAccessorsOrderConfiguration.swift
View File

@ -1,4 +1,4 @@
struct ComputedAccessorsOrderRuleConfiguration: SeverityBasedRuleConfiguration, Equatable {
struct ComputedAccessorsOrderConfiguration: SeverityBasedRuleConfiguration, Equatable {
typealias Parent = ComputedAccessorsOrderRule
enum Order: String {

2
Source/SwiftLintBuiltInRules/Rules/RuleConfigurations/FileLengthRuleConfiguration.swift → Source/SwiftLintBuiltInRules/Rules/RuleConfigurations/FileLengthConfiguration.swift
View File

@ -4,7 +4,7 @@ private enum ConfigurationKey: String {
case ignoreCommentOnlyLines = "ignore_comment_only_lines"
}
struct FileLengthRuleConfiguration: RuleConfiguration, Equatable {
struct FileLengthConfiguration: RuleConfiguration, Equatable {
typealias Parent = FileLengthRule
private(set) var severityConfiguration = SeverityLevelsConfiguration<Parent>(warning: 400, error: 1000)

2
Source/SwiftLintBuiltInRules/Rules/RuleConfigurations/ForWhereRuleConfiguration.swift → Source/SwiftLintBuiltInRules/Rules/RuleConfigurations/ForWhereConfiguration.swift
View File

@ -1,4 +1,4 @@
struct ForWhereRuleConfiguration: SeverityBasedRuleConfiguration, Equatable {
struct ForWhereConfiguration: SeverityBasedRuleConfiguration, Equatable {
typealias Parent = ForWhereRule
private(set) var severityConfiguration = SeverityConfiguration<Parent>(.warning)

2
Source/SwiftLintBuiltInRules/Rules/RuleConfigurations/MissingDocsRuleConfiguration.swift → Source/SwiftLintBuiltInRules/Rules/RuleConfigurations/MissingDocsConfiguration.swift
View File

@ -1,4 +1,4 @@
struct MissingDocsRuleConfiguration: RuleConfiguration, Equatable {
struct MissingDocsConfiguration: RuleConfiguration, Equatable {
typealias Parent = MissingDocsRule
private(set) var parameters = [

2
Source/SwiftLintBuiltInRules/Rules/RuleConfigurations/PrivateOutletRuleConfiguration.swift → Source/SwiftLintBuiltInRules/Rules/RuleConfigurations/PrivateOutletConfiguration.swift
View File

@ -1,4 +1,4 @@
struct PrivateOutletRuleConfiguration: SeverityBasedRuleConfiguration, Equatable {
struct PrivateOutletConfiguration: SeverityBasedRuleConfiguration, Equatable {
typealias Parent = PrivateOutletRule
private(set) var severityConfiguration = SeverityConfiguration<Parent>(.warning)

2
Source/SwiftLintBuiltInRules/Rules/RuleConfigurations/PrivateOverFilePrivateRuleConfiguration.swift → Source/SwiftLintBuiltInRules/Rules/RuleConfigurations/PrivateOverFilePrivateConfiguration.swift
View File

@ -1,4 +1,4 @@
struct PrivateOverFilePrivateRuleConfiguration: SeverityBasedRuleConfiguration, Equatable {
struct PrivateOverFilePrivateConfiguration: SeverityBasedRuleConfiguration, Equatable {
typealias Parent = PrivateOverFilePrivateRule
var severityConfiguration = SeverityConfiguration<Parent>(.warning)

2
Source/SwiftLintBuiltInRules/Rules/RuleConfigurations/RequiredEnumCaseRuleConfiguration.swift → Source/SwiftLintBuiltInRules/Rules/RuleConfigurations/RequiredEnumCaseConfiguration.swift
View File

@ -1,4 +1,4 @@
struct RequiredEnumCaseRuleConfiguration: RuleConfiguration, Equatable {
struct RequiredEnumCaseConfiguration: RuleConfiguration, Equatable {
typealias Parent = RequiredEnumCaseRule
struct RequiredCase: Hashable {

2
Source/SwiftLintBuiltInRules/Rules/RuleConfigurations/TypeNameRuleConfiguration.swift → Source/SwiftLintBuiltInRules/Rules/RuleConfigurations/TypeNameConfiguration.swift
View File

@ -1,4 +1,4 @@
struct TypeNameRuleConfiguration: RuleConfiguration, Equatable {
struct TypeNameConfiguration: RuleConfiguration, Equatable {
typealias Parent = TypeNameRule
private(set) var nameConfiguration = NameConfiguration<Parent>(minLengthWarning: 3,

10
Source/SwiftLintBuiltInRules/Rules/RuleConfigurations/UnitTestRuleConfiguration.swift → Source/SwiftLintBuiltInRules/Rules/RuleConfigurations/UnitTestConfiguration.swift
View File

@ -1,9 +1,9 @@
typealias BalancedXCTestLifecycleConfiguration = UnitTestRuleConfiguration<BalancedXCTestLifecycleRule>
typealias EmptyXCTestMethodConfiguration = UnitTestRuleConfiguration<EmptyXCTestMethodRule>
typealias SingleTestClassConfiguration = UnitTestRuleConfiguration<SingleTestClassRule>
typealias NoMagicNumbersRuleConfiguration = UnitTestRuleConfiguration<NoMagicNumbersRule>
typealias BalancedXCTestLifecycleConfiguration = UnitTestConfiguration<BalancedXCTestLifecycleRule>
typealias EmptyXCTestMethodConfiguration = UnitTestConfiguration<EmptyXCTestMethodRule>
typealias SingleTestClassConfiguration = UnitTestConfiguration<SingleTestClassRule>
typealias NoMagicNumbersConfiguration = UnitTestConfiguration<NoMagicNumbersRule>
struct UnitTestRuleConfiguration<Parent: Rule>: SeverityBasedRuleConfiguration, Equatable {
struct UnitTestConfiguration<Parent: Rule>: SeverityBasedRuleConfiguration, Equatable {
private(set) var severityConfiguration = SeverityConfiguration<Parent>(.warning)
private(set) var testParentClasses: Set<String> = ["QuickSpec", "XCTestCase"]

2
Source/SwiftLintBuiltInRules/Rules/RuleConfigurations/XCTSpecificMatcherRuleConfiguration.swift → Source/SwiftLintBuiltInRules/Rules/RuleConfigurations/XCTSpecificMatcherConfiguration.swift
View File

@ -1,4 +1,4 @@
struct XCTSpecificMatcherRuleConfiguration: SeverityBasedRuleConfiguration, Equatable {
struct XCTSpecificMatcherConfiguration: SeverityBasedRuleConfiguration, Equatable {
typealias Parent = XCTSpecificMatcherRule
private(set) var severityConfiguration = SeverityConfiguration<Parent>(.warning)

8
Source/SwiftLintBuiltInRules/Rules/Style/ComputedAccessorsOrderRule.swift
View File

@ -1,7 +1,7 @@
import SwiftSyntax
struct ComputedAccessorsOrderRule: ConfigurationProviderRule, SwiftSyntaxRule {
var configuration = ComputedAccessorsOrderRuleConfiguration()
var configuration = ComputedAccessorsOrderConfiguration()
static let description = RuleDescription(
identifier: "computed_accessors_order",
@ -22,9 +22,9 @@ private final class ComputedAccessorsOrderRuleVisitor: ViolationsSyntaxVisitor {
case `subscript`, property
}
private let expectedOrder: ComputedAccessorsOrderRuleConfiguration.Order
private let expectedOrder: ComputedAccessorsOrderConfiguration.Order
init(expectedOrder: ComputedAccessorsOrderRuleConfiguration.Order) {
init(expectedOrder: ComputedAccessorsOrderConfiguration.Order) {
self.expectedOrder = expectedOrder
super.init(viewMode: .sourceAccurate)
}
@ -59,7 +59,7 @@ private final class ComputedAccessorsOrderRuleVisitor: ViolationsSyntaxVisitor {
}
private extension AccessorBlockSyntax {
var order: ComputedAccessorsOrderRuleConfiguration.Order? {
var order: ComputedAccessorsOrderConfiguration.Order? {
guard accessors.count == 2, accessors.map(\.body).allSatisfy({ $0 != nil }) else {
return nil
}

36
Tests/SwiftLintFrameworkTests/MissingDocsRuleTests.swift
View File

@ -3,7 +3,7 @@ import XCTest
class MissingDocsRuleTests: SwiftLintTestCase {
func testDescriptionEmpty() {
let configuration = MissingDocsRuleConfiguration()
let configuration = MissingDocsConfiguration()
XCTAssertEqual(
configuration.consoleDescription,
"warning: open, public, excludes_extensions: true, " +
@ -12,7 +12,7 @@ class MissingDocsRuleTests: SwiftLintTestCase {
}
func testDescriptionExcludesFalse() {
let configuration = MissingDocsRuleConfiguration(excludesExtensions: false, excludesInheritedTypes: false)
let configuration = MissingDocsConfiguration(excludesExtensions: false, excludesInheritedTypes: false)
XCTAssertEqual(
configuration.consoleDescription,
"warning: open, public, excludes_extensions: false, " +
@ -21,7 +21,7 @@ class MissingDocsRuleTests: SwiftLintTestCase {
}
func testDescriptionExcludesExtensionsFalseExcludesInheritedTypesTrue() {
let configuration = MissingDocsRuleConfiguration(excludesExtensions: false, excludesInheritedTypes: true)
let configuration = MissingDocsConfiguration(excludesExtensions: false, excludesInheritedTypes: true)
XCTAssertEqual(
configuration.consoleDescription,
"warning: open, public, excludes_extensions: false, " +
@ -30,7 +30,7 @@ class MissingDocsRuleTests: SwiftLintTestCase {
}
func testDescriptionExcludesExtensionsTrueExcludesInheritedTypesFalse() {
let configuration = MissingDocsRuleConfiguration(excludesExtensions: true, excludesInheritedTypes: false)
let configuration = MissingDocsConfiguration(excludesExtensions: true, excludesInheritedTypes: false)
XCTAssertEqual(
configuration.consoleDescription,
"warning: open, public, excludes_extensions: true, " +
@ -39,7 +39,7 @@ class MissingDocsRuleTests: SwiftLintTestCase {
}
func testDescriptionSingleServety() {
let configuration = MissingDocsRuleConfiguration(
let configuration = MissingDocsConfiguration(
parameters: [RuleParameter<AccessControlLevel>(severity: .error, value: .open)])
XCTAssertEqual(
configuration.consoleDescription,
@ -49,7 +49,7 @@ class MissingDocsRuleTests: SwiftLintTestCase {
}
func testDescriptionMultipleSeverities() {
let configuration = MissingDocsRuleConfiguration(
let configuration = MissingDocsConfiguration(
parameters: [RuleParameter<AccessControlLevel>(severity: .error, value: .open),
RuleParameter<AccessControlLevel>(severity: .warning, value: .public)])
XCTAssertEqual(
@ -60,7 +60,7 @@ class MissingDocsRuleTests: SwiftLintTestCase {
}
func testDescriptionMultipleAcls() {
let configuration = MissingDocsRuleConfiguration(
let configuration = MissingDocsConfiguration(
parameters: [RuleParameter<AccessControlLevel>(severity: .warning, value: .open),
RuleParameter<AccessControlLevel>(severity: .warning, value: .public)])
XCTAssertEqual(
@ -71,7 +71,7 @@ class MissingDocsRuleTests: SwiftLintTestCase {
}
func testDescriptionExcludesTrivialInitTrue() {
let configuration = MissingDocsRuleConfiguration(excludesTrivialInit: true)
let configuration = MissingDocsConfiguration(excludesTrivialInit: true)
XCTAssertEqual(
configuration.consoleDescription,
"warning: open, public, excludes_extensions: true, " +
@ -80,7 +80,7 @@ class MissingDocsRuleTests: SwiftLintTestCase {
}
func testParsingSingleServety() {
var configuration = MissingDocsRuleConfiguration()
var configuration = MissingDocsConfiguration()
try? configuration.apply(configuration: ["warning": "open"])
XCTAssertEqual(
configuration.parameters,
@ -89,7 +89,7 @@ class MissingDocsRuleTests: SwiftLintTestCase {
}
func testParsingMultipleSeverities() {
var configuration = MissingDocsRuleConfiguration()
var configuration = MissingDocsConfiguration()
try? configuration.apply(configuration: ["warning": "public", "error": "open"])
XCTAssertEqual(
configuration.parameters.sorted { $0.value.rawValue > $1.value.rawValue },
@ -99,7 +99,7 @@ class MissingDocsRuleTests: SwiftLintTestCase {
}
func testParsingMultipleAcls() {
var configuration = MissingDocsRuleConfiguration()
var configuration = MissingDocsConfiguration()
try? configuration.apply(configuration: ["warning": ["public", "open"]])
XCTAssertEqual(
configuration.parameters.sorted { $0.value.rawValue > $1.value.rawValue },
@ -111,12 +111,12 @@ class MissingDocsRuleTests: SwiftLintTestCase {
}
func testInvalidServety() {
var configuration = MissingDocsRuleConfiguration()
var configuration = MissingDocsConfiguration()
XCTAssertThrowsError(try configuration.apply(configuration: ["warning": ["public", "closed"]]))
}
func testInvalidAcl() {
var configuration = MissingDocsRuleConfiguration()
var configuration = MissingDocsConfiguration()
try? configuration.apply(configuration: ["debug": ["public", "open"]])
XCTAssertTrue(configuration.excludesExtensions)
XCTAssertTrue(configuration.excludesInheritedTypes)
@ -128,14 +128,14 @@ class MissingDocsRuleTests: SwiftLintTestCase {
}
func testInvalidDuplicateAcl() {
var configuration = MissingDocsRuleConfiguration()
var configuration = MissingDocsConfiguration()
XCTAssertThrowsError(
try configuration.apply(configuration: ["warning": ["public", "open"] as Any, "error": "public"])
)
}
func testExcludesFalse() {
var configuration = MissingDocsRuleConfiguration()
var configuration = MissingDocsConfiguration()
try? configuration.apply(configuration: ["excludes_extensions": false, "excludes_inherited_types": false])
XCTAssertFalse(configuration.excludesExtensions)
XCTAssertFalse(configuration.excludesInheritedTypes)
@ -147,7 +147,7 @@ class MissingDocsRuleTests: SwiftLintTestCase {
}
func testExcludesExtensionsFalseExcludesInheritedTypesTrue() {
var configuration = MissingDocsRuleConfiguration()
var configuration = MissingDocsConfiguration()
try? configuration.apply(configuration: ["excludes_extensions": false, "excludes_inherited_types": true])
XCTAssertFalse(configuration.excludesExtensions)
XCTAssertTrue(configuration.excludesInheritedTypes)
@ -159,7 +159,7 @@ class MissingDocsRuleTests: SwiftLintTestCase {
}
func testExcludesExtensionsTrueExcludesInheritedTypesFalse() {
var configuration = MissingDocsRuleConfiguration()
var configuration = MissingDocsConfiguration()
try? configuration.apply(configuration: ["excludes_extensions": true, "excludes_inherited_types": false])
XCTAssertTrue(configuration.excludesExtensions)
XCTAssertFalse(configuration.excludesInheritedTypes)
@ -171,7 +171,7 @@ class MissingDocsRuleTests: SwiftLintTestCase {
}
func testExcludesExtensionsTrueExcludesInheritedTypesFalseWithParameters() {
var configuration = MissingDocsRuleConfiguration()
var configuration = MissingDocsConfiguration()
try? configuration.apply(
configuration: [
"excludes_extensions": true,

4
Tests/SwiftLintFrameworkTests/RequiredEnumCaseRuleConfigurationTests.swift → Tests/SwiftLintFrameworkTests/RequiredEnumCaseConfigurationTests.swift
View File

@ -1,8 +1,8 @@
@testable import SwiftLintBuiltInRules
import XCTest
class RequiredEnumCaseRuleConfigurationTests: SwiftLintTestCase {
private typealias RuleConfiguration = RequiredEnumCaseRuleConfiguration
class RequiredEnumCaseConfigurationTests: SwiftLintTestCase {
private typealias RuleConfiguration = RequiredEnumCaseConfiguration
private typealias RequiredCase = RuleConfiguration.RequiredCase
private static let protocol1 = "RequiredProtocol"

2
Tests/SwiftLintFrameworkTests/RuleConfigurationTests.swift
View File

@ -318,7 +318,7 @@ class RuleConfigurationTests: SwiftLintTestCase {
}
func testComputedAccessorsOrderRuleConfiguration() throws {
var configuration = ComputedAccessorsOrderRuleConfiguration()
var configuration = ComputedAccessorsOrderConfiguration()
let config = ["severity": "error", "order": "set_get"]
try configuration.apply(configuration: config)