Credo v1.2.3 Credo.Check behaviour View Source

Check modules represent the checks which are run during Credo’s analysis.

Example:

defmodule MyCheck do
  use Credo.Check, category: :warning, base_priority: :high

  def run(source_file, params) do
    #
  end
end

The check can be configured by passing the following options to use Credo.Check:

:base_priority Sets the checks’s base priority (:low, :normal, :high, :higher or :ignore).
:category Sets the check’s category.
:elixir_version Sets the check’s version requirement for Elixir (defaults to >= 0.0.1).
:run_on_all Sets whether the check runs on all source files at once or each source file separatly.

The run/2 function of a Check module takes two parameters: a source file and a list of parameters for the check. It has to return a list of found issues.

Link to this section Summary

Functions

explanation_for(keywords, key)

format_issue(issue_meta, opts, issue_category, issue_base_priority, check)

format_issue takes an issue_meta and returns an issue. The resulting issue can be made more explicit by passing the following options to format_issue/2

to_exit_status(atom)

Converts a given category to an exit status

Callbacks

base_priority()

Returns the base priority for the check

category()

Returns the category for the check

explanation()

explanation_for_params()

format_issue(issue_meta, opts)

run_on_all?()

Link to this section Functions