Merge pull request #4 from AppDifferentia/add-commit-lint-implementation

Add commit lint implementation

Author: weisunOW

Sources/DangerSwiftCommitLint/CommitChecker/BodyEmptyLine.swift

@@ -0,0 +1,15 @@
+import Foundation
+
+struct BodyEmptyLine: CommitLint, Hashable {
+    static var linterMessage = "Please separate commit message subject from body with newline."
+
+    private let bodyLinesOfText: [String]
+
+    init(_ commitMessage: GitCommitMessage) {
+        bodyLinesOfText = commitMessage.bodyLinesOfText
+    }
+
+    var fail: Bool {
+        bodyLinesOfText.isEmpty ? false : bodyLinesOfText.first?.isEmpty == false
+    }
+}

Sources/DangerSwiftCommitLint/CommitChecker/BodyEmptyLineCheck.swift

@@ -0,0 +1,17 @@
+import Foundation
+
+public protocol CommitLint {
+    static var linterMessage: String { get }
+
+    var fail: Bool { get }
+
+    init(_ commitMessage: GitCommitMessage)
+
+    static func fail(_ commitMessage: GitCommitMessage) -> Bool
+}
+
+public extension CommitLint {
+    static func fail(_ commitMessage: GitCommitMessage) -> Bool {
+        Self(commitMessage).fail
+    }
+}

Sources/DangerSwiftCommitLint/CommitChecker/CommitChecker.swift

@@ -0,0 +1,31 @@
+import Danger
+import Foundation
+
+/// An abstraction of Git commit message for `DangerSwiftCommitLint`.
+public struct GitCommitMessage: Hashable {
+    /// First line of the commit message
+    public let subject: String
+    /// Rest of the commit message
+    public let bodyLinesOfText: [String]
+    // Commit SHA value
+    public let sha: String?
+
+    init(
+        subject: String,
+        bodyLinesOfText: [String],
+        sha: String
+    ) {
+        self.subject = subject
+        self.bodyLinesOfText = bodyLinesOfText
+        self.sha = sha
+    }
+
+    /// Initialize `GitCommitMessage` with `Danger.Git.Commit.message`
+    /// - Parameter gitCommit: An instance of `Danger.Git.Commit`
+    public init(_ gitCommit: Git.Commit) {
+        let commitMessageLines = gitCommit.message.components(separatedBy: .newlines)
+        subject = commitMessageLines.first ?? ""
+        bodyLinesOfText = Array(commitMessageLines.dropFirst())
+        sha = gitCommit.sha
+    }
+}

Sources/DangerSwiftCommitLint/CommitChecker/CommitLint.swift

@@ -0,0 +1,15 @@
+import Foundation
+
+struct SubjectCapitalLetter: CommitLint, Hashable {
+    static let linterMessage = "Please start commit message subject with capital letter."
+
+    private let firstCharacter: Character?
+
+    init(_ commitMessage: GitCommitMessage) {
+        firstCharacter = commitMessage.subject.first
+    }
+
+    var fail: Bool {
+        firstCharacter?.isLowercase ?? false
+    }
+}

Sources/DangerSwiftCommitLint/CommitChecker/CommitMessage.swift

@@ -1,25 +1,25 @@
 import Foundation
 
-struct SubjectLengthCheck: CommitChecker {
+struct SubjectLength: CommitLint, Hashable {
     private enum GeneratedSubjectPattern {
         static let git = #"^Merge branch '.+' into "#
         static let gitHub = #"^Merge pull request #\d+ from "#
     }
 
-    static let warningMessage = "Please limit commit message subject line to 50 characters."
+    static let linterMessage = "Please limit commit message subject line to 50 characters."
 
     private let subject: String
 
-    init(message: CommitMessage) {
-        subject = message.subject
+    init(_ commitMessage: GitCommitMessage) {
+        subject = commitMessage.subject
     }
 
     var fail: Bool {
         subject.count > 50 && isMergeCommit == false
     }
 }
 
-private extension SubjectLengthCheck {
+private extension SubjectLength {
     var isMergeCommit: Bool {
         subject =~ GeneratedSubjectPattern.git || subject =~ GeneratedSubjectPattern.gitHub
     }

Sources/DangerSwiftCommitLint/CommitChecker/GitCommitMessage.swift

@@ -0,0 +1,15 @@
+import Foundation
+
+struct SubjectPeriod: CommitLint, Hashable {
+    static var linterMessage = "Please remove period from end of commit message subject line."
+
+    private let subject: String
+
+    init(_ commitMessage: GitCommitMessage) {
+        subject = commitMessage.subject
+    }
+
+    var fail: Bool {
+        subject.last == "."
+    }
+}