class Overcommit::Hook::PrepareCommitMsg::ReplaceBranch

Prepends the commit message with a message based on the branch name.

What to prepend

It’s possible to reference parts of the branch name through the captures in the ‘branch_pattern` regex.

For instance, if your current branch is ‘123-topic` then this config

branch_pattern: '(\d+)-(\w+)'
replacement_text: '[#\1] '

would make this hook prepend commit messages with ‘[#123] `.

Similarly, a replacement text of ‘[1]` would result in `[123]`.

When to run this hook

You can configure this to run only for specific types of commits by setting the ‘skipped_commit_types`. The allowed types are

Constants

DEFAULT_BRANCH_PATTERN

Public Instance Methods

branch_pattern() click to toggle source
# File lib/overcommit/hook/prepare_commit_msg/replace_branch.rb, line 60
def branch_pattern
  @branch_pattern ||=
    begin
      pattern = config['branch_pattern']
      Regexp.new((pattern || '').empty? ? DEFAULT_BRANCH_PATTERN : pattern)
    end
end
new_template() click to toggle source
# File lib/overcommit/hook/prepare_commit_msg/replace_branch.rb, line 52
def new_template
  @new_template ||=
    begin
      curr_branch = Overcommit::GitRepo.current_branch
      curr_branch.gsub(branch_pattern, replacement_text)
    end
end
replacement_text() click to toggle source
# File lib/overcommit/hook/prepare_commit_msg/replace_branch.rb, line 68
def replacement_text
  @replacement_text ||=
    begin
      if File.exist?(replacement_text_config)
        File.read(replacement_text_config).chomp
      else
        replacement_text_config
      end
    end
end
replacement_text_config() click to toggle source
# File lib/overcommit/hook/prepare_commit_msg/replace_branch.rb, line 79
def replacement_text_config
  @replacement_text_config ||= config['replacement_text']
end
run() click to toggle source
# File lib/overcommit/hook/prepare_commit_msg/replace_branch.rb, line 34
def run
  return :pass if skip?

  Overcommit::Utils.log.debug(
    "Checking if '#{Overcommit::GitRepo.current_branch}' matches #{branch_pattern}"
  )

  return :warn unless branch_pattern.match?(Overcommit::GitRepo.current_branch)

  Overcommit::Utils.log.debug("Writing #{commit_message_filename} with #{new_template}")

  modify_commit_message do |old_contents|
    "#{new_template}#{old_contents}"
  end

  :pass
end
skip?() click to toggle source
Calls superclass method Overcommit::Hook::Base#skip?
# File lib/overcommit/hook/prepare_commit_msg/replace_branch.rb, line 87
def skip?
  super || skipped_commit_types.include?(commit_message_source)
end
skipped_commit_types() click to toggle source
# File lib/overcommit/hook/prepare_commit_msg/replace_branch.rb, line 83
def skipped_commit_types
  @skipped_commit_types ||= config['skipped_commit_types'].map(&:to_sym)
end