Soundcheck.Check.Consistency.Configuration (soundcheck v0.1.0)

Copy Markdown View Source

Basics

This check is disabled by default.

Learn how to enable it via .credo.exs.

This check has a base priority of normal and works with any version of Elixir.

Explanation

Reports why soundcheck's semantic checks could not analyze part of the project, so a clean run never hides a misconfiguration:

  • Phoenix LiveView is not loaded in the VM running Credo, so every semantic check is a no-op;
  • a LiveView or LiveComponent module could not be loaded, usually because the project was not compiled;
  • a LiveView or LiveComponent was compiled without debug info, so checks cannot read its handlers.

Semantic checks skip such modules silently and leave the reporting here, once per module. Run mix compile before mix credo, for example with a Mix alias:

lint: ["compile", "credo --strict"]

Confidence: high. Tier: semantic (run mix compile before mix credo).

Check-Specific Parameters

Use the following parameters to configure this check:

:excluded_paths

Paths to skip (atoms, binaries as path segments, or regexes).

This parameter defaults to [~r/\/test\//, "test"].

:strict

Unused.

This parameter defaults to false.

General Parameters

Like with all checks, general params can be applied.

Parameters can be configured via the .credo.exs config file.