Skip to content

Commit 8b26c50

Browse files
GSMLG-BOTGSMLG-BOT
committed
feat: Add Credo and Dialyzer for code quality analysis
Add static code analysis tools to improve code quality and catch potential issues: - Add Credo (~> 1.7) for style checking and code smell detection - Add Dialyxir (~> 1.4) for static type analysis - Generate .credo.exs configuration file - Configure Dialyzer with PLT in priv/plts/dialyzer.plt - Add Dialyzer PLT directory to .gitignore - Enhance CLAUDE.md with comprehensive architecture documentation: - Detailed module descriptions with file paths - Key design patterns and implementation details - Code quality tools section documenting current known issues - Development commands including Credo and Dialyzer usage - Split GitHub Actions workflow into separate CI and test jobs
1 parent 530f169 commit 8b26c50

File tree

8 files changed

+520
-83
lines changed

8 files changed

+520
-83
lines changed

‎.credo.exs‎

Lines changed: 217 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,217 @@
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+
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, []},
78+
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+
{Credo.Check.Design.TagFIXME, []},
88+
# You can also customize the exit_status of each check.
89+
# If you don't want TODO comments to cause `mix credo` to fail, just
90+
# set this value to 0 (zero).
91+
#
92+
{Credo.Check.Design.TagTODO, [exit_status: 2]},
93+
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, []},
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, []},
118+
119+
#
120+
## Refactoring Opportunities
121+
#
122+
{Credo.Check.Refactor.Apply, []},
123+
{Credo.Check.Refactor.CondStatements, []},
124+
{Credo.Check.Refactor.CyclomaticComplexity, []},
125+
{Credo.Check.Refactor.FilterCount, []},
126+
{Credo.Check.Refactor.FilterFilter, []},
127+
{Credo.Check.Refactor.FunctionArity, []},
128+
{Credo.Check.Refactor.LongQuoteBlocks, []},
129+
{Credo.Check.Refactor.MapJoin, []},
130+
{Credo.Check.Refactor.MatchInCondition, []},
131+
{Credo.Check.Refactor.NegatedConditionsInUnless, []},
132+
{Credo.Check.Refactor.NegatedConditionsWithElse, []},
133+
{Credo.Check.Refactor.Nesting, []},
134+
{Credo.Check.Refactor.RedundantWithClauseResult, []},
135+
{Credo.Check.Refactor.RejectReject, []},
136+
{Credo.Check.Refactor.UnlessWithElse, []},
137+
{Credo.Check.Refactor.WithClauses, []},
138+
139+
#
140+
## Warnings
141+
#
142+
{Credo.Check.Warning.ApplicationConfigInModuleAttribute, []},
143+
{Credo.Check.Warning.BoolOperationOnSameValues, []},
144+
{Credo.Check.Warning.Dbg, []},
145+
{Credo.Check.Warning.ExpensiveEmptyEnumCheck, []},
146+
{Credo.Check.Warning.IExPry, []},
147+
{Credo.Check.Warning.IoInspect, []},
148+
{Credo.Check.Warning.MissedMetadataKeyInLoggerConfig, []},
149+
{Credo.Check.Warning.OperationOnSameValues, []},
150+
{Credo.Check.Warning.OperationWithConstantResult, []},
151+
{Credo.Check.Warning.RaiseInsideRescue, []},
152+
{Credo.Check.Warning.SpecWithStruct, []},
153+
{Credo.Check.Warning.UnsafeExec, []},
154+
{Credo.Check.Warning.UnusedEnumOperation, []},
155+
{Credo.Check.Warning.UnusedFileOperation, []},
156+
{Credo.Check.Warning.UnusedKeywordOperation, []},
157+
{Credo.Check.Warning.UnusedListOperation, []},
158+
{Credo.Check.Warning.UnusedPathOperation, []},
159+
{Credo.Check.Warning.UnusedRegexOperation, []},
160+
{Credo.Check.Warning.UnusedStringOperation, []},
161+
{Credo.Check.Warning.UnusedTupleOperation, []},
162+
{Credo.Check.Warning.WrongTestFileExtension, []}
163+
],
164+
disabled: [
165+
#
166+
# Checks scheduled for next check update (opt-in for now)
167+
{Credo.Check.Refactor.UtcNowTruncate, []},
168+
169+
#
170+
# Controversial and experimental checks (opt-in, just move the check to `:enabled`
171+
# and be sure to use `mix credo --strict` to see low priority checks)
172+
#
173+
{Credo.Check.Consistency.MultiAliasImportRequireUse, []},
174+
{Credo.Check.Consistency.UnusedVariableNames, []},
175+
{Credo.Check.Design.DuplicatedCode, []},
176+
{Credo.Check.Design.SkipTestWithoutComment, []},
177+
{Credo.Check.Readability.AliasAs, []},
178+
{Credo.Check.Readability.BlockPipe, []},
179+
{Credo.Check.Readability.ImplTrue, []},
180+
{Credo.Check.Readability.MultiAlias, []},
181+
{Credo.Check.Readability.NestedFunctionCalls, []},
182+
{Credo.Check.Readability.OneArityFunctionInPipe, []},
183+
{Credo.Check.Readability.OnePipePerLine, []},
184+
{Credo.Check.Readability.SeparateAliasRequire, []},
185+
{Credo.Check.Readability.SingleFunctionToBlockPipe, []},
186+
{Credo.Check.Readability.SinglePipe, []},
187+
{Credo.Check.Readability.Specs, []},
188+
{Credo.Check.Readability.StrictModuleLayout, []},
189+
{Credo.Check.Readability.WithCustomTaggedTuple, []},
190+
{Credo.Check.Refactor.ABCSize, []},
191+
{Credo.Check.Refactor.AppendSingleItem, []},
192+
{Credo.Check.Refactor.DoubleBooleanNegation, []},
193+
{Credo.Check.Refactor.FilterReject, []},
194+
{Credo.Check.Refactor.IoPuts, []},
195+
{Credo.Check.Refactor.MapMap, []},
196+
{Credo.Check.Refactor.ModuleDependencies, []},
197+
{Credo.Check.Refactor.NegatedIsNil, []},
198+
{Credo.Check.Refactor.PassAsyncInTestCases, []},
199+
{Credo.Check.Refactor.PipeChainStart, []},
200+
{Credo.Check.Refactor.RejectFilter, []},
201+
{Credo.Check.Refactor.VariableRebinding, []},
202+
{Credo.Check.Warning.LazyLogging, []},
203+
{Credo.Check.Warning.LeakyEnvironment, []},
204+
{Credo.Check.Warning.MapGetUnsafePass, []},
205+
{Credo.Check.Warning.MixEnv, []},
206+
{Credo.Check.Warning.UnsafeToAtom, []}
207+
208+
# {Credo.Check.Refactor.MapInto, []},
209+
210+
#
211+
# Custom checks can be created using `mix credo.gen.check`.
212+
#
213+
]
214+
}
215+
}
216+
]
217+
}

