|
| 1 | +# This file contains the configuration for Credo and you are probably reading |
| 2 | +# this after creating it with `mix credo.gen.config`. |
| 3 | +# |
| 4 | +# If you find anything wrong or unclear in this file, please report an |
| 5 | +# issue on GitHub: https://github.com/rrrene/credo/issues |
| 6 | +# |
| 7 | +%{ |
| 8 | +# |
| 9 | +# You can have as many configs as you like in the `configs:` field. |
| 10 | +configs:[ |
| 11 | +%{ |
| 12 | +# |
| 13 | +# Run any config using `mix credo -C <name>`. If no config name is given |
| 14 | +# "default" is used. |
| 15 | +# |
| 16 | +name:"default", |
| 17 | +# |
| 18 | +# These are the files included in the analysis: |
| 19 | +files:%{ |
| 20 | +# |
| 21 | +# You can give explicit globs or simply directories. |
| 22 | +# In the latter case `**/*.{ex,exs}` will be used. |
| 23 | +# |
| 24 | +included:[ |
| 25 | +"lib/", |
| 26 | +"src/", |
| 27 | +"test/", |
| 28 | +"web/", |
| 29 | +"apps/*/lib/", |
| 30 | +"apps/*/src/", |
| 31 | +"apps/*/test/", |
| 32 | +"apps/*/web/" |
| 33 | +], |
| 34 | +excluded:[~r"/_build/",~r"/deps/",~r"/node_modules/"] |
| 35 | +}, |
| 36 | +# |
| 37 | +# Load and configure plugins here: |
| 38 | +# |
| 39 | +plugins:[], |
| 40 | +# |
| 41 | +# If you create your own checks, you must specify the source files for |
| 42 | +# them here, so they can be loaded by Credo before running the analysis. |
| 43 | +# |
| 44 | +requires:[], |
| 45 | +# |
| 46 | +# If you want to enforce a style guide and need a more traditional linting |
| 47 | +# experience, you can change `strict` to `true` below: |
| 48 | +# |
| 49 | +strict:false, |
| 50 | +# |
| 51 | +# To modify the timeout for parsing files, change this value: |
| 52 | +# |
| 53 | +parse_timeout:5000, |
| 54 | +# |
| 55 | +# If you want to use uncolored output by default, you can change `color` |
| 56 | +# to `false` below: |
| 57 | +# |
| 58 | +color:true, |
| 59 | +# |
| 60 | +# You can customize the parameters of any check by adding a second element |
| 61 | +# to the tuple. |
| 62 | +# |
| 63 | +# To disable a check put `false` as second element: |
| 64 | +# |
| 65 | +# {Credo.Check.Design.DuplicatedCode, false} |
| 66 | +# |
| 67 | +checks:[ |
| 68 | +# |
| 69 | +## Consistency Checks |
| 70 | +# |
| 71 | +{Credo.Check.Consistency.ExceptionNames,[]}, |
| 72 | +{Credo.Check.Consistency.LineEndings,[]}, |
| 73 | +{Credo.Check.Consistency.ParameterPatternMatching,[]}, |
| 74 | +{Credo.Check.Consistency.SpaceAroundOperators,[]}, |
| 75 | +{Credo.Check.Consistency.SpaceInParentheses,[]}, |
| 76 | +{Credo.Check.Consistency.TabsOrSpaces,[]}, |
| 77 | + |
| 78 | +# |
| 79 | +## Design Checks |
| 80 | +# |
| 81 | +# You can customize the priority of any check |
| 82 | +# Priority values are: `low, normal, high, higher` |
| 83 | +# |
| 84 | +{Credo.Check.Design.AliasUsage, |
| 85 | +[priority::low,if_nested_deeper_than:2,if_called_more_often_than:0]}, |
| 86 | +# You can also customize the exit_status of each check. |
| 87 | +# If you don't want TODO comments to cause `mix credo` to fail, just |
| 88 | +# set this value to 0 (zero). |
| 89 | +# |
| 90 | +{Credo.Check.Design.TagTODO,[exit_status:2]}, |
| 91 | +{Credo.Check.Design.TagFIXME,[]}, |
| 92 | + |
| 93 | +# |
| 94 | +## Readability Checks |
| 95 | +# |
| 96 | +{Credo.Check.Readability.AliasOrder,[]}, |
| 97 | +{Credo.Check.Readability.FunctionNames,[]}, |
| 98 | +{Credo.Check.Readability.LargeNumbers,[]}, |
| 99 | +{Credo.Check.Readability.MaxLineLength,[priority::low,max_length:120]}, |
| 100 | +{Credo.Check.Readability.ModuleAttributeNames,[]}, |
| 101 | +{Credo.Check.Readability.ModuleDoc,[]}, |
| 102 | +{Credo.Check.Readability.ModuleNames,[]}, |
| 103 | +{Credo.Check.Readability.ParenthesesInCondition,[]}, |
| 104 | +{Credo.Check.Readability.ParenthesesOnZeroArityDefs,[]}, |
| 105 | +{Credo.Check.Readability.PredicateFunctionNames,[]}, |
| 106 | +{Credo.Check.Readability.PreferImplicitTry,[]}, |
| 107 | +{Credo.Check.Readability.RedundantBlankLines,[]}, |
| 108 | +{Credo.Check.Readability.Semicolons,[]}, |
| 109 | +{Credo.Check.Readability.SpaceAfterCommas,[]}, |
| 110 | +{Credo.Check.Readability.StringSigils,[]}, |
| 111 | +{Credo.Check.Readability.TrailingBlankLine,[]}, |
| 112 | +{Credo.Check.Readability.TrailingWhiteSpace,[]}, |
| 113 | +{Credo.Check.Readability.UnnecessaryAliasExpansion,[]}, |
| 114 | +{Credo.Check.Readability.VariableNames,[]}, |
| 115 | + |
| 116 | +# |
| 117 | +## Refactoring Opportunities |
| 118 | +# |
| 119 | +{Credo.Check.Refactor.CondStatements,[]}, |
| 120 | +{Credo.Check.Refactor.CyclomaticComplexity,[max_complexity:12]}, |
| 121 | +{Credo.Check.Refactor.FunctionArity,[]}, |
| 122 | +{Credo.Check.Refactor.LongQuoteBlocks,[]}, |
| 123 | +{Credo.Check.Refactor.MapInto,[]}, |
| 124 | +{Credo.Check.Refactor.MatchInCondition,[]}, |
| 125 | +{Credo.Check.Refactor.NegatedConditionsInUnless,[]}, |
| 126 | +{Credo.Check.Refactor.NegatedConditionsWithElse,[]}, |
| 127 | +{Credo.Check.Refactor.Nesting,[]}, |
| 128 | +{Credo.Check.Refactor.UnlessWithElse,[]}, |
| 129 | +{Credo.Check.Refactor.WithClauses,[]}, |
| 130 | + |
| 131 | +# |
| 132 | +## Warnings |
| 133 | +# |
| 134 | +{Credo.Check.Warning.BoolOperationOnSameValues,[]}, |
| 135 | +{Credo.Check.Warning.ExpensiveEmptyEnumCheck,[]}, |
| 136 | +{Credo.Check.Warning.IExPry,[]}, |
| 137 | +{Credo.Check.Warning.IoInspect,[]}, |
| 138 | +{Credo.Check.Warning.LazyLogging,[]}, |
| 139 | +{Credo.Check.Warning.MixEnv,false}, |
| 140 | +{Credo.Check.Warning.OperationOnSameValues,[]}, |
| 141 | +{Credo.Check.Warning.OperationWithConstantResult,[]}, |
| 142 | +{Credo.Check.Warning.RaiseInsideRescue,[]}, |
| 143 | +{Credo.Check.Warning.UnusedEnumOperation,[]}, |
| 144 | +{Credo.Check.Warning.UnusedFileOperation,[]}, |
| 145 | +{Credo.Check.Warning.UnusedKeywordOperation,[]}, |
| 146 | +{Credo.Check.Warning.UnusedListOperation,[]}, |
| 147 | +{Credo.Check.Warning.UnusedPathOperation,[]}, |
| 148 | +{Credo.Check.Warning.UnusedRegexOperation,[]}, |
| 149 | +{Credo.Check.Warning.UnusedStringOperation,[]}, |
| 150 | +{Credo.Check.Warning.UnusedTupleOperation,[]}, |
| 151 | +{Credo.Check.Warning.UnsafeExec,[]}, |
| 152 | + |
| 153 | +# |
| 154 | +# Checks scheduled for next check update (opt-in for now, just replace `false` with `[]`) |
| 155 | + |
| 156 | +# |
| 157 | +# Controversial and experimental checks (opt-in, just replace `false` with `[]`) |
| 158 | +# |
| 159 | +{Credo.Check.Readability.StrictModuleLayout,false}, |
| 160 | +{Credo.Check.Consistency.MultiAliasImportRequireUse,false}, |
| 161 | +{Credo.Check.Consistency.UnusedVariableNames,false}, |
| 162 | +{Credo.Check.Design.DuplicatedCode,false}, |
| 163 | +{Credo.Check.Readability.AliasAs,false}, |
| 164 | +{Credo.Check.Readability.MultiAlias,false}, |
| 165 | +{Credo.Check.Readability.Specs,false}, |
| 166 | +{Credo.Check.Readability.SinglePipe,false}, |
| 167 | +{Credo.Check.Readability.WithCustomTaggedTuple,false}, |
| 168 | +{Credo.Check.Refactor.ABCSize,false}, |
| 169 | +{Credo.Check.Refactor.AppendSingleItem,false}, |
| 170 | +{Credo.Check.Refactor.DoubleBooleanNegation,false}, |
| 171 | +{Credo.Check.Refactor.ModuleDependencies,false}, |
| 172 | +{Credo.Check.Refactor.NegatedIsNil,false}, |
| 173 | +{Credo.Check.Refactor.PipeChainStart,false}, |
| 174 | +{Credo.Check.Refactor.VariableRebinding,false}, |
| 175 | +{Credo.Check.Warning.LeakyEnvironment,false}, |
| 176 | +{Credo.Check.Warning.MapGetUnsafePass,false}, |
| 177 | +{Credo.Check.Warning.UnsafeToAtom,false} |
| 178 | + |
| 179 | +# |
| 180 | +# Custom checks can be created using `mix credo.gen.check`. |
| 181 | +# |
| 182 | +] |
| 183 | +} |
| 184 | +] |
| 185 | +} |