Skip to content

Commit a598a48

Browse files
mruossmruoss
committed
refactoring and devex tools
1 parent 11d1eb2 commit a598a48

19 files changed

+480
-133
lines changed

‎.credo.exs

+216
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,216 @@
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, [parens: true]},
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, just replace `false` with `[]`)
167+
168+
#
169+
# Controversial and experimental checks (opt-in, just move the check to `:enabled`
170+
# and be sure to use `mix credo --strict` to see low priority checks)
171+
#
172+
{Credo.Check.Consistency.MultiAliasImportRequireUse, []},
173+
{Credo.Check.Consistency.UnusedVariableNames, []},
174+
{Credo.Check.Design.DuplicatedCode, []},
175+
{Credo.Check.Design.SkipTestWithoutComment, []},
176+
{Credo.Check.Readability.AliasAs, []},
177+
{Credo.Check.Readability.BlockPipe, []},
178+
{Credo.Check.Readability.ImplTrue, []},
179+
{Credo.Check.Readability.MultiAlias, []},
180+
{Credo.Check.Readability.NestedFunctionCalls, []},
181+
{Credo.Check.Readability.OneArityFunctionInPipe, []},
182+
{Credo.Check.Readability.OnePipePerLine, []},
183+
{Credo.Check.Readability.SeparateAliasRequire, []},
184+
{Credo.Check.Readability.SingleFunctionToBlockPipe, []},
185+
{Credo.Check.Readability.SinglePipe, []},
186+
{Credo.Check.Readability.Specs, []},
187+
{Credo.Check.Readability.StrictModuleLayout, []},
188+
{Credo.Check.Readability.WithCustomTaggedTuple, []},
189+
{Credo.Check.Refactor.ABCSize, []},
190+
{Credo.Check.Refactor.AppendSingleItem, []},
191+
{Credo.Check.Refactor.DoubleBooleanNegation, []},
192+
{Credo.Check.Refactor.FilterReject, []},
193+
{Credo.Check.Refactor.IoPuts, []},
194+
{Credo.Check.Refactor.MapMap, []},
195+
{Credo.Check.Refactor.ModuleDependencies, []},
196+
{Credo.Check.Refactor.NegatedIsNil, []},
197+
{Credo.Check.Refactor.PassAsyncInTestCases, []},
198+
{Credo.Check.Refactor.PipeChainStart, []},
199+
{Credo.Check.Refactor.RejectFilter, []},
200+
{Credo.Check.Refactor.VariableRebinding, []},
201+
{Credo.Check.Warning.LazyLogging, []},
202+
{Credo.Check.Warning.LeakyEnvironment, []},
203+
{Credo.Check.Warning.MapGetUnsafePass, []},
204+
{Credo.Check.Warning.MixEnv, []},
205+
{Credo.Check.Warning.UnsafeToAtom, []}
206+
207+
# {Credo.Check.Refactor.MapInto, []},
208+
209+
#
210+
# Custom checks can be created using `mix credo.gen.check`.
211+
#
212+
]
213+
}
214+
}
215+
]
216+
}

‎.dialyzer_ignore.exs

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
[
2+
]

‎.env

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
ERL_AFLAGS = "-kernel shell_history enabled"

‎.formatter.exs

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

‎.github/workflows/code_quality.yaml

+54
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
name: Code Quality
2+
on:
3+
push:
4+
branches: [main]
5+
pull_request:
6+
branches: [main]
7+
8+
env:
9+
MIX_ENV: test
10+
11+
jobs:
12+
code-quality:
13+
name: Code Quality
14+
runs-on: ubuntu-latest
15+
steps:
16+
- uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4
17+
18+
- name: Setup elixir
19+
id: beam
20+
uses: erlef/setup-beam@v1
21+
with:
22+
version-file: .tool-versions
23+
version-type: strict
24+
install-rebar: true
25+
install-hex: true
26+
27+
- name: Retrieve Build Cache
28+
uses: actions/cache@v4
29+
id: build-folder-cache
30+
with:
31+
path: _build/test
32+
key: ${{ runner.os }}-${{ steps.beam.outputs.otp-version }}-${{ steps.beam.outputs.elixir-version }}-build-test-${{ hashFiles(format('{0}{1}', github.workspace, '/mix.lock')) }}
33+
34+
- name: Retrieve Mix Dependencies Cache
35+
uses: actions/cache@v4
36+
id: mix-cache
37+
with:
38+
path: deps
39+
key: ${{ runner.os }}-${{ steps.beam.outputs.otp-version }}-${{ steps.beam.outputs.elixir-version }}-mix-${{ hashFiles(format('{0}{1}', github.workspace, '/mix.lock')) }}
40+
41+
- name: Install Mix Dependencies
42+
run: mix deps.get
43+
44+
- name: Check Formatting
45+
run: mix format --check-formatted
46+
47+
- name: Compile
48+
run: MIX_ENV=test mix compile --warnings-as-errors
49+
50+
- name: Unit Tests
51+
run: MIX_ENV=test mix test
52+
53+
- name: Run Credo
54+
run: MIX_ENV=test mix credo --strict

‎.gitignore

+1-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ kubegen-*.tar
2626
/tmp/
2727

2828
# Generated Files
29-
/lib/kubegen/k8s/
29+
/lib/kubegen/k8s_client/
3030

3131
# Ignore dialyzer files
3232
/priv/plts/

‎.rtx.toml

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
env_file = '.env'

‎.tool-versions

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
erlang 26.2.2
2+
elixir 1.16.2
3+
kind 0.22.0

‎LICENSE.md

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

‎config/config.exs

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
import Config
22

3-
if File.exists?("config/#{Mix.env()}.exs"), do: import_config "#{Mix.env()}.exs"
3+
if File.exists?("config/#{Mix.env()}.exs"), do: import_config("#{Mix.env()}.exs")

‎config/dev.exs

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import Config
22

33
config :kubegen, :default,
4-
module_prefix: Kubegen.K8s.Client,
4+
module_prefix: Kubegen.K8sClient,
55
resources: [
66
"v1/ConfigMap",
77
"rbac.authorization.k8s.io/v1/ClusterRole",

‎lib/kubegen.ex

-18
This file was deleted.

0 commit comments

Comments
 (0)