Class: Overcommit::Hook::PreCommit::RstLint

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

Overview

Runs ‘rst-lint` against any modified reStructuredText files

See Also:

Constant Summary collapse

MESSAGE_REGEX = 
/
^(?<type>INFO|WARNING|ERROR|SEVERE)(?<file>(?:\w:)?[^:]+):(?<line>\d+)\s(?<msg>.+)
/x.freeze

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 



12
13
14
15
16
17
18
19
20
21
22
23
24
25
 
# File 'lib/overcommit/hook/pre_commit/rst_lint.rb', line 12

def run
  result = execute(command, args: applicable_files)
  output = result.stdout.chomp

  return :pass if result.success?
  return [:fail, result.stderr] unless result.stderr.empty?

  # example message:
  # WARNING README.rst:7 Title underline too short.
  extract_messages(
    output.split("\n"),
    MESSAGE_REGEX
  )
end