Credo v1.1.5 Credo.IssueMeta View Source

IssueMeta provides helper functions for meta information which a check wants to pass to the issue_for(...) function, i.e. the current SourceFile and check params (by default).

Link to this section Summary

Types

t()

Functions

for(source_file, check_params)

Returns an issue meta tuple for the given source_file and check_params

params(issue_meta)

Returns the check params for the given issue_meta

source_file(issue_meta)

Returns the source file for the given issue_meta

Link to this section Types

t()

t() :: {Credo.IssueMeta, Credo.SourceFile.t(), Keyword.t()}

Link to this section Functions

for(source_file, check_params)

Returns an issue meta tuple for the given source_file and check_params.

params(issue_meta)

Returns the check params for the given issue_meta.

source_file(issue_meta)

Returns the source file for the given issue_meta.