https://github.com/arandilopez/commitlint
A pure-ruby alternative to use with your git hooks
https://github.com/arandilopez/commitlint
conventional-commits rubygem
Last synced: 3 months ago
JSON representation
A pure-ruby alternative to use with your git hooks
- Host: GitHub
- URL: https://github.com/arandilopez/commitlint
- Owner: arandilopez
- License: mit
- Created: 2025-05-07T16:38:59.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2026-03-03T16:23:29.000Z (3 months ago)
- Last Synced: 2026-03-03T20:41:26.133Z (3 months ago)
- Topics: conventional-commits, rubygem
- Language: Ruby
- Homepage:
- Size: 33.2 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Commitlint
This is a pure-ruby alternative to [commitlint](https://commitlint.js.org/).
It's simple and does what it needs to do: lint your commit messages.
## Installation
Install the gem and add to the application's `Gemfile` by executing:
bundle add commitlint --group "development"
If bundler is not being used to manage dependencies, install the gem by executing:
gem install commitlint
## Usage
The best way to use this gem is to add it to your `commit-msg` hook.
You can do this with [lefthook](https://lefthook.dev/)
First, install `lefthook` and `commitlint`:
```ruby
group :development do
gem "lefthook", require: false
gem "commitlint", require: false
end
```
Then, set up your `lefthook.yml` file with a `commit-msg` hook:
```yaml
commit-msg:
jobs:
- name: Lint commit message
run: bundle exec commitlint --message {1}
```
In fact, this repository lints its own commit messages using this gem.
## Configuration
This gem does not require any configuration. It will lint your commit messages and that's it.
I'm not planning to add any configuration options, because I think that the default behavior and rules are good enough.
The goal is provide a simple and fast way to lint your commit messages according to the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification.
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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 the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
## Contributing
Bug reports and pull requests are welcome on GitHub at . This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/arandilopez/commitlint/blob/main/CODE_OF_CONDUCT.md).
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
## Code of Conduct
Everyone interacting in the Commitlint project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/arandilopez/commitlint/blob/main/CODE_OF_CONDUCT.md).