commitlint 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1c08bceaa83f676ef1ab85870b916fe5951de828d7e7cbf0429486cedf505d43
+  data.tar.gz: c6affec906aa7bcec8fa000b57cb2384fbc576de6e239ece4cc4c129646407ca
+SHA512:
+  metadata.gz: 75d60ee057605ff6d520a7207c7e89e80cd432c83b836db6980a68278f52275364010979c4f496b544fb20a587333206889c2ab5935ca091581203fd88ae2419
+  data.tar.gz: d488be8f3e339b81e123b4f49f5e7e3a6ac58c8e8ea1eb8ea38b012010df90de81e953c608ca3a27d5ae847bb61dd00f78df6b29b73b00ed373ffd5a9e4f2826

data/.rubocop.yml

@@ -0,0 +1,8 @@
+AllCops:
+  TargetRubyVersion: 3.0
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Arandi Lopez
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,64 @@
+# 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 <https://github.com/arandilopez/commitlint>. 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).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/exe/commitlint

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift("#{__dir__}/../lib")
+
+require "commitlint"
+
+exit Commitlint::Cli.start(ARGV)

data/lefthook.yml

@@ -0,0 +1,11 @@
+pre-commit:
+  # parallel: true
+  jobs:
+    - name: rubocop
+      glob: "*.rb"
+      run: rake rubocop {staged_files}
+
+commit-msg:
+  jobs:
+    - name: Lint commit message
+      run: ./exe/commitlint --message {1}

data/lib/commitlint/cli.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require "optparse"
+
+module Commitlint
+  # Cli class is responsible for handling command line arguments
+  class Cli
+    BANNER = <<~HELP.freeze
+      Commintlint v#{Commitlint::VERSION} - A CLI tool to lint commit messages with Conventional Commits.
+
+      Usage: commitlint --message [commit_message | filepath]
+
+      Examples:
+        commitlint --message "feat: add new feature"
+        commitlint --message "./path/to/commit_msg"
+        commitlint --message ".git/COMMIT_EDITMSG"
+
+      Options:
+    HELP
+
+    def initialize(argv)
+      @argv = argv
+      @options = {
+        message: nil,
+        quiet: false
+      }
+    end
+
+    def self.start(argv)
+      new(argv).run
+    end
+
+    def run
+      @argv << "-h" if @argv.empty?
+      parse_options!
+
+      return 0 if @options[:message].nil?
+
+      message = parse_input(@options[:message])
+      linter = Linter.new(message, output: !@options[:quite])
+
+      linter.lint!
+    end
+
+    private
+
+    def parse_options!
+      opt_parser = OptionParser.new do |opts|
+        opts.banner = BANNER
+        opts.on("-m", "--message MSG", "Commit message or file path, fallbacks to `.git/COMMIT_EDITMSG`") do |message|
+          @options[:message] = message.nil? ? ".git/COMMIT_EDITMSG" : message
+        end
+
+        opts.on("-q", "--quite", "Suppress output") { @options[:quite] = true }
+        opts.on("-h", "--help", "Show this help message") { puts opts }
+        opts.on("-v", "--version", "Show version") { puts Commitlint::VERSION }
+      end
+
+      opt_parser.parse!(@argv)
+    end
+
+    def parse_input(input)
+      File.exist?(input) ? File.read(input) : input
+    end
+  end
+end

data/lib/commitlint/linter.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Commitlint
+  # Linter class is responsible for linting commit messages.
+  class Linter
+    def initialize(commit_message, output: true)
+      @commit_message = clean_commit_message(commit_message)
+      @output = output
+    end
+
+    def lint!
+      validator = Validator.new(@commit_message)
+
+      return 0 if validator.valid?
+
+      errors = validator.errors
+
+      puts <<~MESSAGE if @output
+        \nYour commit message is invalid:
+
+        #{errors.map { |e| "=> #{e}" }.join("\n")}
+
+        Get help: https://github.com/conventional-changelog/commitlint/#what-is-commitlint\n
+      MESSAGE
+      1
+    end
+
+    private
+
+    def clean_commit_message(message)
+      message.strip.gsub(/#.*$/, "").strip
+    end
+  end
+end

data/lib/commitlint/validator.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module Commitlint
+  # Validator class is responsible for validating commit messages
+  # and elements inside the message to comply with Conventional Commit schema.
+  class Validator
+    attr_reader :errors
+
+    def initialize(commit_message)
+      @commit_message = commit_message
+      @has_validated = false
+      @errors = []
+    end
+
+    def valid?
+      validate!
+
+      errors.empty?
+    end
+
+    def validate!
+      return if @has_validated
+
+      commit_message_not_empty?
+      valid_format?
+      valid_type?
+      valid_scope?
+      subject_not_empty?
+
+      @has_validated = true
+    end
+
+    def commit_message_not_empty?
+      @errors << "Commit message cannot be empty." if @commit_message.empty?
+    end
+
+    def valid_format?
+      @matches = @commit_message.match(Commitlint::CONVENTIONAL_COMMIT_SCHEMA)
+
+      @errors << "Invalid commit message format." unless @matches
+    end
+
+    def valid_scope?
+      invalid_scope = @matches && @matches[:scope] && @matches[:scope].size < 2
+      @errors << "Scope is invalid. Must be at least 2 characters" if invalid_scope
+    end
+
+    def valid_type?
+      valid_type = @matches && @matches[:type] && Commitlint::VALID_TYPES.include?(@matches[:type])
+      @errors << "Type is invalid, must be one of \"#{Commitlint::VALID_TYPES.join(", ")}\"." unless valid_type
+    end
+
+    def subject_not_empty?
+      @errors << "Subject is empty." if @matches && (@matches[:subject].nil? || @matches[:subject].empty?)
+    end
+  end
+end

data/lib/commitlint/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Commitlint
+  VERSION = "0.1.0"
+end

data/lib/commitlint.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require_relative "commitlint/version"
+require_relative "commitlint/validator"
+require_relative "commitlint/linter"
+require_relative "commitlint/cli"
+
+module Commitlint
+  class Error < StandardError; end
+
+  VALID_TYPES = %w[feat fix docs style refactor perf test chore revert].freeze
+  CONVENTIONAL_COMMIT_SCHEMA = /(?x)
+    ^(?<type>#{VALID_TYPES.join("|")})  # Type
+    (\((?<scope>.*?)\))?                # Optional scope
+    !?                                  # Optional exclamation mark
+    :                                   # Required colon
+    \s                                  # Required space
+    (?<subject>.*)                      # Required subject
+    (\n\n(?<body>.*))?                  # Optional body
+    (\n\n(?<footer>.*))?                # Optional footer
+  /
+end

data/sig/commitlint.rbs

@@ -0,0 +1,4 @@
+module Commitlint
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: commitlint
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Arandi Lopez
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2025-05-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: optparse
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Lint your commit messages to ensure they follow the conventional commit
+  format.
+email:
+- arandilopez.93@gmail.com
+executables:
+- commitlint
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- exe/commitlint
+- lefthook.yml
+- lib/commitlint.rb
+- lib/commitlint/cli.rb
+- lib/commitlint/linter.rb
+- lib/commitlint/validator.rb
+- lib/commitlint/version.rb
+- sig/commitlint.rbs
+homepage: https://github.com/aranido/commitlint
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/aranido/commitlint
+  source_code_uri: https://github.com/aranido/commitlint
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.12
+signing_key:
+specification_version: 4
+summary: Conventional commint linter for Ruby projects
+test_files: []