|
10 | 10 | configs: [
|
11 | 11 | %{
|
12 | 12 | #
|
13 |
| - # Run any exec using `mix credo -C <name>`. If no exec name is given |
| 13 | + # Run any config using `mix credo -C <name>`. If no config name is given |
14 | 14 | # "default" is used.
|
15 | 15 | #
|
16 | 16 | name: "default",
|
|
21 | 21 | # You can give explicit globs or simply directories.
|
22 | 22 | # In the latter case `**/*.{ex,exs}` will be used.
|
23 | 23 | #
|
24 |
| - included: ["lib/", "src/", "test/", "web/", "apps/"], |
| 24 | + included: [ |
| 25 | + "lib/", |
| 26 | + "src/", |
| 27 | + "test/", |
| 28 | + "web/", |
| 29 | + "apps/*/lib/", |
| 30 | + "apps/*/src/", |
| 31 | + "apps/*/test/", |
| 32 | + "apps/*/web/" |
| 33 | + ], |
25 | 34 | excluded: [~r"/_build/", ~r"/deps/", ~r"/node_modules/"]
|
26 | 35 | },
|
27 | 36 | #
|
| 37 | + # Load and configure plugins here: |
| 38 | + # |
| 39 | + plugins: [], |
| 40 | + # |
28 | 41 | # If you create your own checks, you must specify the source files for
|
29 | 42 | # them here, so they can be loaded by Credo before running the analysis.
|
30 | 43 | #
|
|
35 | 48 | #
|
36 | 49 | strict: false,
|
37 | 50 | #
|
| 51 | + # To modify the timeout for parsing files, change this value: |
| 52 | + # |
| 53 | + parse_timeout: 5000, |
| 54 | + # |
38 | 55 | # If you want to use uncolored output by default, you can change `color`
|
39 | 56 | # to `false` below:
|
40 | 57 | #
|
|
47 | 64 | #
|
48 | 65 | # {Credo.Check.Design.DuplicatedCode, false}
|
49 | 66 | #
|
50 |
| - checks: [ |
51 |
| - # |
52 |
| - ## Consistency Checks |
53 |
| - # |
54 |
| - {Credo.Check.Consistency.ExceptionNames, []}, |
55 |
| - {Credo.Check.Consistency.LineEndings, []}, |
56 |
| - {Credo.Check.Consistency.ParameterPatternMatching, []}, |
57 |
| - {Credo.Check.Consistency.SpaceAroundOperators, []}, |
58 |
| - {Credo.Check.Consistency.SpaceInParentheses, []}, |
59 |
| - {Credo.Check.Consistency.TabsOrSpaces, []}, |
| 67 | + checks: %{ |
| 68 | + enabled: [ |
| 69 | + # |
| 70 | + ## Consistency Checks |
| 71 | + # |
| 72 | + {Credo.Check.Consistency.ExceptionNames, []}, |
| 73 | + {Credo.Check.Consistency.LineEndings, []}, |
| 74 | + {Credo.Check.Consistency.ParameterPatternMatching, []}, |
| 75 | + {Credo.Check.Consistency.SpaceAroundOperators, []}, |
| 76 | + {Credo.Check.Consistency.SpaceInParentheses, []}, |
| 77 | + {Credo.Check.Consistency.TabsOrSpaces, []}, |
60 | 78 |
|
61 |
| - # |
62 |
| - ## Design Checks |
63 |
| - # |
64 |
| - # You can customize the priority of any check |
65 |
| - # Priority values are: `low, normal, high, higher` |
66 |
| - # |
67 |
| - {Credo.Check.Design.AliasUsage, |
68 |
| - [priority: :low, if_nested_deeper_than: 2, if_called_more_often_than: 0]}, |
69 |
| - # You can also customize the exit_status of each check. |
70 |
| - # If you don't want TODO comments to cause `mix credo` to fail, just |
71 |
| - # set this value to 0 (zero). |
72 |
| - # |
73 |
| - {Credo.Check.Design.TagTODO, [exit_status: 2]}, |
74 |
| - {Credo.Check.Design.TagFIXME, []}, |
| 79 | + # |
| 80 | + ## Design Checks |
| 81 | + # |
| 82 | + # You can customize the priority of any check |
| 83 | + # Priority values are: `low, normal, high, higher` |
| 84 | + # |
| 85 | + {Credo.Check.Design.AliasUsage, |
| 86 | + [priority: :low, if_nested_deeper_than: 2, if_called_more_often_than: 0]}, |
| 87 | + # You can also customize the exit_status of each check. |
| 88 | + # If you don't want TODO comments to cause `mix credo` to fail, just |
| 89 | + # set this value to 0 (zero). |
| 90 | + # |
| 91 | + {Credo.Check.Design.TagTODO, [exit_status: 2]}, |
| 92 | + {Credo.Check.Design.TagFIXME, []}, |
75 | 93 |
|
76 |
| - # |
77 |
| - ## Readability Checks |
78 |
| - # |
79 |
| - {Credo.Check.Readability.AliasOrder, []}, |
80 |
| - {Credo.Check.Readability.FunctionNames, []}, |
81 |
| - {Credo.Check.Readability.LargeNumbers, []}, |
82 |
| - {Credo.Check.Readability.MaxLineLength, [priority: :low, max_length: 120]}, |
83 |
| - {Credo.Check.Readability.ModuleAttributeNames, []}, |
84 |
| - {Credo.Check.Readability.ModuleDoc, false}, |
85 |
| - {Credo.Check.Readability.ModuleNames, []}, |
86 |
| - {Credo.Check.Readability.ParenthesesInCondition, []}, |
87 |
| - {Credo.Check.Readability.ParenthesesOnZeroArityDefs, []}, |
88 |
| - {Credo.Check.Readability.PredicateFunctionNames, []}, |
89 |
| - {Credo.Check.Readability.PreferImplicitTry, []}, |
90 |
| - {Credo.Check.Readability.RedundantBlankLines, []}, |
91 |
| - {Credo.Check.Readability.Semicolons, []}, |
92 |
| - {Credo.Check.Readability.SpaceAfterCommas, []}, |
93 |
| - {Credo.Check.Readability.StringSigils, []}, |
94 |
| - {Credo.Check.Readability.TrailingBlankLine, []}, |
95 |
| - {Credo.Check.Readability.TrailingWhiteSpace, []}, |
96 |
| - # TODO: enable by default in Credo 1.1 |
97 |
| - {Credo.Check.Readability.UnnecessaryAliasExpansion, false}, |
98 |
| - {Credo.Check.Readability.VariableNames, []}, |
| 94 | + # |
| 95 | + ## Readability Checks |
| 96 | + # |
| 97 | + {Credo.Check.Readability.AliasOrder, []}, |
| 98 | + {Credo.Check.Readability.FunctionNames, []}, |
| 99 | + {Credo.Check.Readability.LargeNumbers, []}, |
| 100 | + {Credo.Check.Readability.MaxLineLength, [priority: :low, max_length: 120]}, |
| 101 | + {Credo.Check.Readability.ModuleAttributeNames, []}, |
| 102 | + {Credo.Check.Readability.ModuleDoc, false}, |
| 103 | + {Credo.Check.Readability.ModuleNames, []}, |
| 104 | + {Credo.Check.Readability.ParenthesesInCondition, []}, |
| 105 | + {Credo.Check.Readability.ParenthesesOnZeroArityDefs, []}, |
| 106 | + {Credo.Check.Readability.PipeIntoAnonymousFunctions, []}, |
| 107 | + {Credo.Check.Readability.PredicateFunctionNames, []}, |
| 108 | + {Credo.Check.Readability.PreferImplicitTry, []}, |
| 109 | + {Credo.Check.Readability.RedundantBlankLines, []}, |
| 110 | + {Credo.Check.Readability.Semicolons, []}, |
| 111 | + {Credo.Check.Readability.SpaceAfterCommas, []}, |
| 112 | + {Credo.Check.Readability.StringSigils, []}, |
| 113 | + {Credo.Check.Readability.TrailingBlankLine, []}, |
| 114 | + {Credo.Check.Readability.TrailingWhiteSpace, []}, |
| 115 | + {Credo.Check.Readability.UnnecessaryAliasExpansion, []}, |
| 116 | + {Credo.Check.Readability.VariableNames, []}, |
| 117 | + {Credo.Check.Readability.WithSingleClause, []}, |
99 | 118 |
|
100 |
| - # |
101 |
| - ## Refactoring Opportunities |
102 |
| - # |
103 |
| - {Credo.Check.Refactor.CondStatements, []}, |
104 |
| - {Credo.Check.Refactor.CyclomaticComplexity, []}, |
105 |
| - {Credo.Check.Refactor.FunctionArity, []}, |
106 |
| - {Credo.Check.Refactor.LongQuoteBlocks, []}, |
107 |
| - {Credo.Check.Refactor.MapInto, false}, |
108 |
| - {Credo.Check.Refactor.MatchInCondition, []}, |
109 |
| - {Credo.Check.Refactor.NegatedConditionsInUnless, []}, |
110 |
| - {Credo.Check.Refactor.NegatedConditionsWithElse, []}, |
111 |
| - {Credo.Check.Refactor.Nesting, []}, |
112 |
| - {Credo.Check.Refactor.PipeChainStart, |
113 |
| - [ |
114 |
| - excluded_argument_types: [:atom, :binary, :fn, :keyword, :number], |
115 |
| - excluded_functions: [] |
116 |
| - ]}, |
117 |
| - {Credo.Check.Refactor.UnlessWithElse, []}, |
| 119 | + # |
| 120 | + ## Refactoring Opportunities |
| 121 | + # |
| 122 | + {Credo.Check.Refactor.Apply, []}, |
| 123 | + {Credo.Check.Refactor.CondStatements, []}, |
| 124 | + {Credo.Check.Refactor.CyclomaticComplexity, []}, |
| 125 | + {Credo.Check.Refactor.FunctionArity, []}, |
| 126 | + {Credo.Check.Refactor.LongQuoteBlocks, []}, |
| 127 | + {Credo.Check.Refactor.MatchInCondition, []}, |
| 128 | + {Credo.Check.Refactor.MapJoin, []}, |
| 129 | + {Credo.Check.Refactor.NegatedConditionsInUnless, []}, |
| 130 | + {Credo.Check.Refactor.NegatedConditionsWithElse, []}, |
| 131 | + {Credo.Check.Refactor.Nesting, []}, |
| 132 | + {Credo.Check.Refactor.UnlessWithElse, []}, |
| 133 | + {Credo.Check.Refactor.WithClauses, []}, |
| 134 | + {Credo.Check.Refactor.FilterFilter, []}, |
| 135 | + {Credo.Check.Refactor.RejectReject, []}, |
| 136 | + {Credo.Check.Refactor.RedundantWithClauseResult, []}, |
118 | 137 |
|
119 |
| - # |
120 |
| - ## Warnings |
121 |
| - # |
122 |
| - {Credo.Check.Warning.BoolOperationOnSameValues, []}, |
123 |
| - {Credo.Check.Warning.ExpensiveEmptyEnumCheck, []}, |
124 |
| - {Credo.Check.Warning.IExPry, []}, |
125 |
| - {Credo.Check.Warning.IoInspect, []}, |
126 |
| - {Credo.Check.Warning.LazyLogging, false}, |
127 |
| - {Credo.Check.Warning.OperationOnSameValues, []}, |
128 |
| - {Credo.Check.Warning.OperationWithConstantResult, []}, |
129 |
| - {Credo.Check.Warning.RaiseInsideRescue, []}, |
130 |
| - {Credo.Check.Warning.UnusedEnumOperation, []}, |
131 |
| - {Credo.Check.Warning.UnusedFileOperation, []}, |
132 |
| - {Credo.Check.Warning.UnusedKeywordOperation, []}, |
133 |
| - {Credo.Check.Warning.UnusedListOperation, []}, |
134 |
| - {Credo.Check.Warning.UnusedPathOperation, []}, |
135 |
| - {Credo.Check.Warning.UnusedRegexOperation, []}, |
136 |
| - {Credo.Check.Warning.UnusedStringOperation, []}, |
137 |
| - {Credo.Check.Warning.UnusedTupleOperation, []}, |
| 138 | + # |
| 139 | + ## Warnings |
| 140 | + # |
| 141 | + {Credo.Check.Warning.ApplicationConfigInModuleAttribute, []}, |
| 142 | + {Credo.Check.Warning.BoolOperationOnSameValues, []}, |
| 143 | + {Credo.Check.Warning.ExpensiveEmptyEnumCheck, []}, |
| 144 | + {Credo.Check.Warning.IExPry, []}, |
| 145 | + {Credo.Check.Warning.IoInspect, []}, |
| 146 | + {Credo.Check.Warning.OperationOnSameValues, []}, |
| 147 | + {Credo.Check.Warning.OperationWithConstantResult, []}, |
| 148 | + {Credo.Check.Warning.RaiseInsideRescue, []}, |
| 149 | + {Credo.Check.Warning.SpecWithStruct, []}, |
| 150 | + {Credo.Check.Warning.WrongTestFileExtension, []}, |
| 151 | + {Credo.Check.Warning.UnusedEnumOperation, []}, |
| 152 | + {Credo.Check.Warning.UnusedFileOperation, []}, |
| 153 | + {Credo.Check.Warning.UnusedKeywordOperation, []}, |
| 154 | + {Credo.Check.Warning.UnusedListOperation, []}, |
| 155 | + {Credo.Check.Warning.UnusedPathOperation, []}, |
| 156 | + {Credo.Check.Warning.UnusedRegexOperation, []}, |
| 157 | + {Credo.Check.Warning.UnusedStringOperation, []}, |
| 158 | + {Credo.Check.Warning.UnusedTupleOperation, []}, |
| 159 | + {Credo.Check.Warning.UnsafeExec, []} |
| 160 | + ], |
| 161 | + disabled: [ |
| 162 | + # |
| 163 | + # Checks scheduled for next check update (opt-in for now, just replace `false` with `[]`) |
138 | 164 |
|
139 |
| - # |
140 |
| - # Controversial and experimental checks (opt-in, just replace `false` with `[]`) |
141 |
| - # |
142 |
| - {Credo.Check.Consistency.MultiAliasImportRequireUse, false}, |
143 |
| - {Credo.Check.Design.DuplicatedCode, false}, |
144 |
| - {Credo.Check.Readability.MultiAlias, false}, |
145 |
| - {Credo.Check.Readability.Specs, false}, |
146 |
| - {Credo.Check.Refactor.ABCSize, false}, |
147 |
| - {Credo.Check.Refactor.AppendSingleItem, false}, |
148 |
| - {Credo.Check.Refactor.DoubleBooleanNegation, false}, |
149 |
| - {Credo.Check.Refactor.ModuleDependencies, false}, |
150 |
| - {Credo.Check.Refactor.VariableRebinding, false}, |
151 |
| - {Credo.Check.Warning.MapGetUnsafePass, false}, |
152 |
| - {Credo.Check.Warning.UnsafeToAtom, false} |
| 165 | + # |
| 166 | + # Controversial and experimental checks (opt-in, just move the check to `:enabled` |
| 167 | + # and be sure to use `mix credo --strict` to see low priority checks) |
| 168 | + # |
| 169 | + {Credo.Check.Consistency.MultiAliasImportRequireUse, []}, |
| 170 | + {Credo.Check.Consistency.UnusedVariableNames, []}, |
| 171 | + {Credo.Check.Design.DuplicatedCode, []}, |
| 172 | + {Credo.Check.Design.SkipTestWithoutComment, []}, |
| 173 | + {Credo.Check.Readability.AliasAs, []}, |
| 174 | + {Credo.Check.Readability.BlockPipe, []}, |
| 175 | + {Credo.Check.Readability.ImplTrue, []}, |
| 176 | + {Credo.Check.Readability.MultiAlias, []}, |
| 177 | + {Credo.Check.Readability.NestedFunctionCalls, []}, |
| 178 | + {Credo.Check.Readability.SeparateAliasRequire, []}, |
| 179 | + {Credo.Check.Readability.SingleFunctionToBlockPipe, []}, |
| 180 | + {Credo.Check.Readability.SinglePipe, []}, |
| 181 | + {Credo.Check.Readability.Specs, []}, |
| 182 | + {Credo.Check.Readability.StrictModuleLayout, []}, |
| 183 | + {Credo.Check.Readability.WithCustomTaggedTuple, []}, |
| 184 | + {Credo.Check.Refactor.ABCSize, []}, |
| 185 | + {Credo.Check.Refactor.AppendSingleItem, []}, |
| 186 | + {Credo.Check.Refactor.DoubleBooleanNegation, []}, |
| 187 | + {Credo.Check.Refactor.FilterReject, []}, |
| 188 | + {Credo.Check.Refactor.IoPuts, []}, |
| 189 | + {Credo.Check.Refactor.MapMap, []}, |
| 190 | + {Credo.Check.Refactor.ModuleDependencies, []}, |
| 191 | + {Credo.Check.Refactor.NegatedIsNil, []}, |
| 192 | + {Credo.Check.Refactor.PipeChainStart, []}, |
| 193 | + {Credo.Check.Refactor.RejectFilter, []}, |
| 194 | + {Credo.Check.Refactor.VariableRebinding, []}, |
| 195 | + {Credo.Check.Warning.LazyLogging, []}, |
| 196 | + {Credo.Check.Warning.LeakyEnvironment, []}, |
| 197 | + {Credo.Check.Warning.MapGetUnsafePass, []}, |
| 198 | + {Credo.Check.Warning.MixEnv, []}, |
| 199 | + {Credo.Check.Warning.UnsafeToAtom, []} |
153 | 200 |
|
154 |
| - # |
155 |
| - # Custom checks can be created using `mix credo.gen.check`. |
156 |
| - # |
157 |
| - ] |
| 201 | + # {Credo.Check.Refactor.MapInto, []}, |
| 202 | + |
| 203 | + # |
| 204 | + # Custom checks can be created using `mix credo.gen.check`. |
| 205 | + # |
| 206 | + ] |
| 207 | + } |
158 | 208 | }
|
159 | 209 | ]
|
160 | 210 | }
|
0 commit comments