Credo Plus

v1.0.1

Credo Plus

Credo Plus v1.0.1 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

checks(exec)

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_name(exec)

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

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

halt(exec)

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

Link to this section Functions

Link to this function %Credo.Execution{} View Source (struct)

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

Link to this function build(argv) View Source

Builds an Execution struct for the the given argv.

Link to this function checks(exec) View Source

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.

Link to this function get_assign(exec, name, default \\ nil) View Source

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

Link to this function get_command_name(exec) View Source

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

Link to this function get_issues(exec) View Source

Returns all issues for the given exec struct.

Link to this function get_issues(exec, filename) View Source

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

Link to this function get_result(exec, name, default \\ nil) View Source

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

Link to this function get_source_files(exec) View Source

Returns all source files for the given exec struct.

Link to this function halt(exec) View Source

Halts further execution of the process.

Link to this function put_assign(exec, name, value) View Source

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

Link to this function put_result(exec, name, value) View Source

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

Link to this function put_source_files(exec, source_files) View Source

Puts the given source_files into the given exec struct.

Link to this function set_issues(exec, issues) View Source

Sets the issues in the given exec struct.

Link to this function set_strict(exec) View Source

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