Credo
▼
Project version
v1.7.11
v1.7.10
v1.7.9
v1.7.8
v1.7.7
v1.7.7-rc.0
v1.7.6
v1.7.5
v1.7.4
v1.7.3
v1.7.2
v1.7.2-rc.4
v1.7.2-rc.3
v1.7.2-rc.2
v1.7.2-rc.1
v1.7.2-rc.0
v1.7.1
v1.7.0
v1.7.0-rc.2
v1.7.0-rc.1
v1.6.7
v1.6.6
v1.6.5
v1.6.4
v1.6.3
v1.6.2
v1.6.1
v1.6.0
v1.6.0-rc.1
v1.6.0-rc.0
v1.5.6
v1.5.5
v1.5.4
v1.5.3
v1.5.2
v1.5.1
v1.5.0
v1.5.0-rc.5
v1.5.0-rc.4
v1.5.0-rc.2
v1.5.0-rc.1
v1.4.0
v1.4.0-rc.2
v1.4.0-rc.1
v1.3.2
v1.3.1
v1.3.0
v1.3.0-rc3
v1.3.0-rc2
v1.3.0-rc1
v1.2.3
v1.2.2
v1.2.1
v1.2.0
v1.2.0-rc4
v1.2.0-rc3
v1.2.0-rc1
v1.1.5
v1.1.4
v1.1.3
v1.1.2
v1.1.1
v1.1.0
v1.1.0-rc3
v1.1.0-rc2
v1.1.0-rc1
v1.0.5
v1.0.4
v1.0.3
v1.0.2
v1.0.1-rc1
v1.0.0-rc1
GUIDES
Modules
Mix
Tasks
API Reference
Modules
Basics
Basics
Basics
Basics
Basics
Basics
Basics
Basics
Basics
Basics
Basics
Basics
Basics
Basics
Basics
Basics
Basics
Basics
Basics
Basics
Basics
Basics
Basics
Basics
Basics
Basics
Basics
Basics
Basics
Basics
Basics
Basics
Basics
Basics
Basics
Basics
Basics
Basics
Basics
Basics
Basics
Basics
Basics
Basics
Basics
Basics
Basics
Basics
Basics
Basics
Basics
Basics
Basics
Basics
Basics
Basics
Basics
Basics
Basics
Basics
Basics
Basics
Basics
Basics
Basics
Basics
Basics
Basics
Basics
Basics
Basics
Basics
Basics
Basics
Basics
Basics
Basics
Basics
Basics
Basics
Basics
Basics
Basics
Basics
Basics
Basics
Basics
Basics
Basics
Basics
Basics
Basics
Basics
Basics
Basics
Basics
Basics
Basics
Basics
Basics
Basics
Basics
Basics
Basics
Basics
Basics
Basics
Mix Tasks
Changelog
1.7.11
1.7.10
1.7.9
1.7.8
1.7.7
1.7.6
1.7.5
1.7.4
1.7.3
1.7.2
1.7.1
1.7.0
1.6.7
1.6.6
1.6.5
1.6.4
1.6.3
1.6.2
1.6.1
1.6.0
1.5.6
1.5.5
1.5.4
1.5.3
1.5.2
1.5.1
1.5.0
1.4.1
1.4.0
1.3.2
1.3.1
1.3.0
1.2.3
1.2.2
1.2.1
1.2.0
1.1.5
1.1.4
1.1.3
1.1.2
1.1.1
1.1.0
1.0.5
1.0.4
1.0.3
1.0.2
1.0.1
1.0.0
0.10.2
0.10.1
0.10.0
0.9.3
0.9.2
0.9.1
0.9.0
0.8.10
0.8.9
0.8.8
0.8.7
0.8.6
0.8.5
0.8.4
0.8.3
0.8.2
0.8.1
0.8.0
0.7.4
0.7.3
0.7.2
0.7.1
0.7.0
0.6.1
0.6.0
0.5.3
0.5.2
0.5.1
0.5.0
0.4.14
0.4.13
0.4.12
0.4.11
0.4.10
0.4.9
0.4.8
0.4.7
0.4.6
0.4.5
0.4.4
0.4.3
0.4.2
0.4.1
0.4.0
0.3.13
0.3.12
0.3.11
0.3.10
0.3.9
0.3.8
0.3.7
0.3.6
0.3.5
0.3.4
0.3.3
0.3.2
0.3.1
0.3.0
0.2.6
0.2.5
0.2.4
0.2.3
0.2.2
0.2.1
0.2.0
0.1.10
0.1.9
0.1.8
0.1.7
0.1.6
0.1.1 - 0.1.5
0.1.0
Introduction
Overview
Installation
Compatibility
Basic Usage
Run Analysis
Explain Issues
Advanced Usage
Further reading
Exit Status
Issue Statuses
Actual & Custom Errors
Mix Tasks
Configuration
.credo.exs
Config Keys
Using a custom configuration
Using a specific configuration file
Transitive configuration files
Default checks
Command line switches
Common use cases
Command line switches and config file
Inline Config Comments
credo:disable-for-this-file
credo:disable-for-next-line
credo:disable-for-previous-line
credo:disable-for-lines:<count>
Check Parameters
Configuration
General params
Commands
mix credo suggest
Examples
Command Line Switches
Descriptions
mix credo diff
Examples
Command Line Switches
Descriptions
mix credo explain
Command Line Switches
mix credo list
Examples
Command Line Switches
Custom Checks
Adding Custom Checks
Testing Custom Checks
Plugins
Using Plugins
Creating Plugins
Basics
Development
Further reading
Credo
Summary
Functions
run/1
Essential Behaviours
Credo.Check
Summary
Callbacks
base_priority/0
category/0
docs_uri/0
elixir_version/0
exit_status/0
explanations/0
format_issue/2
id/0
param_defaults/0
run/2
run_on_all?/0
run_on_all_source_files/3
run_on_source_file/3
tags/0
Functions
explanation_for/2
format_issue/3
to_exit_status/1
Credo.Plugin
Summary
Functions
append_task/3
append_task/4
prepend_task/3
prepend_task/4
register_cli_switch/5
register_command/3
register_default_config/2
Essential Structs
Credo.Execution
Summary
Functions
%Credo.Execution{}
build/1
checks/1
ensure_execution_struct/2
get_assign/3
get_command/2
get_command_name/1
get_given_cli_switch/2
get_issues/1
get_issues/2
get_issues_grouped_by_filename/1
get_plugin_param/3
get_result/3
get_source_files/1
get_valid_command_names/1
halt/1
halt/2
put_assign/3
put_issues/2
put_pipeline/3
put_result/3
run_pipeline/2
set_strict/1
tags_for_check/2
Credo.Issue
Summary
Types
t/0
Functions
no_trigger/0
Credo.IssueMeta
Summary
Types
t/0
Functions
for/2
params/1
source_file/1
Credo.SourceFile
Summary
Types
t/0
Functions
ast/1
column/3
line_at/2
line_at/4
lines/1
parse/2
source/1
source_and_filename/2
timed_out/1
Code Analysis
Credo.Code
Summary
Functions
ast/1
clean_charlists_strings_and_sigils/1
clean_charlists_strings_sigils_and_comments/2
contains_child?/2
postwalk/3
prewalk/3
remove_metadata/1
to_lines/1
to_tokens/1
to_tokens/2
Credo.Code.Block
Summary
Functions
after_block?/1
after_block_for/1
after_block_for!/1
all_blocks_for!/1
calls_in_catch_block/1
calls_in_do_block/1
calls_in_rescue_block/1
catch_block?/1
catch_block_for/1
catch_block_for!/1
do_block?/1
do_block_for/1
do_block_for!/1
else_block?/1
else_block_for/1
else_block_for!/1
rescue_block?/1
rescue_block_for/1
rescue_block_for!/1
Credo.Code.Charlists
Summary
Functions
replace_with_spaces/5
Credo.Code.Heredocs
Summary
Functions
replace_with_spaces/5
Credo.Code.Module
Summary
Types
location/0
module_part/0
Functions
aliases/1
analyze/1
attribute/2
def_arity/1
def_count/1
def_name/1
def_name_with_op/1
def_name_with_op/2
def_names/1
def_names_with_op/1
def_names_with_op/2
defs/1
exception?/1
modules/1
name/1
Credo.Code.Name
Summary
Functions
first/1
full/1
last/1
no_case?/1
parts_count/1
pascal_case?/1
snake_case?/1
snake_case?/2
split_pascal_case/1
Credo.Code.Parameters
Summary
Functions
count/1
names/1
Credo.Code.ParserError
Credo.Code.Scope
Summary
Functions
mod_name/1
name/2
Credo.Code.Sigils
Summary
Functions
replace_with_spaces/5
Credo.Code.Strings
Summary
Functions
replace_with_spaces/5
Credo.Code.Token
Summary
Functions
eol?/1
position/1
to_col_end/3
Credo.Code.TokenAstCorrelation
Summary
Functions
find_tokens_in_ast/2
Testing Utilities
Credo.Test.Case
Sections
Testing custom checks
Asserting found issues
Testing checks that analyse multiple source files
Summary
Functions
assert_issue/2
assert_issues/2
refute_issues/1
run_check/3
to_source_file/1
to_source_file/2
to_source_files/1
Credo.Test.CheckRunner
Summary
Functions
run_check/3
Credo.Test.SourceFiles
Summary
Functions
to_source_file/1
to_source_file/2
to_source_files/1
Check Utilities
Credo.Check.ConfigComment
Summary
Functions
ignores_issue?/2
new/3
Credo.Check.Params
Summary
Functions
get/3
Checks: Software Design
Credo.Check.Design
.AliasUsage
Sections
Basics
Explanation
Check-Specific Parameters
General Parameters
.DuplicatedCode
Sections
Basics
Explanation
Check-Specific Parameters
General Parameters
Summary
Functions
add_masses/1
calculate_hashes/4
create_issue?/2
line_no_for/1
mass/1
prune_hashes/2
to_hash/1
.SkipTestWithoutComment
Sections
Basics
Explanation
Check-Specific Parameters
General Parameters
.TagFIXME
Sections
Basics
Explanation
Check-Specific Parameters
General Parameters
.TagTODO
Sections
Basics
Explanation
Check-Specific Parameters
General Parameters
Checks: Code Readability
Credo.Check.Readability
.AliasAs
Sections
Basics
Explanation
Check-Specific Parameters
General Parameters
.AliasOrder
Sections
Basics
Explanation
Check-Specific Parameters
General Parameters
.BlockPipe
Sections
Basics
Explanation
Check-Specific Parameters
General Parameters
.FunctionNames
Sections
Basics
Explanation
Check-Specific Parameters
General Parameters
.ImplTrue
Sections
Basics
Explanation
Check-Specific Parameters
General Parameters
.LargeNumbers
Sections
Basics
Explanation
Check-Specific Parameters
General Parameters
.MaxLineLength
Sections
Basics
Explanation
Check-Specific Parameters
General Parameters
.ModuleAttributeNames
Sections
Basics
Explanation
Check-Specific Parameters
General Parameters
.ModuleDoc
Sections
Basics
Explanation
Check-Specific Parameters
General Parameters
.ModuleNames
Sections
Basics
Explanation
Check-Specific Parameters
General Parameters
.MultiAlias
Sections
Basics
Explanation
Check-Specific Parameters
General Parameters
.NestedFunctionCalls
Sections
Basics
Explanation
Check-Specific Parameters
General Parameters
.OneArityFunctionInPipe
Sections
Basics
Explanation
Check-Specific Parameters
General Parameters
.OnePipePerLine
Sections
Basics
Explanation
Check-Specific Parameters
General Parameters
.ParenthesesInCondition
Sections
Basics
Explanation
Check-Specific Parameters
General Parameters
.ParenthesesOnZeroArityDefs
Sections
Basics
Explanation
Check-Specific Parameters
General Parameters
.PipeIntoAnonymousFunctions
Sections
Basics
Explanation
Check-Specific Parameters
General Parameters
.PredicateFunctionNames
Sections
Basics
Explanation
Check-Specific Parameters
General Parameters
.PreferImplicitTry
Sections
Basics
Explanation
Check-Specific Parameters
General Parameters
.PreferUnquotedAtoms
Sections
Basics
Explanation
Check-Specific Parameters
General Parameters
.RedundantBlankLines
Sections
Basics
Explanation
Check-Specific Parameters
General Parameters
.Semicolons
Sections
Basics
Explanation
Check-Specific Parameters
General Parameters
.SeparateAliasRequire
Sections
Basics
Explanation
Check-Specific Parameters
General Parameters
Summary
Functions
message/1
.SingleFunctionToBlockPipe
Sections
Basics
Explanation
Check-Specific Parameters
General Parameters
.SinglePipe
Sections
Basics
Explanation
Check-Specific Parameters
General Parameters
.SpaceAfterCommas
Sections
Basics
Explanation
Check-Specific Parameters
General Parameters
.Specs
Sections
Basics
Explanation
Check-Specific Parameters
General Parameters
.StrictModuleLayout
Sections
Basics
Explanation
Check-Specific Parameters
General Parameters
.StringSigils
Sections
Basics
Explanation
Check-Specific Parameters
General Parameters
.TrailingBlankLine
Sections
Basics
Explanation
Check-Specific Parameters
General Parameters
.TrailingWhiteSpace
Sections
Basics
Explanation
Check-Specific Parameters
General Parameters
.UnnecessaryAliasExpansion
Sections
Basics
Explanation
Check-Specific Parameters
General Parameters
.VariableNames
Sections
Basics
Explanation
Check-Specific Parameters
General Parameters
.WithCustomTaggedTuple
Sections
Basics
Explanation
Check-Specific Parameters
General Parameters
.WithSingleClause
Sections
Basics
Explanation
Check-Specific Parameters
General Parameters
Checks: Refactoring Opportunities
Credo.Check.Refactor
.ABCSize
Sections
Basics
Explanation
Check-Specific Parameters
General Parameters
Summary
Functions
abc_size_for/2
.AppendSingleItem
Sections
Basics
Explanation
Check-Specific Parameters
General Parameters
.Apply
Sections
Basics
Explanation
Check-Specific Parameters
General Parameters
.CaseTrivialMatches
Sections
Basics
Explanation
Check-Specific Parameters
General Parameters
.CondStatements
Sections
Basics
Explanation
Check-Specific Parameters
General Parameters
.CyclomaticComplexity
Sections
Basics
Explanation
Check-Specific Parameters
General Parameters
Summary
Functions
complexity_for/1
.DoubleBooleanNegation
Sections
Basics
Explanation
Check-Specific Parameters
General Parameters
.EnumHelpers
Summary
Functions
traverse/8
.FilterCount
Sections
Basics
Explanation
Check-Specific Parameters
General Parameters
.FilterFilter
Sections
Basics
Explanation
Check-Specific Parameters
General Parameters
.FilterReject
Sections
Basics
Explanation
Check-Specific Parameters
General Parameters
.FunctionArity
Sections
Basics
Explanation
Check-Specific Parameters
General Parameters
.IoPuts
Sections
Basics
Explanation
Check-Specific Parameters
General Parameters
.LongQuoteBlocks
Sections
Basics
Explanation
Check-Specific Parameters
General Parameters
.MapInto
Sections
Basics
Explanation
Check-Specific Parameters
General Parameters
.MapJoin
Sections
Basics
Explanation
Check-Specific Parameters
General Parameters
.MapMap
Sections
Basics
Explanation
Check-Specific Parameters
General Parameters
.MatchInCondition
Sections
Basics
Explanation
Check-Specific Parameters
General Parameters
.ModuleDependencies
Sections
Basics
Explanation
Check-Specific Parameters
General Parameters
.NegatedConditionsInUnless
Sections
Basics
Explanation
Check-Specific Parameters
General Parameters
.NegatedConditionsWithElse
Sections
Basics
Explanation
Check-Specific Parameters
General Parameters
.NegatedIsNil
Sections
Basics
Explanation
Check-Specific Parameters
General Parameters
.Nesting
Sections
Basics
Explanation
Check-Specific Parameters
General Parameters
.PassAsyncInTestCases
Sections
Basics
Explanation
Check-Specific Parameters
General Parameters
.PerceivedComplexity
Sections
Basics
Explanation
Check-Specific Parameters
General Parameters
Summary
Functions
complexity_for/1
.PipeChainStart
Sections
Basics
Explanation
Check-Specific Parameters
General Parameters
.RedundantWithClauseResult
Sections
Basics
Explanation
Check-Specific Parameters
General Parameters
.RejectFilter
Sections
Basics
Explanation
Check-Specific Parameters
General Parameters
.RejectReject
Sections
Basics
Explanation
Check-Specific Parameters
General Parameters
.UnlessWithElse
Sections
Basics
Explanation
Check-Specific Parameters
General Parameters
.UtcNowTruncate
Sections
Basics
Explanation
Check-Specific Parameters
General Parameters
.VariableRebinding
Sections
Basics
Explanation
Check-Specific Parameters
General Parameters
.WithClauses
Sections
Basics
Explanation
Check-Specific Parameters
General Parameters
Checks: Warnings
Credo.Check.Warning
.ApplicationConfigInModuleAttribute
Sections
Basics
Explanation
Check-Specific Parameters
General Parameters
.BoolOperationOnSameValues
Sections
Basics
Explanation
Check-Specific Parameters
General Parameters
.Dbg
Sections
Basics
Explanation
Check-Specific Parameters
General Parameters
.ExpensiveEmptyEnumCheck
Sections
Basics
Explanation
Check-Specific Parameters
General Parameters
.ForbiddenModule
Sections
Basics
Explanation
Check-Specific Parameters
General Parameters
.IExPry
Sections
Basics
Explanation
Check-Specific Parameters
General Parameters
.IoInspect
Sections
Basics
Explanation
Check-Specific Parameters
General Parameters
.LazyLogging
Sections
Basics
Explanation
Check-Specific Parameters
General Parameters
.LeakyEnvironment
Sections
Basics
Explanation
Check-Specific Parameters
General Parameters
.MapGetUnsafePass
Sections
Basics
Explanation
Check-Specific Parameters
General Parameters
.MissedMetadataKeyInLoggerConfig
Sections
Basics
Explanation
Check-Specific Parameters
General Parameters
.MixEnv
Sections
Basics
Explanation
Check-Specific Parameters
General Parameters
.OperationOnSameValues
Sections
Basics
Explanation
Check-Specific Parameters
General Parameters
.OperationWithConstantResult
Sections
Basics
Explanation
Check-Specific Parameters
General Parameters
.RaiseInsideRescue
Sections
Basics
Explanation
Check-Specific Parameters
General Parameters
.SpecWithStruct
Sections
Basics
Explanation
Check-Specific Parameters
General Parameters
.UnsafeExec
Sections
Basics
Explanation
Check-Specific Parameters
General Parameters
.UnsafeToAtom
Sections
Basics
Explanation
Check-Specific Parameters
General Parameters
.UnusedEnumOperation
Sections
Basics
Explanation
Check-Specific Parameters
General Parameters
.UnusedFileOperation
Sections
Basics
Explanation
Check-Specific Parameters
General Parameters
.UnusedKeywordOperation
Sections
Basics
Explanation
Check-Specific Parameters
General Parameters
.UnusedListOperation
Sections
Basics
Explanation
Check-Specific Parameters
General Parameters
.UnusedOperation
.UnusedPathOperation
Sections
Basics
Explanation
Check-Specific Parameters
General Parameters
.UnusedRegexOperation
Sections
Basics
Explanation
Check-Specific Parameters
General Parameters
.UnusedStringOperation
Sections
Basics
Explanation
Check-Specific Parameters
General Parameters
.UnusedTupleOperation
Sections
Basics
Explanation
Check-Specific Parameters
General Parameters
.WrongTestFileExtension
Sections
Basics
Explanation
Check-Specific Parameters
General Parameters
Checks: Consistency
Credo.Check.Consistency
.Collector
Summary
Types
issue_formatter/0
Callbacks
collect_matches/2
find_locations_not_matching/2
Functions
append_issue_via_issue_service/2
find_issues/5
.ExceptionNames
Sections
Basics
Explanation
Check-Specific Parameters
General Parameters
.LineEndings
Sections
Basics
Explanation
Check-Specific Parameters
General Parameters
.MultiAliasImportRequireUse
Sections
Basics
Explanation
Check-Specific Parameters
General Parameters
.ParameterPatternMatching
Sections
Basics
Explanation
Check-Specific Parameters
General Parameters
.SpaceAroundOperators
Sections
Basics
Explanation
Check-Specific Parameters
General Parameters
.SpaceInParentheses
Sections
Basics
Explanation
Check-Specific Parameters
General Parameters
.TabsOrSpaces
Sections
Basics
Explanation
Check-Specific Parameters
General Parameters
.UnusedVariableNames
Sections
Basics
Explanation
Check-Specific Parameters
General Parameters
Commands & CLI
Credo.CLI
Summary
Functions
main/1
Credo.CLI.Command
Summary
Callbacks
call/1
call/2
cli_switches/0
init/1
short_description/0
treat_unknown_args_as_files?/0
Credo.CLI.Filename
Summary
Functions
contains_line_no?/1
pos_suffix/2
remove_line_no_and_column/1
with/2
Credo.CLI.Options
Summary
Functions
parse/7
parse/9
Credo.CLI.Output
Summary
Functions
check_color/1
check_tag/2
complain_about_invalid_source_files/1
complain_about_timed_out_source_files/1
foreground_color/1
issue_color/1
print_skipped_checks/1
priority_arrow/1
priority_name/1
term_columns/1
Credo.CLI.Switch
Summary
Functions
boolean/2
ensure/1
keep/2
string/2
Internal
Credo.CLI.Command.Diff.Task.FilterIssues
Credo.CLI.Command.Diff.Task.GetGitDiff
Summary
Functions
store_resulting_execution/5
Credo.CLI.Command.Explain.ExplainCommand.ExplainCheck
Credo.CLI.Command.Explain.ExplainCommand.ExplainIssue
Summary
Functions
print_result/3
Credo.CLI.Command.Explain.ExplainCommand.ExplainIssuePreCheck
Credo.CLI.Command.Info.InfoCommand.PrintInfo
Summary
Functions
call/2
Credo.CLI.Output.FirstRunHint
Summary
Functions
call/1
Credo.CLI.Output.FormatDelegator
Credo.CLI.Output.UI
Summary
Functions
edge/0
edge/2
puts/0
puts/1
puts/2
puts_edge/2
truncate/2
truncate/3
use_colors/1
warn/1
wrap_at/2
Credo.ConfigBuilder
Summary
Functions
parse/1
Credo.ConfigFile
Summary
Functions
merge/1
merge/2
merge_checks/2
merge_files/2
read_from_file_path/5
read_or_default/4
relevant_directories/1
Credo.Execution.ExecutionTiming
Summary
Functions
all/1
append/3
append/4
by_tag/2
by_tag/3
child_spec/1
ended_at/1
grouped_by_tag/2
inspect/2
now/0
run/1
run/2
started_at/1
Credo.Execution.Task
Summary
Callbacks
call/1
call/2
error/1
error/2
Credo.Sources
Summary
Functions
find/1
find_in_dir/3
Credo.Watcher
Summary
Functions
run/1
mix credo
mix credo.gen.check
mix credo.gen.config
Search documentation of Credo
Settings
View Source
Credo.Code.TokenAstCorrelation
(Credo v1.7.11)
Summary
Functions
find_tokens_in_ast(wanted_token, ast)
Functions
find_tokens_in_ast(wanted_token, ast)
×