Skip to content

Commit ad5f85f

Browse files
committed
initial
0 parents  commit ad5f85f

40 files changed

Lines changed: 4905 additions & 0 deletions

.credo.exs

Lines changed: 218 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,218 @@
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.StructFieldAmount, []},
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.Specs, []},
189+
{Credo.Check.Readability.StrictModuleLayout, []},
190+
{Credo.Check.Readability.WithCustomTaggedTuple, []},
191+
{Credo.Check.Refactor.ABCSize, []},
192+
{Credo.Check.Refactor.AppendSingleItem, []},
193+
{Credo.Check.Refactor.DoubleBooleanNegation, []},
194+
{Credo.Check.Refactor.FilterReject, []},
195+
{Credo.Check.Refactor.IoPuts, []},
196+
{Credo.Check.Refactor.MapMap, []},
197+
{Credo.Check.Refactor.ModuleDependencies, []},
198+
{Credo.Check.Refactor.NegatedIsNil, []},
199+
{Credo.Check.Refactor.PassAsyncInTestCases, []},
200+
{Credo.Check.Refactor.PipeChainStart, []},
201+
{Credo.Check.Refactor.RejectFilter, []},
202+
{Credo.Check.Refactor.VariableRebinding, []},
203+
{Credo.Check.Warning.LazyLogging, []},
204+
{Credo.Check.Warning.LeakyEnvironment, []},
205+
{Credo.Check.Warning.MapGetUnsafePass, []},
206+
{Credo.Check.Warning.MixEnv, []},
207+
{Credo.Check.Warning.UnsafeToAtom, []}
208+
209+
# {Credo.Check.Refactor.MapInto, []},
210+
211+
#
212+
# Custom checks can be created using `mix credo.gen.check`.
213+
#
214+
]
215+
}
216+
}
217+
]
218+
}

.formatter.exs

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Used by "mix format"
2+
[
3+
import_deps: [:ecto, :ecto_sql],
4+
inputs: ["{mix,.formatter}.exs", "{config,lib,test}/**/*.{ex,exs}"]
5+
]

.github/dependabot.yml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
version: 2
2+
updates:
3+
- package-ecosystem: "mix"
4+
directory: "/"
5+
schedule:
6+
interval: "daily"
7+
open-pull-requests-limit: 3
8+
- package-ecosystem: "github-actions"
9+
directory: "/"
10+
schedule:
11+
interval: "weekly"
12+
open-pull-requests-limit: 1

.github/workflows/ci.yml

Lines changed: 94 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,94 @@
1+
name: ci
2+
3+
on:
4+
pull_request:
5+
push:
6+
branches: [master]
7+
8+
# env:
9+
# CACHE_VERSION: v1
10+
# PERSISTENT_CACHE_DIR: cached
11+
12+
jobs:
13+
ci:
14+
runs-on: ubuntu-latest
15+
16+
strategy:
17+
fail-fast: false
18+
matrix:
19+
include:
20+
- tuple:
21+
elixir: "1.16"
22+
erlang: "26.2"
23+
postgres: "15.8-alpine"
24+
- tuple:
25+
elixir: "1.18"
26+
erlang: "27.3.2"
27+
postgres: "15.8-alpine"
28+
29+
env:
30+
MIX_ENV: test
31+
32+
services:
33+
postgres:
34+
image: postgres:${{ matrix.tuple.postgres }}
35+
ports:
36+
- 5434:5432
37+
env:
38+
POSTGRES_USER: postgres
39+
POSTGRES_PASSWORD: postgres
40+
options: >-
41+
--health-cmd pg_isready
42+
--health-interval 10s
43+
--health-timeout 5s
44+
--health-retries 5
45+
46+
mysql:
47+
image: mysql:8.0
48+
env:
49+
MYSQL_ROOT_PASSWORD: mysql
50+
MYSQL_DATABASE: nested_sets_test
51+
options: >-
52+
--health-cmd="mysqladmin ping -uroot -pmysql"
53+
--health-interval=10s
54+
--health-timeout=5s
55+
--health-retries=3
56+
ports:
57+
- 3307:3306
58+
59+
steps:
60+
- uses: actions/checkout@v5
61+
62+
- uses: erlef/setup-beam@v1
63+
with:
64+
elixir-version: ${{ matrix.tuple.elixir }}
65+
otp-version: ${{ matrix.tuple.erlang }}
66+
67+
- uses: actions/cache@v4
68+
with:
69+
path: |
70+
deps
71+
_build
72+
key: ${{ matrix.tuple.elixir }}-${{ matrix.tuple.erlang }}-${{ hashFiles('**/mix.lock') }}
73+
restore-keys: |
74+
${{ matrix.tuple.elixir }}-${{ matrix.tuple.erlang }}-
75+
76+
- run: mix deps.get --only $MIX_ENV
77+
78+
- run: mix format --check-formatted
79+
80+
- run: mix deps.compile
81+
82+
- run: mix compile --warnings-as-errors
83+
84+
- run: mix credo --strict
85+
86+
- run: mix test.setup
87+
env:
88+
MYSQL_URL: mysql://root:mysql@localhost:${{job.services.mysql.ports[3306]}}/nested_sets_test
89+
90+
- run: mix test
91+
env:
92+
MYSQL_URL: mysql://root:mysql@localhost:${{job.services.mysql.ports[3306]}}/nested_sets_test
93+
94+
- run: mix dialyzer

0 commit comments

Comments
 (0)