MetaCredo.Issue (MetaCredo v0.1.0)

Represents a single issue found during analysis.

Mirrors Credo.Issue but operates on MetaAST nodes.

Summary

Types

priority()

severity()

t()

Functions

exit_status_for(category)

Returns the default exit status for a given category.

priority_value(priority)

Converts a priority atom to its numeric value.

Types

priority()

@type priority() :: :higher | :high | :normal | :low | :ignore

severity()

@type severity() :: :error | :warning | :info | :refactoring_opportunity

t()

@type t() :: %MetaCredo.Issue{
  category: atom(),
  check: module(),
  column: pos_integer() | nil,
  exit_status: non_neg_integer(),
  filename: String.t() | nil,
  line_no: pos_integer() | nil,
  message: String.t(),
  metadata: map(),
  priority: priority() | integer(),
  severity: severity(),
  trigger: String.t() | nil
}

Functions

exit_status_for(category)

@spec exit_status_for(atom()) :: non_neg_integer()

Returns the default exit status for a given category.

priority_value(priority)

@spec priority_value(priority() | integer()) :: integer()

Converts a priority atom to its numeric value.