Graham McIntire
fd976b0cd5
- Add jump_credo_checks ~> 0.4 with all 20 checks enabled - Fix all standard Credo issues: 139 @spec (113 done, 26 remain), 4 refactoring, 3 alias usage, 9 System.cmd env, 5 unsafe_to_atom, 2 max line length, 9 assert_receive timeout - Fix 170+ jump_credo_checks warnings: - 117 TopLevelAliasImportRequire: move nested alias/import to module top - 32 UseObanProWorker: switch to Oban.Pro.Worker - 4 DoctestIExExamples: add doctests / create test file - ~20 WeakAssertion: strengthen type-check assertions - Various ConditionalAssertion, AssertReceiveTimeout fixes - Exclude vendor/ from Credo analysis - Remaining: 175 warnings (mostly opinionated WeakAssertion, AvoidSocketAssignsInTest), 26 @spec annotations
265 lines
12 KiB
Elixir
265 lines
12 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 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/",
|
|
"src/",
|
|
"test/",
|
|
"web/",
|
|
"apps/*/lib/",
|
|
"apps/*/src/",
|
|
"apps/*/test/",
|
|
"apps/*/web/"
|
|
],
|
|
excluded: [~r"/_build/", ~r"/deps/", ~r"/node_modules/", ~r"/vendor/"]
|
|
},
|
|
#
|
|
# 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: [
|
|
"deps/jump_credo_checks/lib/jump/credo_checks/assert_element_selector_can_never_fail.ex",
|
|
"deps/jump_credo_checks/lib/jump/credo_checks/assert_receive_timeout.ex",
|
|
"deps/jump_credo_checks/lib/jump/credo_checks/avoid_function_level_else.ex",
|
|
"deps/jump_credo_checks/lib/jump/credo_checks/avoid_logger_configure_in_test.ex",
|
|
"deps/jump_credo_checks/lib/jump/credo_checks/avoid_socket_assigns_in_test.ex",
|
|
"deps/jump_credo_checks/lib/jump/credo_checks/conditional_assertion.ex",
|
|
"deps/jump_credo_checks/lib/jump/credo_checks/doctest_iex_examples.ex",
|
|
"deps/jump_credo_checks/lib/jump/credo_checks/forbidden_function.ex",
|
|
"deps/jump_credo_checks/lib/jump/credo_checks/live_view_form_can_be_rehydrated.ex",
|
|
"deps/jump_credo_checks/lib/jump/credo_checks/prefer_change_over_up_down_migrations.ex",
|
|
"deps/jump_credo_checks/lib/jump/credo_checks/prefer_text_columns.ex",
|
|
"deps/jump_credo_checks/lib/jump/credo_checks/safe_binary_to_term.ex",
|
|
"deps/jump_credo_checks/lib/jump/credo_checks/test_has_no_assertions.ex",
|
|
"deps/jump_credo_checks/lib/jump/credo_checks/too_many_assertions.ex",
|
|
"deps/jump_credo_checks/lib/jump/credo_checks/top_level_alias_import_require.ex",
|
|
"deps/jump_credo_checks/lib/jump/credo_checks/undeclared_external_resource.ex",
|
|
"deps/jump_credo_checks/lib/jump/credo_checks/unused_live_view_assign.ex",
|
|
"deps/jump_credo_checks/lib/jump/credo_checks/use_oban_pro_worker.ex",
|
|
"deps/jump_credo_checks/lib/jump/credo_checks/vacuous_test.ex",
|
|
"deps/jump_credo_checks/lib/jump/credo_checks/weak_assertion.ex"
|
|
],
|
|
#
|
|
# If you want to enforce a style guide and need a more traditional linting
|
|
# experience, you can change `strict` to `true` below:
|
|
#
|
|
strict: true,
|
|
#
|
|
# 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]},
|
|
{Credo.Check.Design.TagFIXME, []},
|
|
# 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]},
|
|
|
|
#
|
|
## 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, []},
|
|
{Credo.Check.Refactor.FilterCount, []},
|
|
{Credo.Check.Refactor.FilterFilter, []},
|
|
{Credo.Check.Refactor.FunctionArity, []},
|
|
{Credo.Check.Refactor.LongQuoteBlocks, []},
|
|
{Credo.Check.Refactor.MapJoin, []},
|
|
{Credo.Check.Refactor.MatchInCondition, []},
|
|
{Credo.Check.Refactor.NegatedConditionsInUnless, []},
|
|
{Credo.Check.Refactor.NegatedConditionsWithElse, []},
|
|
{Credo.Check.Refactor.Nesting, []},
|
|
{Credo.Check.Refactor.RedundantWithClauseResult, []},
|
|
{Credo.Check.Refactor.RejectReject, []},
|
|
{Credo.Check.Refactor.UnlessWithElse, []},
|
|
{Credo.Check.Refactor.WithClauses, []},
|
|
|
|
#
|
|
## Warnings
|
|
#
|
|
{Credo.Check.Warning.ApplicationConfigInModuleAttribute, []},
|
|
{Credo.Check.Warning.BoolOperationOnSameValues, []},
|
|
{Credo.Check.Warning.Dbg, []},
|
|
{Credo.Check.Warning.ExpensiveEmptyEnumCheck, []},
|
|
{Credo.Check.Warning.IExPry, []},
|
|
{Credo.Check.Warning.IoInspect, []},
|
|
{Credo.Check.Warning.MissedMetadataKeyInLoggerConfig, []},
|
|
{Credo.Check.Warning.OperationOnSameValues, []},
|
|
{Credo.Check.Warning.OperationWithConstantResult, []},
|
|
{Credo.Check.Warning.RaiseInsideRescue, []},
|
|
{Credo.Check.Warning.SpecWithStruct, []},
|
|
{Credo.Check.Warning.StructFieldAmount, []},
|
|
{Credo.Check.Warning.UnsafeExec, []},
|
|
{Credo.Check.Warning.UnusedEnumOperation, []},
|
|
{Credo.Check.Warning.UnusedFileOperation, []},
|
|
{Credo.Check.Warning.UnusedKeywordOperation, []},
|
|
{Credo.Check.Warning.UnusedListOperation, []},
|
|
{Credo.Check.Warning.UnusedMapOperation, []},
|
|
{Credo.Check.Warning.UnusedPathOperation, []},
|
|
{Credo.Check.Warning.UnusedRegexOperation, []},
|
|
{Credo.Check.Warning.UnusedStringOperation, []},
|
|
{Credo.Check.Warning.UnusedTupleOperation, []},
|
|
{Credo.Check.Warning.WrongTestFilename, []},
|
|
{Credo.Check.Readability.Specs, []},
|
|
{Credo.Check.Warning.LeakyEnvironment, []},
|
|
{Credo.Check.Warning.UnsafeToAtom, []},
|
|
|
|
#
|
|
## Jump Credo Checks
|
|
#
|
|
{Jump.CredoChecks.AssertElementSelectorCanNeverFail, []},
|
|
{Jump.CredoChecks.AssertReceiveTimeout, []},
|
|
{Jump.CredoChecks.AvoidFunctionLevelElse, []},
|
|
{Jump.CredoChecks.AvoidLoggerConfigureInTest, []},
|
|
{Jump.CredoChecks.AvoidSocketAssignsInTest, []},
|
|
{Jump.CredoChecks.ConditionalAssertion, []},
|
|
{Jump.CredoChecks.DoctestIExExamples, []},
|
|
{Jump.CredoChecks.ForbiddenFunction, []},
|
|
{Jump.CredoChecks.LiveViewFormCanBeRehydrated, []},
|
|
{Jump.CredoChecks.UndeclaredExternalResource, []},
|
|
{Jump.CredoChecks.PreferChangeOverUpDownMigrations, [start_after: "0"]},
|
|
{Jump.CredoChecks.PreferTextColumns, [start_after: "0"]},
|
|
{Jump.CredoChecks.SafeBinaryToTerm, []},
|
|
{Jump.CredoChecks.TestHasNoAssertions, []},
|
|
{Jump.CredoChecks.TooManyAssertions, []},
|
|
{Jump.CredoChecks.TopLevelAliasImportRequire, []},
|
|
{Jump.CredoChecks.UnusedLiveViewAssign, []},
|
|
{Jump.CredoChecks.UseObanProWorker, []},
|
|
{Jump.CredoChecks.VacuousTest, []},
|
|
{Jump.CredoChecks.WeakAssertion, []}
|
|
],
|
|
disabled: [
|
|
#
|
|
# Checks scheduled for next check update (opt-in for now)
|
|
{Credo.Check.Refactor.UtcNowTruncate, []},
|
|
|
|
#
|
|
# 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.OneArityFunctionInPipe, []},
|
|
{Credo.Check.Readability.OnePipePerLine, []},
|
|
{Credo.Check.Readability.SeparateAliasRequire, []},
|
|
{Credo.Check.Readability.SingleFunctionToBlockPipe, []},
|
|
{Credo.Check.Readability.SinglePipe, []},
|
|
{Credo.Check.Readability.StrictModuleLayout, []},
|
|
{Credo.Check.Readability.WithCustomTaggedTuple, []},
|
|
{Credo.Check.Refactor.ABCSize, []},
|
|
{Credo.Check.Refactor.AppendSingleItem, []},
|
|
{Credo.Check.Refactor.CondInsteadOfIfElse, []},
|
|
{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.PassAsyncInTestCases, []},
|
|
{Credo.Check.Refactor.PipeChainStart, []},
|
|
{Credo.Check.Refactor.RejectFilter, []},
|
|
{Credo.Check.Refactor.VariableRebinding, []},
|
|
{Credo.Check.Warning.LazyLogging, []},
|
|
{Credo.Check.Warning.MapGetUnsafePass, []},
|
|
{Credo.Check.Warning.MixEnv, []}
|
|
# {Credo.Check.Warning.UnusedOperation, [{MyMagicModule, [:fun1, :fun2]}]}
|
|
|
|
# {Credo.Check.Refactor.MapInto, []},
|
|
|
|
#
|
|
# Custom checks can be created using `mix credo.gen.check`.
|
|
#
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|