Credo v1.1.5 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
endThe run/2 function 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
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
Converts a given category to an exit status
Link to this section Types
Link to this section Functions
Link to this function
format_issue(issue_meta, opts, issue_category, issue_base_priority, check)
View Source
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:
:prioritySets the issue’s priority.:triggerSets the issue’s trigger.:line_noSets the issue’s line number. Tries to findcolumnif:triggeris supplied.:columnSets the issue’s column.:exit_statusSets the issue’s exit_status.:severitySets the issue’s severity.
Converts a given category to an exit status
Link to this section Callbacks
Returns the base priority for the check.
Returns the category for the check.
Link to this callback
format_issue(issue_meta, opts)
View Source
format_issue(issue_meta :: Credo.IssueMeta.t(), opts :: Keyword.t()) :: Issue.t()