OptimumCredo.Check.Readability.TestNameLowercase (OptimumCredo v0.5.0)

Basics

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

Explanation

Test names complete a sentence about behaviour and start lowercase.

Bad: test "Returns an error" do Good: test "returns an error" do

Check-Specific Parameters

Use the following parameters to configure this check:

:allow_acronyms

Accept a leading all-caps word such as API.

This parameter defaults to true.

:allow_camel_case

Accept a leading CamelCase identifier such as PubSub.

This parameter defaults to true.

:allowed_prefixes

Name prefixes that are always accepted.

This parameter defaults to [].

:ignore_paths

Path fragments to skip.

This parameter defaults to ["test/support/"].

General Parameters

Like with all checks, general params can be applied.

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