Class: Overcommit::Hook::PreCommit::Mdl

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

Overview

Runs ‘mdl` against any modified Markdown files

See Also:

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 



8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
 
# File 'lib/overcommit/hook/pre_commit/mdl.rb', line 8

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:
  #   [{"filename":"file1.md","line":1,"rule":"MD013","aliases":["line-length"],
  #   "description":"Line length"}]
  json_messages = JSON.parse(output)
  json_messages.map do |message|
    Overcommit::Hook::Message.new(
      :error,
      message['filename'],
      message['line'],
      "#{message['filename']}:#{message['line']} #{message['rule']} #{message['description']}"
    )
  end
end