CommitMessage class

Represents a git commit message

A rough format of a typical Conventional Commit is:

type: description

body

footer

See conventionalcommits.org for more information on how to format commits. following the spec.

Constructors

CommitMessage({String? type, CommitMessageHeader? header, String? description, bool? breaking, String? scope, String? body, List<CommitMessageFooter>? footer, List<String>? parsingErrors})
Creates a CommitMessage

Properties

body → String
The commit body
final
breaking → bool
Whether this commit is a breaking change
no setter
description → String
The commit description
no setter
Footer of the commits
final
hashCode → int
The hash code for this object.
no setterinherited
The commit message header
final
isConventional → bool
Whether this follows the Conventional Commit format
no setter
parsingErrors → List<String>
See all the parsing errors generated from Commit.parse
no setter
props → List<Object?>
The list of properties that will be used to determine whether two instances are equal.
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
scope → String
The scope of the commit
no setter
stringify → bool?
If set to true, the toString method will be overridden to output this instance's props.
no setterinherited
type → String
A commit type following Conventional Commit
no setter

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
override

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

parse(String commitMessageStr) → CommitMessage
Parses a commit message string
parseCommitLines(List<String> lines) → CommitMessage
Parses a List<String> from a commit message string