Class: Overcommit::Hook::PreCommit::Pylint

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

Overview

Runs ‘pylint` against any modified Python files.

See Also:

Constant Summary collapse

MESSAGE_REGEX = 
/^(?<file>(?:\w:)?.+):(?<line>\d+):(?<type>[CEFRW])/.freeze
MESSAGE_TYPE_CATEGORIZER =

Classify ‘E’ and ‘F’ message codes as errors, everything else as warnings.

http://pylint.readthedocs.org/en/latest/tutorial.html#getting-started

lambda do |type|
  'EF'.include?(type) ? :error : :warning
end

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 



17
18
19
20
21
22
23
24
25
26
27
28
29
30
 
# File 'lib/overcommit/hook/pre_commit/pylint.rb', line 17

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

  output = result.stdout.chomp

  # example message:
  #   path/to/file.py:64:C: Missing function docstring (missing-docstring)
  extract_messages(
    output.split("\n").grep(MESSAGE_REGEX),
    MESSAGE_REGEX,
    MESSAGE_TYPE_CATEGORIZER
  )
end