Basics
This check is disabled by default.
Learn how to enable it via .credo.exs.
This check has a base priority of low and works with any version of Elixir.
Explanation
Flags soundcheck:disable-* comments that suppress nothing: comments
that name no rule, and selectors that match no soundcheck rule (a
mistyped id such as SC1010, or a renamed check). With strict: true,
also flags suppressions without a -- reason.
Before:
# soundcheck:disable-next-line SC1O1
<button phx-click="legacy">After:
# soundcheck:disable-next-line SC101 -- pushed by the legacy widget
<button phx-click="legacy">A selector is a rule id (SC101), a family wildcard (SC1xx), or a
check's short name (UnhandledEvent). The check reads Elixir sources,
.heex templates, and JavaScript files; findings in JavaScript appear
only in mix soundcheck.
Confidence: high. Tier: syntactic (works without compiling).
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
Also report suppressions without a -- reason.
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.