-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore(build): add code quality and ci checks
- Loading branch information
Showing
5 changed files
with
364 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,217 @@ | ||
| # This file contains the configuration for Credo and you are probably reading | ||
| # this after creating it with `mix credo.gen.config`. | ||
| # | ||
| # If you find anything wrong or unclear in this file, please report an | ||
| # issue on GitHub: https://github.com/rrrene/credo/issues | ||
| # | ||
| %{ | ||
| # | ||
| # You can have as many configs as you like in the `configs:` field. | ||
| configs: [ | ||
| %{ | ||
| # | ||
| # Run any config using `mix credo -C <name>`. If no config name is given | ||
| # "default" is used. | ||
| # | ||
| name: "default", | ||
| # | ||
| # These are the files included in the analysis: | ||
| files: %{ | ||
| # | ||
| # You can give explicit globs or simply directories. | ||
| # In the latter case `**/*.{ex,exs}` will be used. | ||
| # | ||
| included: [ | ||
| "lib/", | ||
| "src/", | ||
| "test/", | ||
| "web/", | ||
| "apps/*/lib/", | ||
| "apps/*/src/", | ||
| "apps/*/test/", | ||
| "apps/*/web/" | ||
| ], | ||
| excluded: [~r"/_build/", ~r"/deps/", ~r"/node_modules/"] | ||
| }, | ||
| # | ||
| # Load and configure plugins here: | ||
| # | ||
| plugins: [], | ||
| # | ||
| # If you create your own checks, you must specify the source files for | ||
| # them here, so they can be loaded by Credo before running the analysis. | ||
| # | ||
| requires: [], | ||
| # | ||
| # If you want to enforce a style guide and need a more traditional linting | ||
| # experience, you can change `strict` to `true` below: | ||
| # | ||
| strict: false, | ||
| # | ||
| # To modify the timeout for parsing files, change this value: | ||
| # | ||
| parse_timeout: 5000, | ||
| # | ||
| # If you want to use uncolored output by default, you can change `color` | ||
| # to `false` below: | ||
| # | ||
| color: true, | ||
| # | ||
| # You can customize the parameters of any check by adding a second element | ||
| # to the tuple. | ||
| # | ||
| # To disable a check put `false` as second element: | ||
| # | ||
| # {Credo.Check.Design.DuplicatedCode, false} | ||
| # | ||
| checks: %{ | ||
| enabled: [ | ||
| # | ||
| ## Consistency Checks | ||
| # | ||
| {Credo.Check.Consistency.ExceptionNames, []}, | ||
| {Credo.Check.Consistency.LineEndings, []}, | ||
| {Credo.Check.Consistency.ParameterPatternMatching, []}, | ||
| {Credo.Check.Consistency.SpaceAroundOperators, []}, | ||
| {Credo.Check.Consistency.SpaceInParentheses, []}, | ||
| {Credo.Check.Consistency.TabsOrSpaces, []}, | ||
|
|
||
| # | ||
| ## Design Checks | ||
| # | ||
| # You can customize the priority of any check | ||
| # Priority values are: `low, normal, high, higher` | ||
| # | ||
| {Credo.Check.Design.AliasUsage, | ||
| [priority: :low, if_nested_deeper_than: 2, if_called_more_often_than: 0]}, | ||
| {Credo.Check.Design.TagFIXME, []}, | ||
| # You can also customize the exit_status of each check. | ||
| # If you don't want TODO comments to cause `mix credo` to fail, just | ||
| # set this value to 0 (zero). | ||
| # | ||
| {Credo.Check.Design.TagTODO, [exit_status: 2]}, | ||
|
|
||
| # | ||
| ## Readability Checks | ||
| # | ||
| {Credo.Check.Readability.AliasOrder, []}, | ||
| {Credo.Check.Readability.FunctionNames, []}, | ||
| {Credo.Check.Readability.LargeNumbers, []}, | ||
| {Credo.Check.Readability.MaxLineLength, [priority: :low, max_length: 120]}, | ||
| {Credo.Check.Readability.ModuleAttributeNames, []}, | ||
| {Credo.Check.Readability.ModuleDoc, []}, | ||
| {Credo.Check.Readability.ModuleNames, []}, | ||
| {Credo.Check.Readability.ParenthesesInCondition, []}, | ||
| {Credo.Check.Readability.ParenthesesOnZeroArityDefs, []}, | ||
| {Credo.Check.Readability.PipeIntoAnonymousFunctions, []}, | ||
| {Credo.Check.Readability.PredicateFunctionNames, []}, | ||
| {Credo.Check.Readability.PreferImplicitTry, []}, | ||
| {Credo.Check.Readability.RedundantBlankLines, []}, | ||
| {Credo.Check.Readability.Semicolons, []}, | ||
| {Credo.Check.Readability.SpaceAfterCommas, []}, | ||
| {Credo.Check.Readability.StringSigils, []}, | ||
| {Credo.Check.Readability.TrailingBlankLine, []}, | ||
| {Credo.Check.Readability.TrailingWhiteSpace, []}, | ||
| {Credo.Check.Readability.UnnecessaryAliasExpansion, []}, | ||
| {Credo.Check.Readability.VariableNames, []}, | ||
| {Credo.Check.Readability.WithSingleClause, []}, | ||
|
|
||
| # | ||
| ## Refactoring Opportunities | ||
| # | ||
| {Credo.Check.Refactor.Apply, []}, | ||
| {Credo.Check.Refactor.CondStatements, []}, | ||
| {Credo.Check.Refactor.CyclomaticComplexity, []}, | ||
| {Credo.Check.Refactor.FilterCount, []}, | ||
| {Credo.Check.Refactor.FilterFilter, []}, | ||
| {Credo.Check.Refactor.FunctionArity, []}, | ||
| {Credo.Check.Refactor.LongQuoteBlocks, []}, | ||
| {Credo.Check.Refactor.MapJoin, []}, | ||
| {Credo.Check.Refactor.MatchInCondition, []}, | ||
| {Credo.Check.Refactor.NegatedConditionsInUnless, []}, | ||
| {Credo.Check.Refactor.NegatedConditionsWithElse, []}, | ||
| {Credo.Check.Refactor.Nesting, []}, | ||
| {Credo.Check.Refactor.RedundantWithClauseResult, []}, | ||
| {Credo.Check.Refactor.RejectReject, []}, | ||
| {Credo.Check.Refactor.UnlessWithElse, []}, | ||
| {Credo.Check.Refactor.WithClauses, []}, | ||
|
|
||
| # | ||
| ## Warnings | ||
| # | ||
| {Credo.Check.Warning.ApplicationConfigInModuleAttribute, []}, | ||
| {Credo.Check.Warning.BoolOperationOnSameValues, []}, | ||
| {Credo.Check.Warning.Dbg, []}, | ||
| {Credo.Check.Warning.ExpensiveEmptyEnumCheck, []}, | ||
| {Credo.Check.Warning.IExPry, []}, | ||
| {Credo.Check.Warning.IoInspect, []}, | ||
| {Credo.Check.Warning.MissedMetadataKeyInLoggerConfig, []}, | ||
| {Credo.Check.Warning.OperationOnSameValues, []}, | ||
| {Credo.Check.Warning.OperationWithConstantResult, []}, | ||
| {Credo.Check.Warning.RaiseInsideRescue, []}, | ||
| {Credo.Check.Warning.SpecWithStruct, []}, | ||
| {Credo.Check.Warning.UnsafeExec, []}, | ||
| {Credo.Check.Warning.UnusedEnumOperation, []}, | ||
| {Credo.Check.Warning.UnusedFileOperation, []}, | ||
| {Credo.Check.Warning.UnusedKeywordOperation, []}, | ||
| {Credo.Check.Warning.UnusedListOperation, []}, | ||
| {Credo.Check.Warning.UnusedPathOperation, []}, | ||
| {Credo.Check.Warning.UnusedRegexOperation, []}, | ||
| {Credo.Check.Warning.UnusedStringOperation, []}, | ||
| {Credo.Check.Warning.UnusedTupleOperation, []}, | ||
| {Credo.Check.Warning.WrongTestFileExtension, []} | ||
| ], | ||
| disabled: [ | ||
| # | ||
| # Checks scheduled for next check update (opt-in for now) | ||
| {Credo.Check.Refactor.UtcNowTruncate, []}, | ||
|
|
||
| # | ||
| # Controversial and experimental checks (opt-in, just move the check to `:enabled` | ||
| # and be sure to use `mix credo --strict` to see low priority checks) | ||
| # | ||
| {Credo.Check.Consistency.MultiAliasImportRequireUse, []}, | ||
| {Credo.Check.Consistency.UnusedVariableNames, []}, | ||
| {Credo.Check.Design.DuplicatedCode, []}, | ||
| {Credo.Check.Design.SkipTestWithoutComment, []}, | ||
| {Credo.Check.Readability.AliasAs, []}, | ||
| {Credo.Check.Readability.BlockPipe, []}, | ||
| {Credo.Check.Readability.ImplTrue, []}, | ||
| {Credo.Check.Readability.MultiAlias, []}, | ||
| {Credo.Check.Readability.NestedFunctionCalls, []}, | ||
| {Credo.Check.Readability.OneArityFunctionInPipe, []}, | ||
| {Credo.Check.Readability.OnePipePerLine, []}, | ||
| {Credo.Check.Readability.SeparateAliasRequire, []}, | ||
| {Credo.Check.Readability.SingleFunctionToBlockPipe, []}, | ||
| {Credo.Check.Readability.SinglePipe, []}, | ||
| {Credo.Check.Readability.Specs, []}, | ||
| {Credo.Check.Readability.StrictModuleLayout, []}, | ||
| {Credo.Check.Readability.WithCustomTaggedTuple, []}, | ||
| {Credo.Check.Refactor.ABCSize, []}, | ||
| {Credo.Check.Refactor.AppendSingleItem, []}, | ||
| {Credo.Check.Refactor.DoubleBooleanNegation, []}, | ||
| {Credo.Check.Refactor.FilterReject, []}, | ||
| {Credo.Check.Refactor.IoPuts, []}, | ||
| {Credo.Check.Refactor.MapMap, []}, | ||
| {Credo.Check.Refactor.ModuleDependencies, []}, | ||
| {Credo.Check.Refactor.NegatedIsNil, []}, | ||
| {Credo.Check.Refactor.PassAsyncInTestCases, []}, | ||
| {Credo.Check.Refactor.PipeChainStart, []}, | ||
| {Credo.Check.Refactor.RejectFilter, []}, | ||
| {Credo.Check.Refactor.VariableRebinding, []}, | ||
| {Credo.Check.Warning.LazyLogging, []}, | ||
| {Credo.Check.Warning.LeakyEnvironment, []}, | ||
| {Credo.Check.Warning.MapGetUnsafePass, []}, | ||
| {Credo.Check.Warning.MixEnv, []}, | ||
| {Credo.Check.Warning.UnsafeToAtom, []} | ||
|
|
||
| # {Credo.Check.Refactor.MapInto, []}, | ||
|
|
||
| # | ||
| # Custom checks can be created using `mix credo.gen.check`. | ||
| # | ||
| ] | ||
| } | ||
| } | ||
| ] | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,118 @@ | ||
| name: Code Quality | ||
|
|
||
| on: [push, pull_request] | ||
|
|
||
| concurrency: | ||
| group: ${{ github.workflow }}-${{ github.head_ref }} | ||
| cancel-in-progress: true | ||
|
|
||
| env: | ||
| MIX_ENV: test | ||
| LANG: C.UTF-8 | ||
|
|
||
| jobs: | ||
| build: | ||
| name: Install and Compile Dependencies | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Checkout | ||
| uses: actions/checkout@v4 | ||
|
|
||
| - name: Install compile dependencies | ||
| run: sudo apt-get update -y && sudo apt-get install -y build-essential git | ||
|
|
||
| - name: Restore cache | ||
| uses: actions/cache@v3 | ||
| id: mix-cache | ||
| with: | ||
| path: | | ||
| deps | ||
| _build | ||
| key: ${{ runner.os }}-mix-${{ hashFiles('**/mix.lock') }}-${{ hashFiles('.tool-versions') }} | ||
|
|
||
| - name: Set up Elixir | ||
| uses: erlef/setup-beam@v1 | ||
| with: | ||
| version-file: .tool-versions | ||
| version-type: strict | ||
|
|
||
| - name: Clean dependencies | ||
| if: steps.mix-cache.outputs.cache-hit != 'true' | ||
| run: mix deps.clean --all | ||
|
|
||
| - name: Install dependencies | ||
| if: steps.mix-cache.outputs.cache-hit != 'true' | ||
| run: | | ||
| mix local.hex --force | ||
| mix local.rebar --force | ||
| mix deps.get | ||
| - name: Compile dependencies | ||
| if: steps.mix-cache.outputs.cache-hit != 'true' | ||
| run: mix deps.compile | ||
|
|
||
| static_code_analysis: | ||
| name: Static Code Analysis | ||
| runs-on: ubuntu-latest | ||
| needs: build | ||
| steps: | ||
| - name: Checkout | ||
| uses: actions/checkout@v4 | ||
|
|
||
| - name: Restore dependencies cache | ||
| uses: actions/cache@v3 | ||
| id: mix-cache | ||
| with: | ||
| path: | | ||
| deps | ||
| _build | ||
| key: ${{ runner.os }}-mix-${{ hashFiles('**/mix.lock') }}-${{ hashFiles('.tool-versions') }} | ||
|
|
||
| - name: Set up Elixir | ||
| uses: erlef/setup-beam@v1 | ||
| with: | ||
| version-file: .tool-versions | ||
| version-type: strict | ||
|
|
||
| - name: Run Lint and Credo | ||
| run: | | ||
| mix deps.unlock --check-unused | ||
| mix format --check-formatted | ||
| mix credo --strict | ||
| - name: Restore Dialyzer Cache | ||
| uses: actions/cache@v3 | ||
| id: mix-cache-dialyzer | ||
| with: | ||
| path: | | ||
| priv/plts | ||
| key: ${{ runner.os }}-v1-plt-cache-${{ hashFiles('**/mix.lock') }}-${{ hashFiles('.tool-versions') }} | ||
|
|
||
| - name: Run Dialyzer | ||
| run: mix dialyzer --format github | ||
|
|
||
| test: | ||
| name: Run Unit Tests | ||
| runs-on: ubuntu-latest | ||
| needs: build | ||
| steps: | ||
| - name: Checkout | ||
| uses: actions/checkout@v4 | ||
|
|
||
| - name: Restore dependencies cache | ||
| uses: actions/cache@v3 | ||
| id: mix-cache | ||
| with: | ||
| path: | | ||
| deps | ||
| _build | ||
| key: ${{ runner.os }}-mix-${{ hashFiles('**/mix.lock') }}-${{ hashFiles('.tool-versions') }} | ||
|
|
||
| - name: Set up Elixir | ||
| uses: erlef/setup-beam@v1 | ||
| with: | ||
| version-file: .tool-versions | ||
| version-type: strict | ||
|
|
||
| - name: Run Unit Tests | ||
| run: mix test --warnings-as-errors |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -24,3 +24,6 @@ kube_probex-*.tar | |
|
|
||
| # Temporary files, for example, from tests. | ||
| /tmp/ | ||
|
|
||
| # Ignore Dialyzer PLTs | ||
| /priv/plts/ | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters