Skip to content

Commit 298e917

Browse files
Wei SunWei Sun
Wei Sun
authored and
Wei Sun
committed
[Format] Update naming
1 parent 7390b47 commit 298e917

14 files changed

+88
-87
lines changed

Sources/DangerSwiftCommitLint/CommitChecker/BodyEmptyLineCheck.swift renamed to Sources/DangerSwiftCommitLint/CommitChecker/BodyEmptyLine.swift

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import Foundation
22

3-
struct BodyEmptyLineCheck: CommitChecker, Hashable {
4-
static var checkerMessage = "Please separate commit message subject from body with newline."
3+
struct BodyEmptyLine: CommitLint, Hashable {
4+
static var linterMessage = "Please separate commit message subject from body with newline."
55

66
private let bodyLinesOfText: [String]
77

Sources/DangerSwiftCommitLint/CommitChecker/CommitChecker.swift renamed to Sources/DangerSwiftCommitLint/CommitChecker/CommitLint.swift

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import Foundation
22

3-
public protocol CommitChecker {
4-
static var checkerMessage: String { get }
3+
public protocol CommitLint {
4+
static var linterMessage: String { get }
55

66
var fail: Bool { get }
77

@@ -10,7 +10,7 @@ public protocol CommitChecker {
1010
static func fail(_ commitMessage: GitCommitMessage) -> Bool
1111
}
1212

13-
public extension CommitChecker {
13+
public extension CommitLint {
1414
static func fail(_ commitMessage: GitCommitMessage) -> Bool {
1515
Self(commitMessage).fail
1616
}

Sources/DangerSwiftCommitLint/CommitChecker/SubjectCapCheck.swift renamed to Sources/DangerSwiftCommitLint/CommitChecker/SubjectCapitalLetter.swift

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import Foundation
22

3-
struct SubjectCapCheck: CommitChecker, Hashable {
4-
static let checkerMessage = "Please start commit message subject with capital letter."
3+
struct SubjectCapitalLetter: CommitLint, Hashable {
4+
static let linterMessage = "Please start commit message subject with capital letter."
55

66
private let firstCharacter: Character?
77

Sources/DangerSwiftCommitLint/CommitChecker/SubjectLengthCheck.swift renamed to Sources/DangerSwiftCommitLint/CommitChecker/SubjectLength.swift

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
import Foundation
22

3-
struct SubjectLengthCheck: CommitChecker, Hashable {
3+
struct SubjectLength: CommitLint, Hashable {
44
private enum GeneratedSubjectPattern {
55
static let git = #"^Merge branch '.+' into "#
66
static let gitHub = #"^Merge pull request #\d+ from "#
77
}
88

9-
static let checkerMessage = "Please limit commit message subject line to 50 characters."
9+
static let linterMessage = "Please limit commit message subject line to 50 characters."
1010

1111
private let subject: String
1212

@@ -19,7 +19,7 @@ struct SubjectLengthCheck: CommitChecker, Hashable {
1919
}
2020
}
2121

22-
private extension SubjectLengthCheck {
22+
private extension SubjectLength {
2323
var isMergeCommit: Bool {
2424
subject =~ GeneratedSubjectPattern.git || subject =~ GeneratedSubjectPattern.gitHub
2525
}

Sources/DangerSwiftCommitLint/CommitChecker/SubjectPeriodCheck.swift renamed to Sources/DangerSwiftCommitLint/CommitChecker/SubjectPeriod.swift

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import Foundation
22

3-
struct SubjectPeriodCheck: CommitChecker, Hashable {
4-
static var checkerMessage = "Please remove period from end of commit message subject line."
3+
struct SubjectPeriod: CommitLint, Hashable {
4+
static var linterMessage = "Please remove period from end of commit message subject line."
55

66
private let subject: String
77

Sources/DangerSwiftCommitLint/CommitChecker/SubjectWordCheck.swift renamed to Sources/DangerSwiftCommitLint/CommitChecker/SubjectWord.swift

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import Foundation
22

3-
struct SubjectWordCheck: CommitChecker, Hashable {
4-
static var checkerMessage = "Please use more than one word in commit message."
3+
struct SubjectWord: CommitLint, Hashable {
4+
static var linterMessage = "Please use more than one word in commit message."
55

66
private let subject: String
77

‎Sources/DangerSwiftCommitLint/Configuration.swift‎

Lines changed: 39 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,35 @@
11
import Foundation
22

33
public extension DangerSwiftCommitLint {
4-
struct Configuration {
5-
/// All commit checkers provided by `DangerSwiftCommitLint`
6-
public enum CommitCheckerType: CaseIterable, Hashable {
7-
/// Commit subject and body are separated by an empty line (`CommitChecker/BodyEmptyLineCheck`)
8-
case bodyEmptyLine
9-
/// Commit subject begins with a capital letter (`CommitChecker/SubjectCapCheck`)
10-
case subjectCapCheck
11-
/// Commit subject is no longer than 50 characters (`CommitChecker/SubjectLengthCheck`)
12-
case subjectLengthCheck
13-
/// Commit subject does not end in a period (`CommitChecker/SubjectPeriodCheck`)
14-
case subjectPeriodCheck
15-
/// Commit subject is more than one word (`CommitChecker/SubjectWordCheck`)
16-
case subjectWordCheck
17-
}
4+
/// All commit checkers provided by `DangerSwiftCommitLint`
5+
enum CommitCheckerType: CaseIterable, Hashable {
6+
/// Commit subject and body are separated by an empty line (`CommitChecker/BodyEmptyLineCheck`)
7+
case bodyEmptyLine
8+
/// Commit subject begins with a capital letter (`CommitChecker/SubjectCapCheck`)
9+
case subjectCapitalLetter
10+
/// Commit subject is no longer than 50 characters (`CommitChecker/SubjectLengthCheck`)
11+
case subjectLength
12+
/// Commit subject does not end in a period (`CommitChecker/SubjectPeriodCheck`)
13+
case subjectPeriod
14+
/// Commit subject is more than one word (`CommitChecker/SubjectWordCheck`)
15+
case subjectWord
16+
}
1817

19-
/// Checker selection
20-
public enum CommitCheckerSelection {
21-
/// Select all checkers
22-
case all
23-
/// Select a set of checkers
24-
case selected(Set<CommitCheckerType>)
25-
}
18+
/// Checker selection
19+
enum CommitCheckerSelection {
20+
/// Select all checkers
21+
case all
22+
/// Select a set of checkers
23+
case selected(Set<CommitCheckerType>)
24+
}
25+
26+
struct Configuration {
27+
let limit: Int
2628

2729
private let disabled: CommitCheckerSelection
2830
private let warn: CommitCheckerSelection
2931
private let fail: CommitCheckerSelection
30-
let limit: Int
31-
private let customCheckers: [CommitChecker.Type]
32+
private let customCheckers: [CommitLint.Type]
3233

3334
/// Initialize the configuraiton.
3435
/// - Parameters:
@@ -42,7 +43,7 @@ public extension DangerSwiftCommitLint {
4243
warn: CommitCheckerSelection = .selected([]),
4344
fail: CommitCheckerSelection = .all,
4445
limit: Int = 0,
45-
customCheckers: [CommitChecker.Type] = []
46+
customCheckers: [CommitLint.Type] = []
4647
) {
4748
self.disabled = disabled
4849
self.warn = warn
@@ -54,15 +55,15 @@ public extension DangerSwiftCommitLint {
5455
}
5556

5657
extension DangerSwiftCommitLint.Configuration {
57-
static var defaultCheckers: [CommitChecker.Type] {
58-
CommitCheckerType.allCases.map(\.type)
58+
static var defaultCheckers: [CommitLint.Type] {
59+
DangerSwiftCommitLint.CommitCheckerType.allCases.map(\.type)
5960
}
6061

61-
var allCheckers: [CommitChecker.Type] {
62+
var allCheckers: [CommitLint.Type] {
6263
Self.defaultCheckers + customCheckers
6364
}
6465

65-
var disabledCheckers: [CommitChecker.Type] {
66+
var disabledCheckers: [CommitLint.Type] {
6667
switch disabled {
6768
case .all:
6869
return allCheckers
@@ -71,13 +72,13 @@ extension DangerSwiftCommitLint.Configuration {
7172
}
7273
}
7374

74-
var enabledCheckers: [CommitChecker.Type] {
75+
var enabledCheckers: [CommitLint.Type] {
7576
allCheckers.filter { checker in
7677
disabledCheckers.contains { $0 == checker } == false
7778
}
7879
}
7980

80-
var warningCheckers: [CommitChecker.Type] {
81+
var warningCheckers: [CommitLint.Type] {
8182
switch warn {
8283
case .all:
8384
return allCheckers
@@ -88,21 +89,21 @@ extension DangerSwiftCommitLint.Configuration {
8889
}
8990
}
9091

91-
var failingCheckers: [CommitChecker.Type] {
92+
var failingCheckers: [CommitLint.Type] {
9293
enabledCheckers.filter { type in
9394
warningCheckers.contains { $0 == type } == false
9495
}
9596
}
9697
}
9798

98-
private extension DangerSwiftCommitLint.Configuration.CommitCheckerType {
99-
var type: CommitChecker.Type {
99+
private extension DangerSwiftCommitLint.CommitCheckerType {
100+
var type: CommitLint.Type {
100101
switch self {
101-
case .bodyEmptyLine: return BodyEmptyLineCheck.self
102-
case .subjectCapCheck: return SubjectCapCheck.self
103-
case .subjectLengthCheck: return SubjectCapCheck.self
104-
case .subjectPeriodCheck: return SubjectPeriodCheck.self
105-
case .subjectWordCheck: return SubjectWordCheck.self
102+
case .bodyEmptyLine: return BodyEmptyLine.self
103+
case .subjectCapitalLetter: return SubjectCapitalLetter.self
104+
case .subjectLength: return SubjectCapitalLetter.self
105+
case .subjectPeriod: return SubjectPeriod.self
106+
case .subjectWord: return SubjectWord.self
106107
}
107108
}
108109
}

‎Sources/DangerSwiftCommitLint/DangerSwiftCommitLint.swift‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,12 +57,12 @@ extension DangerSwiftCommitLint {
5757
}
5858
}
5959

60-
extension Array where Element == CommitChecker.Type {
60+
extension Array where Element == CommitLint.Type {
6161
func checkCommitMessages(_ commitMessages: [GitCommitMessage], checkerResultHanler: (String, [String]) -> Void) {
6262
forEach { checker in
6363
let shas = commitMessages.compactMap { checker.fail($0) ? $0.sha : nil }
6464
if shas.isEmpty == false {
65-
checkerResultHanler(checker.checkerMessage, shas)
65+
checkerResultHanler(checker.linterMessage, shas)
6666
}
6767
}
6868
}

‎Tests/DangerSwiftCommitLintTests/CommitChecker/BodyEmptyLineCheckTests.swift‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,20 +8,20 @@ final class BodyEmptyLineCheckTests: XCTestCase {
88
private let commitNoNewline = GitCommitMessage(subject: "Title Test", bodyLinesOfText: ["Body Test"], sha: "Test SHA")
99

1010
func testSuccessCommitSubjectAndBody() {
11-
let testSubject = BodyEmptyLineCheck(commitSubjectAndBody)
11+
let testSubject = BodyEmptyLine(commitSubjectAndBody)
1212
XCTAssertFalse(testSubject.fail)
13-
XCTAssertFalse(BodyEmptyLineCheck.fail(commitSubjectAndBody))
13+
XCTAssertFalse(BodyEmptyLine.fail(commitSubjectAndBody))
1414
}
1515

1616
func testSuccessSubjectOnly() {
17-
let testSubject = BodyEmptyLineCheck(commitSubjectOnly)
17+
let testSubject = BodyEmptyLine(commitSubjectOnly)
1818
XCTAssertFalse(testSubject.fail)
19-
XCTAssertFalse(BodyEmptyLineCheck.fail(commitSubjectOnly))
19+
XCTAssertFalse(BodyEmptyLine.fail(commitSubjectOnly))
2020
}
2121

2222
func testFailureNoNewlineOnly() {
23-
let testSubject = BodyEmptyLineCheck(commitNoNewline)
23+
let testSubject = BodyEmptyLine(commitNoNewline)
2424
XCTAssertTrue(testSubject.fail)
25-
XCTAssertTrue(BodyEmptyLineCheck.fail(commitNoNewline))
25+
XCTAssertTrue(BodyEmptyLine.fail(commitNoNewline))
2626
}
2727
}

‎Tests/DangerSwiftCommitLintTests/CommitChecker/SubjectCapCheckTests.swift‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,30 +4,30 @@ import XCTest
44
final class SubjectCapCheckTests: XCTestCase {
55
func testSuccess() {
66
let commitMessage = GitCommitMessage(subject: "Subject", bodyLinesOfText: [], sha: "Test SHA")
7-
let testSubject = SubjectCapCheck(commitMessage)
7+
let testSubject = SubjectCapitalLetter(commitMessage)
88
XCTAssertFalse(testSubject.fail)
9-
XCTAssertFalse(SubjectCapCheck.fail(commitMessage))
9+
XCTAssertFalse(SubjectCapitalLetter.fail(commitMessage))
1010
}
1111

1212
func testFailure() {
1313
let commitMessage = GitCommitMessage(subject: "subject", bodyLinesOfText: [], sha: "Test SHA")
14-
let testSubject = SubjectCapCheck(commitMessage)
14+
let testSubject = SubjectCapitalLetter(commitMessage)
1515
XCTAssertTrue(testSubject.fail)
16-
XCTAssertTrue(SubjectCapCheck.fail(commitMessage))
16+
XCTAssertTrue(SubjectCapitalLetter.fail(commitMessage))
1717
}
1818

1919
func testSuccessWithNonLetterCharacters() {
2020
let commitMessage = GitCommitMessage(subject: "[TEST-123] Subject", bodyLinesOfText: [], sha: "Test SHA")
21-
let testSubject = SubjectCapCheck(commitMessage)
21+
let testSubject = SubjectCapitalLetter(commitMessage)
2222
XCTAssertFalse(testSubject.fail)
23-
XCTAssertFalse(SubjectCapCheck.fail(commitMessage))
23+
XCTAssertFalse(SubjectCapitalLetter.fail(commitMessage))
2424
}
2525

2626
/// Git generally disallows empty commit message, so subject should at least contain non empty text. This test case is only capturing a unlikely edge case.
2727
func testEdgeCase() {
2828
let commitMessage = GitCommitMessage(subject: "", bodyLinesOfText: [], sha: "Test SHA")
29-
let testSubject = SubjectCapCheck(commitMessage)
29+
let testSubject = SubjectCapitalLetter(commitMessage)
3030
XCTAssertFalse(testSubject.fail)
31-
XCTAssertFalse(SubjectCapCheck.fail(commitMessage))
31+
XCTAssertFalse(SubjectCapitalLetter.fail(commitMessage))
3232
}
3333
}

0 commit comments

Comments
 (0)