Class: Overcommit::Hook::PreCommit::ShellCheck

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

Overview

Runs ‘shellcheck` against any modified shell script files.

Constant Summary collapse

MESSAGE_TYPE_CATEGORIZER =
lambda do |type|
  type.include?('note') ? :warning : :error
end

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



10
11
12
13
14
15
16
17
18
19
# File 'lib/overcommit/hook/pre_commit/shell_check.rb', line 10

def run
  result = execute(command, args: applicable_files)
  return :pass if result.success?

  extract_messages(
    result.stdout.split("\n"),
    /^(?<file>(?:\w:)?[^:]+):(?<line>\d+):[^ ]+ (?<type>[^ ]+)/,
    MESSAGE_TYPE_CATEGORIZER,
  )
end