commitlint_cli
0.8.1, released 2 years ago by an unverified publisher
CLI tool that lints commit messages against the Conventional Commits spec.
What it does
It reads commit messages from stdin or a git hook and checks them against configurable rules. Errors are reported with details about rule violations.
AI-written summary of version 0.8.1, based on the package's README and metadata. Report an inaccuracy
Use it when
- You want to enforce Conventional Commits in a Dart/Flutter project
- You need a simple, dev‑dependency‑only lint step for commit messages
Skip it when
- You need GUI commit assistance or integration with non‑Dart CI tools
- You require advanced commit‑message templating beyond rule checks
Strengths
- Zero runtime dependencies for the app itself (dev only)
- Configurable via a YAML file and supports custom rules
- Works with husky and other git‑hook managers
Weaknesses
- Only works as a CLI, not as a library you can call from code
- Limited to Conventional Commits; not a full git‑workflow tool
Setup
- Kind
- Pure Dart
- Effort
- Low
- Code generation
- No
- Direct dependencies
- 6
# commitlint.yaml
include: package:commitlint_cli/commitlint.yaml
rules:
type-case:
- 2
- always
- 'upper-case'
# lint a commit message
echo 'feat: add login' | dart run commitlint_cliAlternatives
Packages that do the same job and could replace commitlint_cli.
- conventional_commit
Parse a git commit message using the Conventional Commits specification.
74Compare - msgpack_dart
MessagePack implementation for Dart
50Compare
Works with
Packages commonly used together with commitlint_cli: ones it builds on, ones built on it, and its own family.
- yamlcommitlint_cli depends on itA Dart library for parsing YAML documents into Dart data structures.
- argscommitlint_cli depends on itLibrary for parsing raw command-line arguments into options and values using GNU and POSIX styles.
- change_casecommitlint_cli depends on itExtension on String to convert between many common case styles
- ansicommitlint_cli depends on itTerminal string styling with builtin style functions and string extensions.