OptimumCredo.Check.Warning.AuthorizeFalseWithoutComment (OptimumCredo v0.5.0)

View Source

Basics

This check is disabled by default.

Learn how to enable it via .credo.exs.

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

Explanation

Explain every authorize?: false with a comment on the same line.

Bad

Ash.read!(Post, authorize?: false)

Good

Ash.read!(Post, authorize?: false) # background job, no actor

Set ash: true to enable the check.

Check-Specific Parameters

Use the following parameters to configure this check:

:ash

Enable the Ash heuristics (default false).

This parameter defaults to false.

:ignore_paths

Directories or path fragments that are not checked.

This parameter defaults to ["test/", "priv/repo/seeds"].

General Parameters

Like with all checks, general params can be applied.

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