Skip to content

Commit 806374d

Browse files
m1dnightm1dnight
committed
Initial
0 parents  commit 806374d

23 files changed

+1305
-0
lines changed

‎.credo.exs

+217
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+
{Credo.Check.Readability.Specs, []},
119+
120+
#
121+
## Refactoring Opportunities
122+
#
123+
{Credo.Check.Refactor.Apply, []},
124+
{Credo.Check.Refactor.CondStatements, []},
125+
{Credo.Check.Refactor.CyclomaticComplexity, []},
126+
{Credo.Check.Refactor.FilterCount, []},
127+
{Credo.Check.Refactor.FilterFilter, []},
128+
{Credo.Check.Refactor.FunctionArity, []},
129+
{Credo.Check.Refactor.LongQuoteBlocks, []},
130+
{Credo.Check.Refactor.MapJoin, []},
131+
{Credo.Check.Refactor.MatchInCondition, []},
132+
{Credo.Check.Refactor.NegatedConditionsInUnless, []},
133+
{Credo.Check.Refactor.NegatedConditionsWithElse, []},
134+
{Credo.Check.Refactor.Nesting, []},
135+
{Credo.Check.Refactor.RedundantWithClauseResult, []},
136+
{Credo.Check.Refactor.RejectReject, []},
137+
{Credo.Check.Refactor.UnlessWithElse, []},
138+
{Credo.Check.Refactor.WithClauses, []},
139+
140+
#
141+
## Warnings
142+
#
143+
{Credo.Check.Warning.ApplicationConfigInModuleAttribute, []},
144+
{Credo.Check.Warning.BoolOperationOnSameValues, []},
145+
{Credo.Check.Warning.Dbg, []},
146+
{Credo.Check.Warning.ExpensiveEmptyEnumCheck, []},
147+
{Credo.Check.Warning.IExPry, []},
148+
{Credo.Check.Warning.IoInspect, []},
149+
{Credo.Check.Warning.MissedMetadataKeyInLoggerConfig, []},
150+
{Credo.Check.Warning.OperationOnSameValues, []},
151+
{Credo.Check.Warning.OperationWithConstantResult, []},
152+
{Credo.Check.Warning.RaiseInsideRescue, []},
153+
{Credo.Check.Warning.SpecWithStruct, []},
154+
{Credo.Check.Warning.UnsafeExec, []},
155+
{Credo.Check.Warning.UnusedEnumOperation, []},
156+
{Credo.Check.Warning.UnusedFileOperation, []},
157+
{Credo.Check.Warning.UnusedKeywordOperation, []},
158+
{Credo.Check.Warning.UnusedListOperation, []},
159+
{Credo.Check.Warning.UnusedPathOperation, []},
160+
{Credo.Check.Warning.UnusedRegexOperation, []},
161+
{Credo.Check.Warning.UnusedStringOperation, []},
162+
{Credo.Check.Warning.UnusedTupleOperation, []},
163+
{Credo.Check.Warning.WrongTestFileExtension, []}
164+
],
165+
disabled: [
166+
#
167+
# Checks scheduled for next check update (opt-in for now)
168+
{Credo.Check.Refactor.UtcNowTruncate, []},
169+
170+
#
171+
# Controversial and experimental checks (opt-in, just move the check to `:enabled`
172+
# and be sure to use `mix credo --strict` to see low priority checks)
173+
#
174+
{Credo.Check.Consistency.MultiAliasImportRequireUse, []},
175+
{Credo.Check.Consistency.UnusedVariableNames, []},
176+
{Credo.Check.Design.DuplicatedCode, []},
177+
{Credo.Check.Design.SkipTestWithoutComment, []},
178+
{Credo.Check.Readability.AliasAs, []},
179+
{Credo.Check.Readability.BlockPipe, []},
180+
{Credo.Check.Readability.ImplTrue, []},
181+
{Credo.Check.Readability.MultiAlias, []},
182+
{Credo.Check.Readability.NestedFunctionCalls, []},
183+
{Credo.Check.Readability.OneArityFunctionInPipe, []},
184+
{Credo.Check.Readability.OnePipePerLine, []},
185+
{Credo.Check.Readability.SeparateAliasRequire, []},
186+
{Credo.Check.Readability.SingleFunctionToBlockPipe, []},
187+
{Credo.Check.Readability.SinglePipe, []},
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+
}

‎.formatter.exs

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# Used by "mix format"
2+
[
3+
inputs: ["{mix,.formatter}.exs", "{config,lib,test}/**/*.{ex,exs}"]
4+
]

‎.github/workflows/compile.yaml

+45
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
name: Compile workflow
2+
on:
3+
workflow_call:
4+
inputs:
5+
mix-env:
6+
required: true
7+
type: string
8+
elixir-version:
9+
required: true
10+
type: string
11+
otp-version:
12+
required: true
13+
type: string
14+
secrets:
15+
token:
16+
required: false
17+
jobs:
18+
compile:
19+
runs-on: ubuntu-latest
20+
steps:
21+
- name: checkout the repository
22+
uses: actions/checkout@v4
23+
24+
- name: setup deps and _build cache
25+
uses: actions/cache@v4
26+
with:
27+
path: |
28+
${{ github.workspace }}/deps
29+
${{ github.workspace }}/_build
30+
key: ${{ runner.os }}-build-${{ inputs.mix-env }}-${{ hashFiles('mix.lock') }}
31+
32+
- name: setup elixir
33+
uses: ./.github/actions/elixir_setup
34+
with:
35+
elixir-version: ${{ inputs.elixir-version }}
36+
otp-version: ${{ inputs.otp-version }}
37+
38+
- name: install apt packages
39+
uses: ./.github/actions/os_setup
40+
41+
- name: fetch elixir dependencies
42+
run: MIX_ENV=${{ inputs.mix-env }} mix deps.get
43+
44+
- name: compile elixir project
45+
run: MIX_ENV=${{ inputs.mix-env }} mix compile

‎.github/workflows/docs.yaml

+39
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
name: Generate docs
2+
on:
3+
workflow_call:
4+
inputs:
5+
mix-env:
6+
required: true
7+
type: string
8+
elixir-version:
9+
required: true
10+
type: string
11+
otp-version:
12+
required: true
13+
type: string
14+
jobs:
15+
compile-docs:
16+
runs-on: ubuntu-latest
17+
steps:
18+
- name: checkout the repository
19+
uses: actions/checkout@v4
20+
21+
- name: setup deps and _build cache
22+
uses: actions/cache@v4
23+
with:
24+
path: |
25+
${{ github.workspace }}/deps
26+
${{ github.workspace }}/_build
27+
key: ${{ runner.os }}-build-${{ inputs.mix-env }}-${{ hashFiles('mix.lock') }}
28+
29+
- name: setup elixir
30+
uses: ./.github/actions/elixir_setup
31+
with:
32+
elixir-version: ${{ inputs.elixir-version }}
33+
otp-version: ${{ inputs.otp-version }}
34+
35+
- name: install apt packages
36+
uses: ./.github/actions/os_setup
37+
38+
- name: generate docs
39+
run: MIX_ENV=${{ inputs.mix-env }} mix docs

‎.github/workflows/lint.yaml

+58
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
name: Linting workflow
2+
on:
3+
workflow_call:
4+
inputs:
5+
mix-env:
6+
required: true
7+
type: string
8+
elixir-version:
9+
required: true
10+
type: string
11+
otp-version:
12+
required: true
13+
type: string
14+
jobs:
15+
lint:
16+
runs-on: ubuntu-latest
17+
steps:
18+
- name: checkout the repository
19+
uses: actions/checkout@v4
20+
21+
- name: setup deps and _build cache
22+
uses: actions/cache@v4
23+
with:
24+
path: |
25+
${{ github.workspace }}/deps
26+
${{ github.workspace }}/_build
27+
key: ${{ runner.os }}-build-${{ inputs.mix-env }}-${{ hashFiles('mix.lock') }}
28+
29+
- name: setup plt cache
30+
uses: actions/cache@v4
31+
with:
32+
path: ${{ github.workspace }}/plts
33+
key: ${{ runner.os }}-plt-${{ inputs.mix-env }}-${{ hashFiles('**/*.ex') }}
34+
35+
- name: setup elixir
36+
uses: ./.github/actions/elixir_setup
37+
with:
38+
elixir-version: ${{ inputs.elixir-version }}
39+
otp-version: ${{ inputs.otp-version }}
40+
41+
- name: install apt packages
42+
uses: ./.github/actions/os_setup
43+
44+
- name: mix credo
45+
shell: bash
46+
run: MIX_ENV=${{inputs.mix-env}} mix credo
47+
48+
- name: mix format
49+
shell: bash
50+
run: MIX_ENV=${{inputs.mix-env}} mix format --check-formatted
51+
52+
- name: mix dialyzer
53+
shell: bash
54+
run: MIX_ENV=${{inputs.mix-env}} mix dialyzer --format github
55+
56+
- name: trailing whitespaces
57+
shell: bash
58+
run: git diff-tree --check 4b825dc642cb6eb9a060e54bf8d69288fbee4904 HEAD

‎.github/workflows/on_push.yml

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
name: Push
2+
run-name: Push
3+
on: [push]
4+
5+
jobs:
6+
compile:
7+
strategy:
8+
matrix:
9+
target: [dev, test, prod]
10+
uses: ./.github/workflows/compile.yaml
11+
with:
12+
mix-env: ${{ matrix.target }}
13+
elixir-version: "1.17"
14+
otp-version: "27.1"
15+
16+
lint:
17+
needs: compile
18+
uses: ./.github/workflows/lint.yaml
19+
with:
20+
mix-env: "dev"
21+
elixir-version: "1.17"
22+
otp-version: "27.1"

0 commit comments

Comments
 (0)