search

rrrene / credo

A static code analysis tool for the Elixir language with a focus on code consistency and teaching.
http://credo-ci.org/
MIT License
4.94k stars 419 forks source link

Add list of standard checks to docs #1086

Closed tfwright closed 11 months ago

tfwright commented 1 year ago

I am actually guessing this is not a bug but I can't find any documentation/explanation around this behavior so I'm reporting it here first just in case.

Based on README my assumption all built in checks are applied and only custom checks, or checks with modified behavior need configuration.

Apologies if I've missed something but if it is expected that there are built in checks that must be included explicitly this should be front and center in the docs and additionally it would be helpful to have an easily accessible list of those checks.

Environment

What were you trying to do?

Run credo with all checks (strict)

Expected outcome

All checks applied

Actual outcome

PipeChainStart is not checked unless I add the following to my check config: {Credo.Check.Refactor.PipeChainStart, []}

rrrene commented 11 months ago

Hi, not all checks are enabled by default.

Credo's documentation does not yet provide an overview for which checks are envaled by default 😢

Will use this issue to add that 👍

rrrene commented 11 months ago

Added a section "Default Checks" to the Config docs: https://hexdocs.pm/credo/1.7.2-rc.4/config_file.html#default-checks

:+1: