« Changelog History


credo v0.8.0 Release Notes

    • Load source files in parallel
    • 👌 Improve high memory consumption
    • 🛠 Fix comment handling of Charlists, Sigils and Strings
    • 0️⃣ LazyLogging now only checks for debug calls by default
    • ➕ Add --mute-exit-status CLI switch, which mutes Credo's exit status (this will be used for integration tests as it means that any non-zero exit status results from a runtime error of Credo)
    • ➕ Add default param values to mix explain output
    • TagTODO and TagFIXME now also report tags from doc-related module attributes (@doc, @moduledoc, @shortdoc)
    • 🛠 Fix false positives for TrailingWhiteSpace
    • 🛠 Fix compiler warnings for Sigils

    💥 BREAKING CHANGES

    These changes concern people writing their own checks for Credo.

    • 🔨 Credo.SourceFile struct was refactored: source, lines and ast are now stored in ETS tables.
    • Credo.Config struct was replaced by Credo.Execution.
    • run/3 callbacks for Credo.Check are now run/4 callbacks as they have to receive the execution's Credo.Execution struct.

    👕 Config Comments replace @lint attributes

    👕 @lint attributes are deprecated and will be removed in Credo 0.9.0 because ⚠ they are causing a compiler warning in Elixir >= 1.4.

    👉 Users of Credo can now disable individual lines or files for all or just specific checks.

    For now, config comments let you exclude individual files completely

    # credo:disable-for-this-file
defmodule SomeApp.ThirdPartyCode do
end

    or deactivate specific lines:

    def my_fun do
  # credo:disable-for-next-line
  IO.inspect :this_is_actually_okay
end

    or add the check module to exclude just that one check:

    def my_fun do
  # credo:disable-for-next-line Credo.Check.Warning.IoInspect
  IO.inspect :this_is_actually_okay
end

    or use a Regex to be more flexible which checks to exclude:

    def my_fun do
  # credo:disable-for-next-line /IoInspect/
  IO.inspect :this_is_actually_okay
end

    Here's a list with the syntax options:

    • # credo:disable-for-this-file - to disable for the entire file
    • # credo:disable-for-next-line - to disable for the next line
    • # credo:disable-for-previous-line - to disable for the previous line
    • # credo:disable-for-lines:<count> - to disable for the given number of lines (negative for previous lines)

    🆕 New checks

    • 🔨 Credo.Check.Refactor.LongQuoteBlocks