ConventionalCommit class
A representation of a parsed conventional commit message.
Parsing is based upon the Conventional Commits 1.0.0 specification available at https://www.conventionalcommits.org/en/v1.0.0/
Properties
- body → String?
-
An optional body describing the change in more detail.
final
- breakingChangeDescription → String?
-
The description of the breaking change, e.g. the text after BREAKING
CHANGE:
final
- description → String?
-
Commit message description (text after the scopes).
final
-
Footers other than BREAKING CHANGE:
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- header → String
-
The original commit message header (this is normally the first line of the
commit message.)
final
- isBreakingChange → bool
-
Whether this commit was a breaking change, e.g.
!was specified after the scopes in the commit message.final - isFeature → bool
-
Whether this commit adds a new feature.
no setter
- isFix → bool
-
Whether this commit represents a bug fix.
no setter
- isMergeCommit → bool
-
Whether this commit was a merge commit, e.g.
Merge #24 into mainfinal - runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
scopes
→ List<
String> -
A List of scopes in the commit, returns empty List if no scopes found.
final
- type → String?
-
The type specified in this commit, e.g.
feat.final
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
-
tryParse(
String commitMessage) → ConventionalCommit? - Create a new ConventionalCommit from a commit message String.