alexanderwe/ConventionalCommitsKit

Installation

Swift Package Manager

To integrate using Apple's Swift Package Manager, add the following as a dependency to your Package.swift:

dependencies: [
    .package(url: "https://github.com/alexanderwe/ConventionalCommitsKit.git", from: "1.0.0")
]

Alternatively navigate to your Xcode project, select Swift Packages and click the + icon to search for ConventionalCommitsKit.

Manually

If you prefer not to use any of the aforementioned dependency managers, you can integrate ConventionalCommitsKit into your project manually. Simply drag the Sources Folder into your Xcode project.

Usage

At first import ConventionalCommitsKit

import ConventionalCommitsKit

Define a ConventionalCommit based on a commit message. Be aware that the parsing can fail and throw an appropriate error.

let commitMessage = """
fix: correct minor typos in code

see the issue for details

on typos fixed.

Reviewed-by #Z
Refs #133
"""

let commit = try ConventionalCommit(input: commitMessage)

Contributing

Contributions are very welcome 🙌

Package Metadata

Repository: alexanderwe/ConventionalCommitsKit

Homepage: https://alexanderwe.github.io/ConventionalCommitsKit/documentation/conventionalcommitskit

Stars: 5

Forks: 0

Open issues: 0

Default branch: main

Primary language: swift

License: MIT

Topics: conventional-commits, parser, swift, swift5

README: README.md