hyiso / commitlint

commitlint - Lint commit messages for Dart and Flutter projects

commitlint

Dart version commitlint - A tool to lint commit messages. (Inspired by JavaScript commitlint)

commitlint lint commit messages to satisfy conventional commit format

commitlint helps your team adhere to a commit convention. By supporting pub-installed configurations it makes sharing of commit conventions easy.

About Package Name

Because a package commit_lint already exists (not in active development), the name commitlint can't be used according to Pub's naming policy. So commitlint_cli is used currently.

Getting started

Install

Add commitlint_cli to your dev_dependencies in pubspec.yaml

# Install commitlint_cli
dart pub add --dev commitlint_cli

Configuration

# Simply use configuration of a package
echo "include: package:commitlint_cli/commitlint.yaml" > commitlint.yaml

You can also customize your configuration in commitlint.yaml

# Inherit configuration of a package
include: package:commitlint_cli/commitlint.yaml

# Custom rules
rules:
  type-case:
    - 2
    - always
    - 'upper-case'

# Whether commitlint uses the default ignore rules.
defaultIgnores: true
# Pattern that matches commit message if commitlint should ignore the given message.
ignores:
  - r'^fixup'

Test

# Lint from stdin
echo 'foo: bar' | dart run commitlint_cli
⧗  input: type: add docs
✖  type must be one of [build, chore, ci, docs, feat, fix, perf, refactor, revert, style, test] type-enum

✖  found 1 errors, 0 warnings

Note: output on successful commit will be omitted, you can use the VERBOSE=true env to get positive output. (Functionality of verbose)

# Output on successful commit will be omitted
echo 'feat: test message' | dart run commitlint_cli
# Verbse Output on successful commit
echo 'feat: test message' | VERBOSE=true dart run commitlint_cli

Setup git hook

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

Set commit-msg hook:

dart pub add --dev husky
dart run husky install
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

To get the most out of commitlint you'll want to automate it in your project lifecycle. See our Setup guide for next steps.

Documentation

See documention

• Guides - Common use cases explained in a step-by-step pace
• Concepts - Overarching topics important to understand the use of commitlint
• Reference - Mostly technical documentation

commitlint's Issues

Success prints empty line

When the tool succeeds an empty line is printed. It's a bit ugly, especially if you use a git hook

Support body in commit message

A commit body is free-form and MAY consist of any number of newline separated paragraphs.

Currently a body in a commit message breaks the ci while the local git hook succeds

How to use it in Github Actions?

Hi, I'm trying to use commitlint in Github Actions to validate commit messages in the CI. For some reason I can't get it to fail when it should. The current workflow is at nextcloud/neon@a32ce68. I was able to get it working locally with https://github.com/nektos/act when using --from=main --to=@, but that also didn't work on Github Actions. Can someone help me get this working? I'm not sure if the workflow is the problem or if there is a bug in this tool.

Ignore fixup commits

When using the commit-msg hook it would be nice to ignore fixup commits. For CI purposes I see that it could make sense to block them since you don't want to merge fixup commits, but that's not the goal of this tool.

My workaround for this is just using this as the hook: sed "s/^fixup! //" < "$1" | dart run commitlint_cli

Add `references-empty` rule

Hi!

In the JavaScript version of commitlint, there is a rule references-empty that can check for ticket numbers like:

feat: foo bar 

#3

or

feat: foo bar

PROJ-23

It would be nice, if you can support those as well.

Thanks! :)

Refactor `parse`

Optional parts like body, footer

Hi,

is it possible to set rules for optional parts?

For example it should be optional to add a body, but if a body is added body-leading-blank should be enforced.

When I tried setting this up there is always an error when there is no body.

Support multiple scopes

It seems like multiple scopes are supported in other tools like conventional-changelog/commitlint#901. Would it be possible to implement that here as well? A lot of dart/flutter projects are monorepos and thus can make good use of that.