123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206 |
- # 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 config using `mix credo -C <name>`. If no config 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/",
- "test/",
- "extra/"
- ],
- excluded: [~r"/_build/", ~r"/deps/", ~r"/node_modules/"]
- },
- #
- # Load and configure plugins here:
- #
- plugins: [],
- #
- # 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,
- #
- # To modify the timeout for parsing files, change this value:
- #
- parse_timeout: 5000,
- #
- # 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: %{
- enabled: [
- #
- ## 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: 2]},
- {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.PipeIntoAnonymousFunctions, []},
- {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.UnnecessaryAliasExpansion, []},
- {Credo.Check.Readability.VariableNames, []},
- {Credo.Check.Readability.WithSingleClause, []},
- #
- ## Refactoring Opportunities
- #
- {Credo.Check.Refactor.Apply, []},
- {Credo.Check.Refactor.CondStatements, []},
- {Credo.Check.Refactor.CyclomaticComplexity, false},
- {Credo.Check.Refactor.FunctionArity, []},
- {Credo.Check.Refactor.LongQuoteBlocks, []},
- {Credo.Check.Refactor.MatchInCondition, []},
- {Credo.Check.Refactor.MapJoin, []},
- {Credo.Check.Refactor.NegatedConditionsInUnless, []},
- {Credo.Check.Refactor.NegatedConditionsWithElse, false},
- {Credo.Check.Refactor.Nesting, []},
- {Credo.Check.Refactor.UnlessWithElse, []},
- {Credo.Check.Refactor.WithClauses, []},
- {Credo.Check.Refactor.FilterFilter, []},
- {Credo.Check.Refactor.RejectReject, []},
- {Credo.Check.Refactor.RedundantWithClauseResult, []},
- #
- ## Warnings
- #
- {Credo.Check.Warning.ApplicationConfigInModuleAttribute, []},
- {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.SpecWithStruct, []},
- {Credo.Check.Warning.WrongTestFileExtension, []},
- {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, []},
- {Credo.Check.Warning.UnsafeExec, []}
- ],
- disabled: [
- #
- # Checks scheduled for next check update (opt-in for now, just replace `false` with `[]`)
- #
- # Controversial and experimental checks (opt-in, just move the check to `:enabled`
- # and be sure to use `mix credo --strict` to see low priority checks)
- #
- {Credo.Check.Consistency.MultiAliasImportRequireUse, []},
- {Credo.Check.Consistency.UnusedVariableNames, []},
- {Credo.Check.Design.DuplicatedCode, []},
- {Credo.Check.Design.SkipTestWithoutComment, []},
- {Credo.Check.Readability.AliasAs, []},
- {Credo.Check.Readability.BlockPipe, []},
- {Credo.Check.Readability.ImplTrue, []},
- {Credo.Check.Readability.MultiAlias, []},
- {Credo.Check.Readability.NestedFunctionCalls, []},
- {Credo.Check.Readability.SeparateAliasRequire, []},
- {Credo.Check.Readability.SingleFunctionToBlockPipe, []},
- {Credo.Check.Readability.SinglePipe, []},
- {Credo.Check.Readability.Specs, []},
- {Credo.Check.Readability.StrictModuleLayout, []},
- {Credo.Check.Readability.WithCustomTaggedTuple, []},
- {Credo.Check.Refactor.ABCSize, []},
- {Credo.Check.Refactor.AppendSingleItem, []},
- {Credo.Check.Refactor.DoubleBooleanNegation, []},
- {Credo.Check.Refactor.FilterReject, []},
- {Credo.Check.Refactor.IoPuts, []},
- {Credo.Check.Refactor.MapMap, []},
- {Credo.Check.Refactor.ModuleDependencies, []},
- {Credo.Check.Refactor.NegatedIsNil, []},
- {Credo.Check.Refactor.PipeChainStart, []},
- {Credo.Check.Refactor.RejectFilter, []},
- {Credo.Check.Refactor.VariableRebinding, []},
- {Credo.Check.Warning.LazyLogging, []},
- {Credo.Check.Warning.LeakyEnvironment, []},
- {Credo.Check.Warning.MapGetUnsafePass, []},
- {Credo.Check.Warning.MixEnv, []},
- {Credo.Check.Warning.UnsafeToAtom, []}
- # {Credo.Check.Refactor.MapInto, []},
- #
- # Custom checks can be created using `mix credo.gen.check`.
- #
- ]
- }
- }
- ]
- }
|