Partas.Tools.ConventionalCommits 0.3.0

.NET 8.0

dotnet add package Partas.Tools.ConventionalCommits --version 0.3.0

NuGet\Install-Package Partas.Tools.ConventionalCommits -Version 0.3.0

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="Partas.Tools.ConventionalCommits" Version="0.3.0" />

For projects that support PackageReference, copy this XML node into the project file to reference the package.

<PackageVersion Include="Partas.Tools.ConventionalCommits" Version="0.3.0" />
                    

                            Directory.Packages.props

<PackageReference Include="Partas.Tools.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 Partas.Tools.ConventionalCommits --version 0.3.0

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: Partas.Tools.ConventionalCommits, 0.3.0"

#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 Partas.Tools.ConventionalCommits@0.3.0

#: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=Partas.Tools.ConventionalCommits&version=0.3.0
                    

                            Install as a Cake Addin

#tool nuget:?package=Partas.Tools.ConventionalCommits&version=0.3.0
                    

                            Install as a Cake Tool

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

Partas.ConventionalCommits

Conventional Commit parser using FSharps XParsec. This implies potential compatability with Fable, and improved speed and resource usage over Regex designs.

Made with consumability from Dotnet in mind.

Install

dotnet add package Partas.Tools.ConventionalCommits

paket install Partas.Tools.ConventionalCommits

[IMPORTANT!] The namespace is Partas.ConventionalCommits.

The nuget package name is historical.

Tests

Tests check for correctness according to the spec. Ambiguity in the spec has left some ambiguity that I describe below:

[NOTE!] Conventional Commit spec describes footers as being required to be separated from the Body by one new line. There is no description of the requirements if there is no body.

[NOTE!] Conventional Commit spec does not put any requirement for the content of a footer value, other than it HAS to follow a footer key by a valid delimiter: ": " or " #". You can technically EOF right after, or just provide no value, and that is still a footer.

Product	Compatible and additional computed target framework versions.
.NET	net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. net9.0 was computed. 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.

Product

.NET

Compatible target framework(s)

Included target framework(s) (in package)

Learn more about Target Frameworks and .NET Standard.

net8.0
- FSharp.Core (>= 9.0.300)
- XParsec (>= 0.2.1)

NuGet packages (1)

Showing the top 1 NuGet packages that depend on Partas.Tools.ConventionalCommits:

Package	Downloads
Partas.GitNet Git that .Net F#	1.1K

GitHub repositories

This package is not used by any popular GitHub repositories.