lppedd / conventional-commit

A small java library to parse conventional commits

conventional-commit

A small java library to parse Conventional Commits

API

Optional<Commit> commit = ConventionalCommit.parse(
    "feat(widget): Add thingy to widget\n\nWidgets now work with sprockets\n\nFixes #13"
);

commit.isPresent(); // true

commit.type;        // "feat"
commit.scope;       // "widget"
commit.description  // "Add thingy to widget"
commit.body;        // "Widgets now work with sprockets"
commit.footer;      // "Fixes #13"

Building

This project requires Maven and Java 8+.

$ mvn clean test