CharTek.ConventionalCommits 0.1.2

dotnet add package CharTek.ConventionalCommits --version 0.1.2
                    
NuGet\Install-Package CharTek.ConventionalCommits -Version 0.1.2
                    
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="CharTek.ConventionalCommits" Version="0.1.2" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="CharTek.ConventionalCommits" Version="0.1.2" />
                    
Directory.Packages.props
<PackageReference Include="CharTek.ConventionalCommits" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add CharTek.ConventionalCommits --version 0.1.2
                    
#r "nuget: CharTek.ConventionalCommits, 0.1.2"
                    
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package CharTek.ConventionalCommits@0.1.2
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=CharTek.ConventionalCommits&version=0.1.2
                    
Install as a Cake Addin
#tool nuget:?package=CharTek.ConventionalCommits&version=0.1.2
                    
Install as a Cake Tool

CharTek.ConventionalCommits

A .NET library to easily parse Git commit messages into a format compatible with the Conventional Commits specification v1.0.0.

Usage

string message = "feat(lang): add Polish language";

// Parse git commit message string
ConventionalCommitMessage commit = ConventionalCommitMessage.Parse(message);

// Alternatively, TryParse can be used:
bool canParse = ConventionalCommitMessage.TryParse(message, out var alternativeCommit);

// Now we can access properties of the conventional commit:
string type = commit.CommitType;
string desc = commit.Description;
string? scope = commit.Scope;
string? body = commit.Body;
bool isBreaking = commit.IsBreakingChange;

License

CharTek.ConventionalCommits Copyright (C) 2025 CharTek Softworks

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License along with this program. If not, see https://www.gnu.org/licenses/.

Product Compatible and additional computed target framework versions.
.NET net9.0 is compatible.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
  • net9.0

    • No dependencies.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
0.1.2 546 3/24/2025
0.1.1 2,972 3/24/2025
0.1.0 455 3/24/2025