rocks.cleancode.conventionalcommit

Class ConventionalCommitParser

java.lang.Object

rocks.cleancode.conventionalcommit.ConventionalCommitParser

public class ConventionalCommitParser
extends Object

Conventional commit message parser.

Based on specification Conventional Commits v1.0.0.

Since:

1.0.0

Field Summary

Fields

Modifier and Type	Field and Description
static List<String>	RECOMMENDED_TYPES Recommended types in Conventional Commits v1.0.0: fix, feat, build, chore, ci, docs, style, refactor, perf or test

Constructor Summary

Constructors

Constructor and Description
ConventionalCommitParser() Default constructor with types defined with RECOMMENDED_TYPES.
ConventionalCommitParser(String... types) Constructor with allowed types.

Method Summary

Modifier and Type	Method and Description
ConventionalCommit	parse(String fullCommitMessage) Parse raw conventional commit message.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

RECOMMENDED_TYPES

public static final List<String> RECOMMENDED_TYPES

Recommended types in Conventional Commits v1.0.0: fix, feat, build, chore, ci, docs, style, refactor, perf or test

Since:

1.2.0

Constructor Detail

ConventionalCommitParser

public ConventionalCommitParser()

Default constructor with types defined with RECOMMENDED_TYPES.

Since:

1.0.0

ConventionalCommitParser

public ConventionalCommitParser(String... types)

Constructor with allowed types.

Parameters:

types - List of allowed types

Since:

1.2.0

Method Detail

parse

public ConventionalCommit parse(String fullCommitMessage)

Parse raw conventional commit message.

Parameters:

fullCommitMessage - Raw conventional commit message

Returns:

Parsed conventional commit message

Since:

1.0.0