commitlint_cli 0.2.1

Commitlint is a tool for lint commit messages. This package is the commitlint command line tool entry.

commitlint_cli

Dart version commitlint cli (known in JavaScript comunity)

commitlint cli lint commit messages to satisfy conventional commit format

With husky (a tool for managing git hooks), commitlint cli can be used as commmit-msg git hook

Usage

Add commitlint_cli and husky to your dev_dependencies in pubspec.yaml

dev_dependencies:
  commitlint_cli: latest
  husky: latest

Get dependencies and install husky

dart pub get
dart run husky install

Set the commit-msg hook:

dart run husky set .husky/commit-msg 'dart run commitlint_cli --edit "$1"'

Make a commit:

git add .
git commit -m "Keep calm and commit"
# `dart run commitlint_cli --edit "$1"` will run

Documentation

See documention