Class: Overcommit::Hook::PreCommit::Credo

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

Overview

Runs `credo` against any modified ex files.

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

example message: lib/file1.ex:1:11: R: Modules should have a @moduledoc tag. lib/file2.ex:12:81: R: Line is too long (max is 80, was 81).


12
13
14
15
16
17
18
# File 'lib/overcommit/hook/pre_commit/credo.rb', line 12

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

  result.stdout.split("\n").map(&:strip).reject(&:empty?).
    map { |error| message(error) }
end