164 lines
6.0 KiB
Elixir
164 lines
6.0 KiB
Elixir
# This file contains the configuration for Credo and you are probably reading
|
|
# this after creating it with `mix credo.gen.config`.
|
|
#
|
|
# If you find anything wrong or unclear in this file, please report an
|
|
# issue on GitHub: https://github.com/rrrene/credo/issues
|
|
#
|
|
%{
|
|
#
|
|
# You can have as many configs as you like in the `configs:` field.
|
|
configs: [
|
|
%{
|
|
#
|
|
# Run any exec using `mix credo -C <name>`. If no exec name is given
|
|
# "default" is used.
|
|
#
|
|
name: "default",
|
|
#
|
|
# These are the files included in the analysis:
|
|
files: %{
|
|
#
|
|
# You can give explicit globs or simply directories.
|
|
# In the latter case `**/*.{ex,exs}` will be used.
|
|
#
|
|
included: ["lib/", "src/", "test/"],
|
|
excluded: [~r"/_build/", ~r"/deps/", ~r"/js/"]
|
|
},
|
|
#
|
|
# If you create your own checks, you must specify the source files for
|
|
# them here, so they can be loaded by Credo before running the analysis.
|
|
#
|
|
requires: [],
|
|
#
|
|
# If you want to enforce a style guide and need a more traditional linting
|
|
# experience, you can change `strict` to `true` below:
|
|
#
|
|
strict: false,
|
|
#
|
|
# If you want to use uncolored output by default, you can change `color`
|
|
# to `false` below:
|
|
#
|
|
color: true,
|
|
#
|
|
# You can customize the parameters of any check by adding a second element
|
|
# to the tuple.
|
|
#
|
|
# To disable a check put `false` as second element:
|
|
#
|
|
# {Credo.Check.Design.DuplicatedCode, false}
|
|
#
|
|
checks: [
|
|
#
|
|
## Consistency Checks
|
|
#
|
|
{Credo.Check.Consistency.ExceptionNames, []},
|
|
{Credo.Check.Consistency.LineEndings, []},
|
|
{Credo.Check.Consistency.ParameterPatternMatching, []},
|
|
{Credo.Check.Consistency.SpaceAroundOperators, []},
|
|
{Credo.Check.Consistency.SpaceInParentheses, []},
|
|
{Credo.Check.Consistency.TabsOrSpaces, []},
|
|
|
|
#
|
|
## Design Checks
|
|
#
|
|
# You can customize the priority of any check
|
|
# Priority values are: `low, normal, high, higher`
|
|
#
|
|
{Credo.Check.Design.AliasUsage,
|
|
[priority: :low, if_nested_deeper_than: 2, if_called_more_often_than: 0]},
|
|
# You can also customize the exit_status of each check.
|
|
# If you don't want TODO comments to cause `mix credo` to fail, just
|
|
# set this value to 0 (zero).
|
|
#
|
|
{Credo.Check.Design.TagTODO, [exit_status: 0]},
|
|
{Credo.Check.Design.TagFIXME, []},
|
|
|
|
#
|
|
## Readability Checks
|
|
#
|
|
{Credo.Check.Readability.AliasOrder, []},
|
|
{Credo.Check.Readability.FunctionNames, []},
|
|
{Credo.Check.Readability.LargeNumbers, []},
|
|
{Credo.Check.Readability.MaxLineLength, [priority: :low, max_length: 120]},
|
|
{Credo.Check.Readability.ModuleAttributeNames, []},
|
|
{Credo.Check.Readability.ModuleDoc, []},
|
|
{Credo.Check.Readability.ModuleNames, []},
|
|
{Credo.Check.Readability.ParenthesesInCondition, []},
|
|
{Credo.Check.Readability.ParenthesesOnZeroArityDefs, []},
|
|
{Credo.Check.Readability.PredicateFunctionNames, []},
|
|
{Credo.Check.Readability.PreferImplicitTry, []},
|
|
{Credo.Check.Readability.RedundantBlankLines, []},
|
|
{Credo.Check.Readability.Semicolons, []},
|
|
{Credo.Check.Readability.SpaceAfterCommas, []},
|
|
{Credo.Check.Readability.StringSigils, []},
|
|
{Credo.Check.Readability.TrailingBlankLine, []},
|
|
{Credo.Check.Readability.TrailingWhiteSpace, []},
|
|
{Credo.Check.Readability.VariableNames, []},
|
|
|
|
#
|
|
## Refactoring Opportunities
|
|
#
|
|
{Credo.Check.Refactor.CondStatements, []},
|
|
{Credo.Check.Refactor.CyclomaticComplexity, []},
|
|
{Credo.Check.Refactor.FunctionArity, []},
|
|
{Credo.Check.Refactor.LongQuoteBlocks, []},
|
|
{Credo.Check.Refactor.MatchInCondition, []},
|
|
{Credo.Check.Refactor.NegatedConditionsInUnless, []},
|
|
{Credo.Check.Refactor.NegatedConditionsWithElse, []},
|
|
{Credo.Check.Refactor.Nesting, [
|
|
max_nesting: 3
|
|
]},
|
|
{Credo.Check.Refactor.PipeChainStart,
|
|
[
|
|
excluded_argument_types: [:atom, :binary, :fn, :keyword, :number],
|
|
excluded_functions: [],
|
|
exit_status: 0
|
|
]},
|
|
{Credo.Check.Refactor.UnlessWithElse, []},
|
|
|
|
#
|
|
## Warnings
|
|
#
|
|
{Credo.Check.Warning.BoolOperationOnSameValues, []},
|
|
{Credo.Check.Warning.ExpensiveEmptyEnumCheck, []},
|
|
{Credo.Check.Warning.IExPry, []},
|
|
{Credo.Check.Warning.IoInspect, []},
|
|
{Credo.Check.Warning.OperationOnSameValues, []},
|
|
{Credo.Check.Warning.OperationWithConstantResult, []},
|
|
{Credo.Check.Warning.RaiseInsideRescue, []},
|
|
{Credo.Check.Warning.UnusedEnumOperation, []},
|
|
{Credo.Check.Warning.UnusedFileOperation, []},
|
|
{Credo.Check.Warning.UnusedKeywordOperation, []},
|
|
{Credo.Check.Warning.UnusedListOperation, []},
|
|
{Credo.Check.Warning.UnusedPathOperation, []},
|
|
{Credo.Check.Warning.UnusedRegexOperation, []},
|
|
{Credo.Check.Warning.UnusedStringOperation, []},
|
|
{Credo.Check.Warning.UnusedTupleOperation, []},
|
|
|
|
#
|
|
# Controversial and experimental checks (opt-in, just remove `, false`)
|
|
#
|
|
{Credo.Check.Consistency.MultiAliasImportRequireUse, false},
|
|
{Credo.Check.Design.DuplicatedCode, false},
|
|
{Credo.Check.Readability.Specs, false},
|
|
{Credo.Check.Refactor.ABCSize, false},
|
|
{Credo.Check.Refactor.AppendSingleItem, false},
|
|
{Credo.Check.Refactor.DoubleBooleanNegation, false},
|
|
{Credo.Check.Refactor.VariableRebinding, false},
|
|
{Credo.Check.Warning.MapGetUnsafePass, false},
|
|
{Credo.Check.Warning.UnsafeToAtom, false},
|
|
|
|
#
|
|
# Custom checks can be created using `mix credo.gen.check`.
|
|
#
|
|
|
|
#
|
|
# Removed checks
|
|
#
|
|
{Credo.Check.Warning.LazyLogging, false},
|
|
{Credo.Check.Refactor.MapInto, false},
|
|
]
|
|
}
|
|
]
|
|
}
|