Credo v1.1.5 Credo.Execution 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

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

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 source 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 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

Halts further execution of the process

put_assign(exec, name, value)

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

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 in the given exec struct

set_strict(exec)

Sets the exec values which strict implies (if applicable)

Link to this section Types

t() :: module()

Link to this section Functions

%Credo.Execution{} (struct)

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

build(argv \\ [])

Builds an Execution struct for the the given argv.

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

Takes all checks from the checks: field of the exec, matches those against any patterns to include or exclude certain checks given via the command line.

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 source 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 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.

Halts further execution of the process.

put_assign(exec, name, value)

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

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 in the given exec struct.

set_strict(exec)

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