Credo

▼ Project version

API Reference
- Modules
- Mix Tasks
Changelog
- 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
Basic Usage
Exit Status
- Issue Statuses
- Actual & Custom Errors
Mix Tasks
Configuration
.credo.exs
Command line switches
- Common use cases
- Command line switches and config file
Inline Config Comments
Check Parameters
- Configuration
- General params
Commands
mix credo suggest
mix credo diff
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

Credo
- Summary
- Functions
  - run/1
  - run/2
  - version/0
Essential Behaviours
Credo.Check
Credo.Plugin
- Summary
- Functions
Essential Structs
Credo.Execution
- Summary
- Functions
Credo.Issue
- Summary
- Types
  - t/0
Credo.IssueMeta
- Summary
- Types
  - t/0
- Functions
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
Credo.Code.Block
- Summary
- Functions
Credo.Code.Charlists
- Summary
- Functions
  - replace_with_spaces/4
Credo.Code.Heredocs
- Summary
- Functions
  - replace_with_spaces/5
Credo.Code.Module
Credo.Code.Name
- Summary
- Functions
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/4
Credo.Code.Strings
- Summary
- Functions
  - replace_with_spaces/4
Credo.Code.Token
- Summary
- Functions
Credo.Code.TokenAstCorrelation
- Summary
- Functions
  - find_tokens_in_ast/2
Testing Utilities
Credo.Test.Case
Credo.Test.CheckRunner
- Summary
- Functions
  - run_check/3
Credo.Test.SourceFiles
- Summary
- Functions
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
.DuplicatedCode
.SkipTestWithoutComment
- Sections
.TagFIXME
- Sections
.TagTODO
- Sections
Checks: Code Readability
Credo.Check.Readability
.AliasAs
- Sections
.AliasOrder
- Sections
.BlockPipe
- Sections
.FunctionNames
- Sections
.ImplTrue
- Sections
.LargeNumbers
- Sections
.MaxLineLength
- Sections
.ModuleAttributeNames
- Sections
.ModuleDoc
- Sections
.ModuleNames
- Sections
.MultiAlias
- Sections
.NestedFunctionCalls
- Sections
.NestedFunctionCalls.PipeHelper
- Summary
- Functions
  - cannot_be_in_pipeline?/3
  - valid_chain_start_function_call?/3
.OneArityFunctionInPipe
- Sections
.OnePipePerLine
- Sections
.ParenthesesInCondition
- Sections
.ParenthesesOnZeroArityDefs
- Sections
.PipeIntoAnonymousFunctions
- Sections
.PredicateFunctionNames
- Sections
.PreferImplicitTry
- Sections
.PreferUnquotedAtoms
- Sections
.RedundantBlankLines
- Sections
.Semicolons
- Sections
.SeparateAliasRequire
.SingleFunctionToBlockPipe
- Sections
.SinglePipe
- Sections
.SpaceAfterCommas
- Sections
.Specs
- Sections
.StrictModuleLayout
- Sections
.StringSigils
- Sections
.TrailingBlankLine
- Sections
.TrailingWhiteSpace
- Sections
.UnnecessaryAliasExpansion
- Sections
.VariableNames
- Sections
.WithCustomTaggedTuple
- Sections
.WithSingleClause
- Sections
Checks: Refactoring Opportunities
Credo.Check.Refactor
.ABCSize
.AppendSingleItem
- Sections
.Apply
- Sections
.CaseTrivialMatches
- Sections
.CondStatements
- Sections
.CyclomaticComplexity
.DoubleBooleanNegation
- Sections
.EnumHelpers
- Summary
- Functions
  - traverse/8
.FilterCount
- Sections
.FilterFilter
- Sections
.FilterReject
- Sections
.FunctionArity
- Sections
.IoPuts
- Sections
.LongQuoteBlocks
- Sections
.MapInto
- Sections
.MapJoin
- Sections
.MapMap
- Sections
.MatchInCondition
- Sections
.ModuleDependencies
- Sections
.NegatedConditionsInUnless
- Sections
.NegatedConditionsWithElse
- Sections
.NegatedIsNil
- Sections
.Nesting
- Sections
.PassAsyncInTestCases
- Sections
.PerceivedComplexity
.PipeChainStart
- Sections
.RedundantWithClauseResult
- Sections
.RejectFilter
- Sections
.RejectReject
- Sections
.UnlessWithElse
- Sections
.VariableRebinding
- Sections
.WithClauses
- Sections
Checks: Warnings
Credo.Check.Warning
.ApplicationConfigInModuleAttribute
- Sections
.BoolOperationOnSameValues
- Sections
.Dbg
- Sections
.ExpensiveEmptyEnumCheck
- Sections
.ForbiddenModule
- Sections
.IExPry
- Sections
.IoInspect
- Sections
.LazyLogging
- Sections
.LeakyEnvironment
- Sections
.MapGetUnsafePass
- Sections
.MissedMetadataKeyInLoggerConfig
- Sections
.MixEnv
- Sections
.OperationOnSameValues
- Sections
.OperationWithConstantResult
- Sections
.RaiseInsideRescue
- Sections
.SpecWithStruct
- Sections
.UnsafeExec
- Sections
.UnsafeToAtom
- Sections
.UnusedEnumOperation
- Sections
.UnusedFileOperation
- Sections
.UnusedKeywordOperation
- Sections
.UnusedListOperation
- Sections
.UnusedOperation
.UnusedPathOperation
- Sections
.UnusedRegexOperation
- Sections
.UnusedStringOperation
- Sections
.UnusedTupleOperation
- Sections
.WrongTestFileExtension
- Sections
Checks: Consistency
Credo.Check.Consistency
.Collector
.ExceptionNames
- Sections
.LineEndings
- Sections
.MultiAliasImportRequireUse
- Sections
.ParameterPatternMatching
- Sections
.SpaceAroundOperators
- Sections
.SpaceInParentheses
- Sections
.TabsOrSpaces
- Sections
.UnusedVariableNames
- Sections
Commands & CLI
Credo.CLI
- Summary
- Functions
  - main/1
Credo.CLI.Command
- Summary
- Callbacks
Credo.CLI.Filename
- Summary
- Functions
Credo.CLI.Options
- Summary
- Functions
  - parse/7
  - parse/9
Credo.CLI.Output
- Summary
- Functions
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
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

View Source mix credo (Credo v1.7.7)

Run code analysis (use --help for options)

Hex Package Hex Preview

Built using ExDoc (v0.34.0) for the Elixir programming language