Bylaw.Credo.Check.Testing.NoTestsInTestDir (bylaw_credo v0.1.0-alpha.1)

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 higher and works with any version of Elixir.

Explanation

Keep test files colocated with the implementation they cover instead of storing them under a separate top-level test/ directory.

Examples

Avoid:

  test/bylaw/example_test.exs

Prefer:

  lib/bylaw/example.ex
  lib/bylaw/example_test.exs

Notes

A separate test tree makes it harder to find the tests for a module and easier to move implementation without noticing stale or missing coverage.

Colocation keeps behavior and coverage near each other, which makes focused changes and reviews cheaper.

This check uses static AST analysis, so it favors clear source-level patterns over runtime behavior.

Options

This check has no check-specific options. Configure it with an empty option list.

Usage

Add this check to Credo's checks: list in .credo.exs:

%{
  configs: [
    %{
      name: "default",
      checks: [
        {Bylaw.Credo.Check.Testing.NoTestsInTestDir, []}
      ]
    }
  ]
}

Check-Specific Parameters

There are no specific parameters for this check.

General Parameters

Like with all checks, general params can be applied.

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