Class: Overcommit::Hook::CommitMsg::CapitalizedSubject

Inherits:
Base
  • Object
show all
Defined in:
lib/overcommit/hook/commit_msg/capitalized_subject.rb

Overview

Ensures commit message subject lines start with a capital letter.

Instance Attribute Summary

Attributes inherited from Base

#config

Instance Method Summary collapse

Methods inherited from Base

#applicable_files, #command, #description, #enabled?, #excluded?, #execute, #execute_in_background, #flags, #in_path?, #included_files, #initialize, #name, #parallelize?, #processors, #quiet?, #required?, #required_executable, #required_libraries, #run?, #run_and_transform, #skip?

Constructor Details

This class inherits a constructor from Overcommit::Hook::Base

Instance Method Details

#run ⇒ Object 



6
7
8
9
10
11
12
13
14
15
16
17
 
# File 'lib/overcommit/hook/commit_msg/capitalized_subject.rb', line 6

def run
  return :pass if empty_message?

  # Git treats the first non-empty line as the subject
  subject = commit_message_lines.find { |line| !line.strip.empty? }.to_s
  first_letter = subject.match(/^[[:punct:]]*(.)/)[1]
  unless special_prefix?(subject) || first_letter =~ /[[:upper:]]/
    return :warn, 'Subject should start with a capital letter'
  end

  :pass
end