Credo
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
Credo
Top
Summary
Functions
version/0
Essential Behaviours
Credo.Check
Top
Summary
Functions
builtin_param_names/0
explanation_for/2
format_issue/5
to_exit_status/1
Callbacks
base_priority/0
category/0
elixir_version/0
explanations/0
format_issue/2
param_defaults/0
run_on_all?/0
tags/0
Credo.Plugin
Top
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
Top
Summary
Types
t/0
Functions
__struct__/0
build/1
checks/1
ensure_execution_struct/2
get_assign/3
get_command/2
get_command_name/1
get_config_files/1
get_given_cli_switch/2
get_issues/1
get_issues/2
get_plugin_param/3
get_result/3
get_source_files/1
get_valid_command_names/1
halt/1
put_assign/3
put_pipeline/3
put_plugin_param/4
put_result/3
put_source_files/2
set_issues/2
set_strict/1
Credo.Issue
Top
Summary
Types
t/0
Credo.IssueMeta
Top
Summary
Types
t/0
Functions
for/2
params/1
source_file/1
Credo.SourceFile
Top
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
Top
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
Top
Summary
Functions
after_block?/1
after_block_for/1
after_block_for!/1
all_blocks_for!/1
calls_in_do_block/1
calls_in_rescue_block/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
Top
Summary
Functions
replace_with_spaces/4
Credo.Code.Heredocs
Top
Summary
Functions
replace_with_spaces/5
Credo.Code.Module
Top
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
Top
Summary
Functions
first/1
full/1
last/1
no_case?/1
parts_count/1
pascal_case?/1
snake_case?/1
split_pascal_case/1
Credo.Code.Parameters
Top
Summary
Functions
count/1
names/1
Credo.Code.ParserError
Top
Credo.Code.Scope
Top
Summary
Functions
mod_name/1
name/2
Credo.Code.Sigils
Top
Summary
Functions
replace_with_spaces/4
Credo.Code.Strings
Top
Summary
Functions
replace_with_spaces/4
Credo.Code.Token
Top
Summary
Functions
eol?/1
position/1
Credo.Code.TokenAstCorrelation
Top
Summary
Functions
find_tokens_in_ast/2
Testing Utilities
Credo.Test.Assertions
Top
Summary
Functions
assert_issue/2
assert_issues/2
assert_trigger/2
refute_issues/1
to_inspected/1
Credo.Test.Case
Top
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
Top
Summary
Functions
run_check/3
Credo.Test.SourceFiles
Top
Summary
Functions
to_source_file/1
to_source_file/2
to_source_files/1
Check Utilities
Credo.Check.ConfigComment
Top
Summary
Functions
ignores_issue?/2
new/3
Credo.Check.ConfigCommentFinder
Top
Summary
Functions
find_and_set_in_source_file/1
Credo.Check.Params
Top
Summary
Functions
get/3
Checks: Software Design
Credo.Check.Design.AliasUsage
Top
Credo.Check.Design.DuplicatedCode
Top
Summary
Functions
add_masses/1
calculate_hashes/4
create_issue?/2
line_no_for/1
mass/1
prune_hashes/2
to_hash/1
Credo.Check.Design.TagFIXME
Top
Credo.Check.Design.TagTODO
Top
Checks: Code Readability
Credo.Check.Readability.AliasAs
Top
Credo.Check.Readability.AliasOrder
Top
Credo.Check.Readability.FunctionNames
Top
Credo.Check.Readability.LargeNumbers
Top
Credo.Check.Readability.MaxLineLength
Top
Credo.Check.Readability.ModuleAttributeNames
Top
Credo.Check.Readability.ModuleDoc
Top
Credo.Check.Readability.ModuleNames
Top
Credo.Check.Readability.MultiAlias
Top
Credo.Check.Readability.ParenthesesInCondition
Top
Credo.Check.Readability.ParenthesesOnZeroArityDefs
Top
Credo.Check.Readability.PredicateFunctionNames
Top
Credo.Check.Readability.PreferImplicitTry
Top
Credo.Check.Readability.PreferUnquotedAtoms
Top
Credo.Check.Readability.RedundantBlankLines
Top
Credo.Check.Readability.Semicolons
Top
Credo.Check.Readability.SinglePipe
Top
Credo.Check.Readability.SpaceAfterCommas
Top
Credo.Check.Readability.Specs
Top
Credo.Check.Readability.StrictModuleLayout
Top
Credo.Check.Readability.StringSigils
Top
Credo.Check.Readability.TrailingBlankLine
Top
Credo.Check.Readability.TrailingWhiteSpace
Top
Credo.Check.Readability.UnnecessaryAliasExpansion
Top
Credo.Check.Readability.VariableNames
Top
Credo.Check.Readability.WithCustomTaggedTuple
Top
Summary
Functions
run/2
Checks: Refactoring Opportunities
Credo.Check.Refactor.ABCSize
Top
Summary
Functions
abc_size_for/2
Credo.Check.Refactor.AppendSingleItem
Top
Credo.Check.Refactor.CaseTrivialMatches
Top
Credo.Check.Refactor.CondStatements
Top
Credo.Check.Refactor.CyclomaticComplexity
Top
Summary
Functions
complexity_for/1
Credo.Check.Refactor.DoubleBooleanNegation
Top
Credo.Check.Refactor.FunctionArity
Top
Credo.Check.Refactor.LongQuoteBlocks
Top
Credo.Check.Refactor.MapInto
Top
Credo.Check.Refactor.MatchInCondition
Top
Credo.Check.Refactor.ModuleDependencies
Top
Credo.Check.Refactor.NegatedConditionsInUnless
Top
Credo.Check.Refactor.NegatedConditionsWithElse
Top
Credo.Check.Refactor.NegatedIsNil
Top
Credo.Check.Refactor.Nesting
Top
Credo.Check.Refactor.PerceivedComplexity
Top
Summary
Functions
complexity_for/1
Credo.Check.Refactor.PipeChainStart
Top
Credo.Check.Refactor.UnlessWithElse
Top
Credo.Check.Refactor.VariableRebinding
Top
Credo.Check.Refactor.WithClauses
Top
Checks: Warnings
Credo.Check.Warning.BoolOperationOnSameValues
Top
Credo.Check.Warning.ExpensiveEmptyEnumCheck
Top
Credo.Check.Warning.IExPry
Top
Credo.Check.Warning.IoInspect
Top
Credo.Check.Warning.LazyLogging
Top
Credo.Check.Warning.LeakyEnvironment
Top
Credo.Check.Warning.MapGetUnsafePass
Top
Credo.Check.Warning.MixEnv
Top
Credo.Check.Warning.OperationOnSameValues
Top
Credo.Check.Warning.OperationWithConstantResult
Top
Credo.Check.Warning.RaiseInsideRescue
Top
Credo.Check.Warning.UnsafeExec
Top
Credo.Check.Warning.UnsafeToAtom
Top
Credo.Check.Warning.UnusedEnumOperation
Top
Summary
Functions
run/2
Credo.Check.Warning.UnusedFileOperation
Top
Summary
Functions
run/2
Credo.Check.Warning.UnusedKeywordOperation
Top
Summary
Functions
run/2
Credo.Check.Warning.UnusedListOperation
Top
Summary
Functions
run/2
Credo.Check.Warning.UnusedOperation
Top
Credo.Check.Warning.UnusedPathOperation
Top
Summary
Functions
run/2
Credo.Check.Warning.UnusedRegexOperation
Top
Summary
Functions
run/2
Credo.Check.Warning.UnusedStringOperation
Top
Summary
Functions
run/2
Credo.Check.Warning.UnusedTupleOperation
Top
Summary
Functions
run/2
Checks: Consistency
Credo.Check.Consistency.Collector
Top
Summary
Types
issue_formatter/0
Functions
append_issue_via_issue_service/2
find_issues/4
Callbacks
collect_matches/2
find_locations_not_matching/2
Credo.Check.Consistency.ExceptionNames
Top
Credo.Check.Consistency.LineEndings
Top
Credo.Check.Consistency.MultiAliasImportRequireUse
Top
Credo.Check.Consistency.ParameterPatternMatching
Top
Credo.Check.Consistency.SpaceAroundOperators
Top
Credo.Check.Consistency.SpaceInParentheses
Top
Credo.Check.Consistency.TabsOrSpaces
Top
Credo.Check.Consistency.UnusedVariableNames
Top
Commands & CLI
Credo.CLI
Top
Summary
Functions
main/1
run/1
Credo.CLI.Command
Top
Summary
Types
t/0
Callbacks
call/2
Credo.CLI.Filename
Top
Summary
Functions
contains_line_no?/1
pos_suffix/2
remove_line_no_and_column/1
with/2
Credo.CLI.Options
Top
Summary
Functions
parse/6
Credo.CLI.Output
Top
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
Internal
Credo.Backports.Code
Top
Summary
Functions
ensure_compiled?/1
Credo.Backports.Enum
Top
Summary
Functions
chunk_every/3
split_with/2
Credo.CLI.Output.FormatDelegator
Top
Credo.CLI.Output.UI
Top
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
Top
Summary
Functions
parse/1
Credo.ConfigFile
Top
Summary
Functions
__struct__/0
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
Top
Summary
Functions
all/1
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
Top
Summary
Types
t/0
Functions
run/3
Callbacks
call/2
Credo.Sources
Top
Summary
Functions
find/1
Credo v1.4.0
Credo.Code.Name
View Source
This module provides helper functions to process names of functions, module attributes and modules.
Link to this section
Summary
Functions
first(name)
full(mod_list)
last(name)
no_case?(name)
parts_count(module_name)
pascal_case?(name)
snake_case?(name)
split_pascal_case(name)
Link to this section
Functions
Link to this function
first(name)
View Source
Link to this function
full(mod_list)
View Source
Link to this function
last(name)
View Source
Link to this function
no_case?(name)
View Source
Link to this function
parts_count(module_name)
View Source
Link to this function
pascal_case?(name)
View Source
Link to this function
snake_case?(name)
View Source
Link to this function
split_pascal_case(name)
View Source
Keyboard Shortcuts
×
c
Toggle sidebar
n
Toggle night mode
/
or
s
Focus search bar
g
Go to a HexDocs package
?
Bring up this help dialog
Go to a HexDocs package
×