Class: Overcommit::Hook::PreCommit::AuthorName

Inherits:
Base
  • Object
show all
Defined in:
lib/overcommit/hook/pre_commit/author_name.rb

Overview

Ensures that a commit author has a name with at least first and last names.

Instance Attribute Summary

Attributes inherited from Base

#config

Instance Method Summary collapse

Methods inherited from Base

#applicable_files, #command, #description, #enabled?, #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

#runObject


4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
# File 'lib/overcommit/hook/pre_commit/author_name.rb', line 4

def run
  name =
    if ENV.key?('GIT_AUTHOR_NAME')
      ENV['GIT_AUTHOR_NAME']
    else
      result = execute(%w[git config --get user.name])
      result.stdout.chomp
    end

  unless name.split(' ').count >= 2
    return :fail,
           "Author must have at least first and last name, but was: #{name}.\n" \
           'Set your name with `git config --global user.name "Your Name"` ' \
           'or via the GIT_AUTHOR_NAME environment variable'
  end

  :pass
end