conventional_commits 0.2.23 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 47ee970c18a0739f838c1de2019974654bd6f4698e364d864a807bebd579c442
-  data.tar.gz: d75c131ba2000b7aebdcc6b9c8164a5fb17a8c7b7c238c1863ec560a2f8fa693
+  metadata.gz: 3f94b502d6513ea200421a55aa11f6b4256fba4f97ca7151377102628b6c697a
+  data.tar.gz: d1e38a90cbbdafbd4225896a03a510511726587367184bfa2130e8327ce5e6c6
 SHA512:
-  metadata.gz: 9ce7cfee46f6f0954543e056b346c68c3a9fd0428ed9a89cd8241df9e04873a39428b3214274fdd2880d4ba71ef6b08d58b7387dfc96d31bf7a22c2c26886c77
-  data.tar.gz: f29c2b32b96c9d6cf1a9d3121f4ca993956ca410c53d5e0f453dce35a917e71e48db95d9b779dd4baad87c5c57fd78359b074260e96fcc9fbd85bbaccaf4fb0c
+  metadata.gz: 687b3c6cffc0a5df6df27d8b872bb518fd893fc168210d4c59aee70eca79cdcf696efaf643635de37010b04535b0183d4f546e6accbc5772e7ef7ca0b759437e
+  data.tar.gz: a29267a2aae48205181b7e4553ada4577abc2927317a78bdbe44319460d3d5b582f81ba8224a695a299cdb922384486dbe5db6f106d2e1900016916d1815dc12

data/.pre-commit-hooks.yaml

@@ -5,4 +5,23 @@
   language: ruby
   language_version: 3.2.2
   always_run: true
-  pass_filenames: false
+  pass_filenames: false
+
+- id: validate_message
+  name: Message Validation
+  description: "Validate commit message"
+  entry: "conventional_commits validate_commit_msg"
+  language: ruby
+  language_version: 3.2.2
+  pass_filenames: false
+  always_run: true
+
+- id: prepare_message
+  name: Prepare Commit Message
+  description: "Preparing commit message"
+  entry: "conventional_commits prepare_commit_msg"
+  language: ruby
+  language_version: 3.2.2
+  pass_filenames: false
+  args: [--source=$PRE_COMMIT_COMMIT_MSG_SOURCE]
+  always_run: true

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    conventional_commits (0.2.21)
+    conventional_commits (0.3.0)
       open3
       thor
       yaml
@@ -104,6 +104,8 @@ GEM
 PLATFORMS
   arm64-darwin-23
   arm64-darwin-24
+  arm64-darwin-25
+  x86_64-linux
 
 DEPENDENCIES
   aruba

data/lib/branch/branch_name_generator.rb

@@ -2,10 +2,12 @@
 
 module ConventionalCommits
   class BranchNameGenerator
-    attr_reader :reader
+    attr_reader :reader, :main_reader
 
-    def initialize(reader: reader = Configuration::BranchConfigurationReader.new)
+    def initialize(reader: reader = Configuration::BranchConfigurationReader.new,
+                   main_reader: Configuration::MainConfigurationReader.new)
       @reader = reader
+      @main_reader = main_reader
     end
 
     def generate_name_for(_input, path: Configuration::DEFAULT_CONFIGURATION_PATH)
@@ -34,12 +36,31 @@ module ConventionalCommits
       components
     end
 
+    # A branch is valid when the commit message generator can build a subject from it: the
+    # type must be one the configuration allows, and the description must not be empty.
     def is_valid_branch(_input, path: Configuration::DEFAULT_CONFIGURATION_PATH)
-      !branch_name_components(_input, path:).empty?
+      components = branch_name_components(_input, path:)
+      validate_description(components[:description], branch: _input)
+      validate_type(components[:type], path:)
+      true
     end
 
     private
 
+    def validate_description(description, branch:)
+      return unless description.to_s.strip.empty?
+
+      raise GenericError, "The branch #{branch} has no description"
+    end
+
+    def validate_type(type, path:)
+      type_configuration = main_reader.get_configuration(path:).type
+      return if type_configuration.is_allowed(type.to_s.downcase)
+
+      raise GenericError,
+            "The type #{type} is not allowed. Allowed types #{type_configuration.all_types}"
+    end
+
     def find_delimiters_from_pattern(pattern: string)
       delimiters = pattern.gsub(/<scope>/, "<replace>")
                           .gsub(/<type>/, "<replace>")

data/lib/cli/branch_name_cli.rb

@@ -24,44 +24,48 @@ module ConventionalCommits
     option :source, type: :string, required: false
     option :cfg_path, type: :string, required: false
     def prepare_commit_msg
-      source = options["source"] || ""
-      puts source
+      source = options["source"] || ENV["PRE_COMMIT_COMMIT_MSG_SOURCE"] || ""
       msg_path = options["msg_path"] || Configuration::DEFAULT_COMMIT_MSG_PATH
       cfg_path = options["cfg_path"] || Configuration::DEFAULT_CONFIGURATION_PATH
 
