Module: HamlLint::Reporter::Hooks

Included in:

HamlLint::Reporter

Defined in:

lib/haml_lint/reporter/hooks.rb

Overview

A collection of hook methods for incremental processing.

Instance Method Summary

• #added_lint(_lint, _report) ⇒ void

  A hook that is called for each lint as it is detected.

• #finished_file(_file, _lints) ⇒ void

  A hook that is called for each file as it is finished processing.

• #start(_files) ⇒ void

  A hook that is called when the processing starts.

Instance Method Details

#added_lint(_lint, _report) ⇒ void

This method returns an undefined value.

A hook that is called for each lint as it is detected.

Parameters:

• _lint (HamlLint::Lint) —

  the lint added to the report

• _report (HamlLint::Report) —

  the report that contains the lint

# File 'lib/haml_lint/reporter/hooks.rb', line 12

def added_lint(_lint, _report); end

#finished_file(_file, _lints) ⇒ void

This method returns an undefined value.

A hook that is called for each file as it is finished processing.

Parameters:

• _file (String) —

  the name of the file that just finished

• _lints (Array<HamlLint::Lint>) —

  the lints added to the report

# File 'lib/haml_lint/reporter/hooks.rb', line 19

def finished_file(_file, _lints); end

#start(_files) ⇒ void

This method returns an undefined value.

A hook that is called when the processing starts.

Parameters:

• _files (Array<String>) —

  the names of the files to be processed

# File 'lib/haml_lint/reporter/hooks.rb', line 25

def start(_files); end