Credo

v1.3.0

Credo

Credo v1.3.0 Credo.CLI View Source

Credo.CLI is the entrypoint for both the Mix task and the escript.

Link to this section Summary

Functions

main(argv \\ [])

Runs Credo with the given argv and exits the process

run(argv)

Runs Credo with the given argv and returns its final Credo.Execution struct

Link to this section Functions

Link to this function main(argv \\ []) View Source

Runs Credo with the given argv and exits the process.

See run/1 if you want to run Credo programmatically.

Link to this function run(argv) View Source

Runs Credo with the given argv and returns its final Credo.Execution struct.

Example:

iex> exec = Credo.CLI.run(["--only", "Readability"])
iex> issues = Credo.Execution.get_issues(exec)
iex> Enum.count(issues) > 0
true