Location via proxy:   [ UP ]  
[Report a bug]   [Manage cookies]                
Skip to content

commitlint - Lint commit messages for Dart and Flutter projects

License

Notifications You must be signed in to change notification settings

manjarqo/commitlint

 
 

Repository files navigation

commitlint

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

Getting started

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

Install

# Install commitlint cli and upstream configure if needed
dart pub add --dev commitlint_cli commitlint_config

Configuration

# Configure commitlint to use conventional config
echo "include: package:commitlint_config/commitlint.yaml" > commitlint.yaml

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
# Lint last commit from history
commitlint --from=HEAD~1

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

Packages

Project Status Description
commitlint_cli Pub Version commitlint command-line tool entry
commitlint_config Pub Version commitlint rules configuration, can be included.
commitlint_format Pub Version commitlint output formatting package.
commitlint_lint Pub Version commitlint linting package
commitlint_load Pub Version load configured rules for commitlint
commitlint_read Pub Version read commit message for commitlint.
commitlint_rules Pub Version rules set of commitlint.
commitlint_types Pub Version types package for commitlint.

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

About

commitlint - Lint commit messages for Dart and Flutter projects

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Dart 99.6%
  • Shell 0.4%