API Reference BlitzCredoChecks v0.1.5

modules

Modules

Put your docs before your specs

Doctest examples should be indented by at least 4 spaces

Avoid using imports where possible as they decrease readability and increase compile times

Do not uppercase first letter of a test name

async: false doesn't do anything as tests are not async by default

Do not use parentheses in DSLs provided by Ecto, Absinthe etc

Use is_binary instead of is_bitstring

Ecto Repo calls can only be used within certain contexts, add modules under the :allowed_modules key in .credo.exs

All test helpers need to set :warnings_as_errors to true

Use ===/2 instead of ==/2 and !==/2 instead of !=/2 for strict float comparison. See https://elixirschool.com/en/lessons/basics/basics#comparison-12

Todos in codebase need an associated ticket URL i.e.

Use Stream functions instead of piping multiple Enum functions together

mix-tasks

Mix Tasks

Checks all files that have been changed from trunk. Great for gradually introducing conventions through enforcement on new code only.