:rabbit2: A fully configurable git commit message linter CLI tool, based on https://conventionalcommits.org standards.
A fully configurable git commit message linter CLI tool, based on https://conventionalcommits.org standards.
Add this line to your application’s Gemfile:
gem 'commit_lint'
And then execute:
$ bundle
Or install it yourself as:
$ gem install commit_lint
Just type commit-lint in a Git project’s folder to start linting your last
commit,
$ commit-lint
to run commit-lint against you current branch run
$ commit-lint -b
or other branche,
$ commit-lint -b other-branche-name
commits range
$ commit-lint -c 2343..2342
and you can add -a
flag to run autocorrect against failing commits
$ commit-lint -a
After checking out the repo, run bin/setup
to install dependencies. Then, run rake spec
to run the tests. You can also run bin/console
for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run bundle exec rake install
. To release a new version, update the version number in version.rb
, and then run bundle exec rake release
, which will create a git tag for the version, push git commits and tags, and push the .gem
file to rubygems.org.
Bug reports and pull requests are welcome on GitHub at https://github.com/adham90/commit-lint. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.
The gem is available as open source under the terms of the MIT License.