https://github.com/alexanderwe/conventionalcommitskit

A small library to create and parse Conventional Commit conforming representations.
https://github.com/alexanderwe/conventionalcommitskit

conventional-commits parser swift swift5

Last synced: 23 days ago
JSON representation

A small library to create and parse Conventional Commit conforming representations.

• Host: GitHub
• URL: https://github.com/alexanderwe/conventionalcommitskit
• Owner: alexanderwe
• License: mit
• Created: 2020-12-28T16:02:43.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2022-07-17T22:05:13.000Z (over 2 years ago)
• Last Synced: 2024-03-14T11:21:24.569Z (8 months ago)
• Topics: conventional-commits, parser, swift, swift5
• Language: Swift
• Homepage: https://alexanderwe.github.io/ConventionalCommitsKit/documentation/conventionalcommitskit
• Size: 233 KB
• Stars: 5
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# ConventionalCommitsKit



    

      

   

   

      

   

   

      

   





   ConventionalCommitsKit is a small library to create and parse Conventional Commit conforming representations.



## Installation

### Swift Package Manager

To integrate using Apple's [Swift Package Manager](https://swift.org/package-manager/), add the following as a dependency to your `Package.swift`:

```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`

```swift

import ConventionalCommitsKit

```

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

```swift

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 🙌