Skip to content

Commit 0959cb2

Browse files
kasvithkasvith
committed
feat: router and docs
1 parent 892ceee commit 0959cb2

11 files changed

Lines changed: 1978 additions & 85 deletions

File tree

‎.credo.exs‎

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -82,14 +82,14 @@
8282
# You can customize the priority of any check
8383
# Priority values are: `low, normal, high, higher`
8484
#
85-
{Credo.Check.Design.AliasUsage,
86-
[priority: :low, if_nested_deeper_than: 2, if_called_more_often_than: 0]},
85+
# Disabled: nested modules in macro quotes require full paths for hygiene
86+
{Credo.Check.Design.AliasUsage, false},
8787
{Credo.Check.Design.TagFIXME, []},
8888
# You can also customize the exit_status of each check.
8989
# If you don't want TODO comments to cause `mix credo` to fail, just
9090
# set this value to 0 (zero).
9191
#
92-
{Credo.Check.Design.TagTODO, [exit_status: 2]},
92+
{Credo.Check.Design.TagTODO, [exit_status: 0]},
9393

9494
#
9595
## Readability Checks
@@ -105,7 +105,8 @@
105105
{Credo.Check.Readability.ParenthesesOnZeroArityDefs, []},
106106
{Credo.Check.Readability.PipeIntoAnonymousFunctions, []},
107107
{Credo.Check.Readability.PredicateFunctionNames, []},
108-
{Credo.Check.Readability.PreferImplicitTry, []},
108+
# Disabled: explicit try is clearer for complex exception handling
109+
{Credo.Check.Readability.PreferImplicitTry, false},
109110
{Credo.Check.Readability.RedundantBlankLines, []},
110111
{Credo.Check.Readability.Semicolons, []},
111112
{Credo.Check.Readability.SpaceAfterCommas, []},
@@ -121,7 +122,8 @@
121122
#
122123
{Credo.Check.Refactor.Apply, []},
123124
{Credo.Check.Refactor.CondStatements, []},
124-
{Credo.Check.Refactor.CyclomaticComplexity, []},
125+
# Increased limit for compiler macros which are inherently complex
126+
{Credo.Check.Refactor.CyclomaticComplexity, [max_complexity: 30]},
125127
{Credo.Check.Refactor.FilterCount, []},
126128
{Credo.Check.Refactor.FilterFilter, []},
127129
{Credo.Check.Refactor.FunctionArity, []},

‎.github/workflows/ci.yml‎

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
name: CI
2+
3+
on:
4+
push:
5+
branches: [main]
6+
pull_request:
7+
branches: [main]
8+
9+
env:
10+
MIX_ENV: test
11+
12+
jobs:
13+
test:
14+
name: Test (Elixir ${{ matrix.elixir }} / OTP ${{ matrix.otp }})
15+
runs-on: ubuntu-latest
16+
17+
strategy:
18+
matrix:
19+
elixir: ["1.19"]
20+
otp: ["28"]
21+
22+
steps:
23+
- uses: actions/checkout@v6
24+
25+
- name: Set up Elixir
26+
uses: erlef/setup-beam@v1
27+
with:
28+
elixir-version: ${{ matrix.elixir }}
29+
otp-version: ${{ matrix.otp }}
30+
31+
- name: Restore dependencies cache
32+
uses: actions/cache@v4
33+
with:
34+
path: deps
35+
key: ${{ runner.os }}-mix-${{ hashFiles('**/mix.lock') }}
36+
restore-keys: ${{ runner.os }}-mix-
37+
38+
- name: Restore build cache
39+
uses: actions/cache@v5
40+
with:
41+
path: _build
42+
key: ${{ runner.os }}-build-${{ matrix.otp }}-${{ matrix.elixir }}-${{ hashFiles('**/mix.lock') }}
43+
restore-keys: ${{ runner.os }}-build-${{ matrix.otp }}-${{ matrix.elixir }}-
44+
45+
- name: Install dependencies
46+
run: mix deps.get
47+
48+
- name: Check formatting
49+
run: mix format --check-formatted
50+
51+
- name: Compile
52+
run: mix compile --warnings-as-errors
53+
54+
- name: Run tests
55+
run: mix test
56+
57+
credo:
58+
name: Credo
59+
runs-on: ubuntu-latest
60+
61+
steps:
62+
- uses: actions/checkout@v4
63+
64+
- name: Set up Elixir
65+
uses: erlef/setup-beam@v1
66+
with:
67+
elixir-version: "1.19"
68+
otp-version: "28"
69+
70+
- name: Restore dependencies cache
71+
uses: actions/cache@v4
72+
with:
73+
path: deps
74+
key: ${{ runner.os }}-mix-${{ hashFiles('**/mix.lock') }}
75+
restore-keys: ${{ runner.os }}-mix-
76+
77+
- name: Install dependencies
78+
run: mix deps.get
79+
80+
- name: Run Credo
81+
run: mix credo --strict

‎.tool-versions‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
erlang 28.1
2+
elixir 1.19-otp-28

‎LICENSE‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2025 WaveZync
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

0 commit comments

Comments
 (0)