Credo.Execution (Credo v1.5.0) View Source

Every run of Credo is configured via a Execution struct, which is created and manipulated via the Credo.Execution module.

Link to this section Summary

Types

t()

Functions

%Credo.Execution{}

The Execution struct is created and manipulated via the Credo.Execution module.

build(argv \\ [])

Builds an Execution struct for the the given argv.

build(previous_exec, files_that_changed)

Builds an Execution struct for a re-run with the the given argv, noting to just analyse the files_that_changed.

checks(exec)

Returns the checks that should be run for a given exec struct.

ensure_execution_struct(value, fun_name)

Ensures that the given value is a %Credo.Execution{} struct, raises an error otherwise.

get_assign(exec, name, default \\ nil)

Returns the assign with the given name for the given exec struct (or return the given default value).

get_command(exec, name)

get_command_name(exec)

Returns the name of the command, which should be run by the given execution.

get_config_files(exec)

Returns all config files for the given exec struct.

get_given_cli_switch(exec, switch_name)

get_issues(exec)

Returns all issues for the given exec struct.

get_issues(exec, filename)

Returns all issues for the given exec struct that relate to the given filename.

get_plugin_param(exec, plugin_mod, param_name)

get_result(exec, name, default \\ nil)

Returns the result with the given name for the given exec struct (or return the given default value).

get_source_files(exec)

Returns all source files for the given exec struct.

get_valid_command_names(exec)

Returns all valid command names.

halt(exec)

Halts further execution of the pipeline.

put_assign(exec, name, value)

Puts the given value with the given name as assign into the given exec struct.

put_pipeline(exec, pipeline_key, pipeline)

put_plugin_param(exec, plugin_mod, param_name, param_value)

put_result(exec, name, value)

Puts the given value with the given name as result into the given exec struct.

put_source_files(exec, source_files)

Puts the given source_files into the given exec struct.

set_issues(exec, issues)

Sets the issues for the given exec struct, overwriting any existing issues.

set_strict(exec)

Sets the exec values which strict implies (if applicable).

tags_for_check(check, params)

Returns the tags for a given check and its params.

Link to this section Types

t()

Specs

t() :: %Credo.Execution{
  all: term(),
  argv: term(),
  assigns: term(),
  checks: term(),
  cli_aliases: term(),
  cli_options: term(),
  cli_switch_plugin_param_converters: term(),
  cli_switches: term(),
  color: term(),
  commands: term(),
  config_comment_map: term(),
  config_files: term(),
  config_files_pid: term(),
  crash_on_error: term(),
  current_task: term(),
  debug: term(),
  diff_with: term(),
  enable_disabled_checks: term(),
  files: term(),
  format: term(),
  halted: term(),
  help: term(),
  ignore_checks: term(),
  ignore_checks_tags: term(),
  initializing_plugin: term(),
  issues_pid: term(),
  max_concurrent_check_runs: term(),
  min_priority: term(),
  mute_exit_status: term(),
  only_checks: term(),
  only_checks_tags: term(),
  parent_task: term(),
  parse_timeout: term(),
  pipeline_map: term(),
  plugins: term(),
  read_from_stdin: term(),
  requires: term(),
  results: term(),
  skipped_checks: term(),
  source_files_pid: term(),
  strict: term(),
  timing_pid: term(),
  verbose: term(),
  version: term()
}

Link to this section Functions