forked from realm/SwiftLint
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add private_only to prefixed_toplevel_constant (realm#2315)
* Add private_only to prefixed_toplevel_constant This allows users to opt in to only validate top level constants have the given prefix if the constant is private or fileprivate.
- Loading branch information
Showing
7 changed files
with
86 additions
and
16 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
32 changes: 32 additions & 0 deletions
32
Source/SwiftLintFramework/Rules/RuleConfigurations/PrefixedConstantRuleConfiguration.swift
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
| import Foundation | ||
|
|
||
| public struct PrefixedConstantRuleConfiguration: RuleConfiguration, Equatable { | ||
| var severityConfiguration = SeverityConfiguration(.warning) | ||
| var onlyPrivateMembers = false | ||
|
|
||
| public var consoleDescription: String { | ||
| return severityConfiguration.consoleDescription + ", only_private: \(onlyPrivateMembers)" | ||
| } | ||
|
|
||
| public init(onlyPrivateMembers: Bool) { | ||
| self.onlyPrivateMembers = onlyPrivateMembers | ||
| } | ||
|
|
||
| public mutating func apply(configuration: Any) throws { | ||
| guard let configuration = configuration as? [String: Any] else { | ||
| throw ConfigurationError.unknownConfiguration | ||
| } | ||
|
|
||
| onlyPrivateMembers = (configuration["only_private"] as? Bool == true) | ||
|
|
||
| if let severityString = configuration["severity"] as? String { | ||
| try severityConfiguration.apply(configuration: severityString) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| public func == (lhs: PrefixedConstantRuleConfiguration, | ||
| rhs: PrefixedConstantRuleConfiguration) -> Bool { | ||
| return lhs.onlyPrivateMembers == rhs.onlyPrivateMembers && | ||
| lhs.severityConfiguration == rhs.severityConfiguration | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
26 changes: 26 additions & 0 deletions
26
Tests/SwiftLintFrameworkTests/PrefixedTopLevelConstantRuleTests.swift
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,26 @@ | ||
| @testable import SwiftLintFramework | ||
| import XCTest | ||
|
|
||
| final class PrefixedTopLevelConstantRuleTests: XCTestCase { | ||
| func testDefaultConfiguration() { | ||
| verifyRule(PrefixedTopLevelConstantRule.description) | ||
| } | ||
|
|
||
| func testPrivateOnly() { | ||
| let triggeringExamples = [ | ||
| "private let ↓Foo = 20.0", | ||
| "fileprivate let ↓foo = 20.0" | ||
| ] | ||
| let nonTriggeringExamples = [ | ||
| "let Foo = 20.0", | ||
| "internal let Foo = \"Foo\"", | ||
| "public let Foo = 20.0" | ||
| ] | ||
|
|
||
| let description = PrefixedTopLevelConstantRule.description | ||
| .with(triggeringExamples: triggeringExamples) | ||
| .with(nonTriggeringExamples: nonTriggeringExamples) | ||
|
|
||
| verifyRule(description, ruleConfiguration: ["only_private": true]) | ||
| } | ||
| } |