Class: Overcommit::Hook::PreCommit::CodeSpellCheck

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

Overview

Runs `alfonsox` spell-checking tool against any modified code file.

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


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

def run
  # Create default file config if it does not exist

  # Run spell-check
  result = execute(command, args: applicable_files)
  return :pass if result.success?

  spellchecking_errors = result.stderr.split("\n")
  spellchecking_errors.pop

  error_messages(spellchecking_errors)
end