+      return if Configuration.git_generated_message?(msg_path)
+
       generator = ConventionalCommits::CommitMessageGenerator.new
       unless generator.should_preserve_original_message(source:)
         puts "Generating message"
         name = generator.prepare_message_template_for_type(type: source, cfg_path:, msg_file_path: msg_path)
         File.write_to_file(msg_path, name)
       end
-      
     rescue StandardError => e
       raise Thor::Error, e.message
     end
 
     desc "validate_branch", "validates if the branch conforms to the rules"
     option :cfg_path, type: :string, required: false
+    option :branch, type: :string, required: false,
+                    desc: "Branch to validate; defaults to the current branch, then $GITHUB_HEAD_REF"
     def validate_branch_name
       cfg_path = options["cfg_path"] || Configuration::DEFAULT_CONFIGURATION_PATH
       generator = ConventionalCommits::BranchNameGenerator.new
-      name = ConventionalCommits::Git.new.current_branch_name
-      generator.is_valid_branch(name.strip, path: cfg_path.strip)
+      generator.is_valid_branch(branch_name_to_validate, path: cfg_path.strip)
     rescue StandardError => e
       raise Thor::Error, e.message
     end
 
-    desc "validate_commit_msg", "validates if the branch conforms to the rules"
+    desc "validate_commit_msg", "validates if the commit message conforms to the rules"
     option :msg_path, type: :string, required: false
-    option :msg, type: :string, required: false
+    option :msg, type: :string, required: false, desc: "Message text to validate instead of a file"
     option :cfg_path, type: :string, required: false
     def validate_commit_msg
-
       msg_path = options["msg_path"] || Configuration::DEFAULT_COMMIT_MSG_PATH
       cfg_path = options["cfg_path"] || Configuration::DEFAULT_CONFIGURATION_PATH
       validator = ConventionalCommits::CommitMessageValidator.new
 
-      validator.validate_commit_msg_from_file(commit_msg_path: msg_path, cfg_path:)
+      if options["msg"]
+        validator.validate_commit_msg(message: options["msg"], cfg_path:)
+      else
+        validator.validate_commit_msg_from_file(commit_msg_path: msg_path, cfg_path:)
+      end
     rescue StandardError => e
       raise Thor::Error, e.message
     end
@@ -73,5 +77,18 @@ module ConventionalCommits
     rescue StandardError => e
       raise Thor::Error, e.message
     end
+
+    no_commands do
+      # A detached HEAD (e.g. a CI checkout of a pull request) has no current branch, so fall
+      # back to the pull request's head branch that GitHub Actions provides.
+      def branch_name_to_validate
+        name = [options["branch"], ConventionalCommits::Git.new.current_branch_name, ENV["GITHUB_HEAD_REF"]]
+               .map { |candidate| candidate.to_s.strip }
+               .find { |candidate| !candidate.empty? }
+        raise GenericError, "Cannot determine the branch name (HEAD is detached); pass --branch" if name.nil?
+
+        name
+      end
+    end
   end
 end

data/lib/commit/commit_message_validator.rb

@@ -4,10 +4,20 @@ module ConventionalCommits
   class CommitMessageValidator
     def validate_commit_msg_from_file(commit_msg_path: Configuration::DEFAULT_COMMIT_MSG_PATH,
                                       cfg_path: Configuration::DEFAULT_CONFIGURATION_PATH)
-      return if commit_msg_path != Configuration::DEFAULT_COMMIT_MSG_PATH
+      return if Configuration.git_generated_message?(commit_msg_path)
+
+      parser = CommitMessageParser.new
+      validate(parser.message_components(commit_msg_path:, cfg_path:))
+    end
+
+    def validate_commit_msg(message:, cfg_path: Configuration::DEFAULT_CONFIGURATION_PATH)
       parser = CommitMessageParser.new
-      components = parser.message_components(commit_msg_path:, cfg_path:)
+      validate(parser.message_components_from_string(commit_msg: message, cfg_path:))
+    end
+
+    private
 
+    def validate(components)
       raise GenericError, "The Message is Invalid" if components.empty?
 
       if components[:body].include?(Configuration::DEFAULT_COMMIT_BODY_TEMPLATE)

data/lib/configuration.rb

@@ -6,5 +6,11 @@ module ConventionalCommits
     DEFAULT_COMMIT_MSG_PATH = ".git/COMMIT_EDITMSG"
     DEFAULT_COMMIT_BODY_TEMPLATE = "[Describe your work, and put an empty string after]"
     MAX_ELEMENTS_IN_PATTERN = 4
+    # Messages git writes itself for merges and squashes; hooks receive them and leave them as is.
+    GIT_GENERATED_MESSAGE_FILES = %w[MERGE_MSG SQUASH_MSG].freeze
+
+    def self.git_generated_message?(path)
+      GIT_GENERATED_MESSAGE_FILES.include?(File.basename(path.to_s))
+    end
   end
 end

data/lib/conventional_commits/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ConventionalCommits
-  VERSION = "0.2.23"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: conventional_commits
 version: !ruby/object:Gem::Version
-  version: 0.2.23
+  version: 0.3.0
 platform: ruby
 authors:
 - Swift-Gurus
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-05-04 00:00:00.000000000 Z
+date: 2026-10-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: open3