‎.github/workflows/ci.yml‎

Lines changed: 129 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,129 @@
1+
name: CI
2+
3+
on:
4+
push:
5+
branches: [ '*' ]
6+
7+
jobs:
8+
compile:
9+
name: Compile
10+
runs-on: ubuntu-latest
11+
12+
steps:
13+
- name: Checkout code
14+
uses: actions/checkout@v4
15+
16+
- name: Set up Elixir
17+
uses: erlef/setup-beam@v1
18+
with:
19+
elixir-version: '1.18'
20+
otp-version: '28'
21+
22+
- name: Restore dependencies cache
23+
uses: actions/cache@v4
24+
with:
25+
path: |
26+
deps
27+
_build
28+
key: ${{ runner.os }}-mix-${{ hashFiles('**/mix.lock') }}
29+
restore-keys: ${{ runner.os }}-mix-
30+
31+
- name: Install dependencies
32+
run: mix deps.get
33+
34+
- name: Compile with warnings as errors
35+
run: mix compile --warnings-as-errors
36+
37+
format:
38+
name: Format Check
39+
runs-on: ubuntu-latest
40+
41+
steps:
42+
- name: Checkout code
43+
uses: actions/checkout@v4
44+
45+
- name: Set up Elixir
46+
uses: erlef/setup-beam@v1
47+
with:
48+
elixir-version: '1.18'
49+
otp-version: '28'
50+
51+
- name: Restore dependencies cache
52+
uses: actions/cache@v4
53+
with:
54+
path: |
55+
deps
56+
_build
57+
key: ${{ runner.os }}-mix-${{ hashFiles('**/mix.lock') }}
58+
restore-keys: ${{ runner.os }}-mix-
59+
60+
- name: Install dependencies
61+
run: mix deps.get
62+
63+
- name: Check code formatting
64+
run: mix format --check-formatted
65+
66+
credo:
67+
name: Credo
68+
runs-on: ubuntu-latest
69+
70+
steps:
71+
- name: Checkout code
72+
uses: actions/checkout@v4
73+
74+
- name: Set up Elixir
75+
uses: erlef/setup-beam@v1
76+
with:
77+
elixir-version: '1.18'
78+
otp-version: '28'
79+
80+
- name: Restore dependencies cache
81+
uses: actions/cache@v4
82+
with:
83+
path: |
84+
deps
85+
_build
86+
key: ${{ runner.os }}-mix-${{ hashFiles('**/mix.lock') }}
87+
restore-keys: ${{ runner.os }}-mix-
88+
89+
- name: Install dependencies
90+
run: mix deps.get
91+
92+
- name: Run Credo strict
93+
run: mix credo --strict
94+
95+
dialyzer:
96+
name: Dialyzer
97+
runs-on: ubuntu-latest
98+
99+
steps:
100+
- name: Checkout code
101+
uses: actions/checkout@v4
102+
103+
- name: Set up Elixir
104+
uses: erlef/setup-beam@v1
105+
with:
106+
elixir-version: '1.18'
107+
otp-version: '28'
108+
109+
- name: Restore dependencies cache
110+
uses: actions/cache@v4
111+
with:
112+
path: |
113+
deps
114+
_build
115+
key: ${{ runner.os }}-mix-${{ hashFiles('**/mix.lock') }}
116+
restore-keys: ${{ runner.os }}-mix-
117+
118+
- name: Install dependencies
119+
run: mix deps.get
120+
121+
- name: Restore Dialyzer PLT cache
122+
uses: actions/cache@v4
123+
with:
124+
path: priv/plts
125+
key: ${{ runner.os }}-dialyzer-${{ hashFiles('**/mix.lock') }}
126+
restore-keys: ${{ runner.os }}-dialyzer-
127+
128+
- name: Run Dialyzer
129+
run: mix dialyzer --halt-exit-status

‎.github/workflows/elixir.yml‎

Lines changed: 0 additions & 32 deletions
This file was deleted.

0 commit comments

Comments
 (0)