KogenCredo.Check.Warning.SkippedTest (KogenCredo v0.1.0)

Basics

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

Explanation

Skipped tests (@tag :skip, @tag skip: true, @moduletag :skip, etc.) hide failures and erode the test suite over time.

Every skipped test should either be fixed and re-enabled, or deleted entirely.

Examples

Bad:

@tag :skip
test "something" do
  assert 1 == 2
end

Good:

test "something" do
  assert 1 == 1
end

Check-Specific Parameters

Use the following parameters to configure this check:

:allow_with_comment

When true, skip the check if a non-empty comment follows the @tag on the same line.

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.