Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
09516a4
commit 674a136
Showing
10 changed files
with
221 additions
and
14 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,154 @@ | ||
| # 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 exec using `mix credo -C <name>`. If no exec 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/"], | ||
| excluded: [~r"/_build/", ~r"/deps/", ~r"/node_modules/"] | ||
| }, | ||
| # | ||
| # 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, | ||
| # | ||
| # 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: [ | ||
| # | ||
| ## 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]}, | ||
| # 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]}, | ||
| {Credo.Check.Design.TagFIXME, []}, | ||
|
|
||
| # | ||
| ## 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.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.VariableNames, []}, | ||
|
|
||
| # | ||
| ## Refactoring Opportunities | ||
| # | ||
| {Credo.Check.Refactor.CondStatements, []}, | ||
| {Credo.Check.Refactor.CyclomaticComplexity, []}, | ||
| {Credo.Check.Refactor.FunctionArity, []}, | ||
| {Credo.Check.Refactor.LongQuoteBlocks, []}, | ||
| {Credo.Check.Refactor.MapInto, []}, | ||
| {Credo.Check.Refactor.MatchInCondition, []}, | ||
| {Credo.Check.Refactor.NegatedConditionsInUnless, []}, | ||
| {Credo.Check.Refactor.NegatedConditionsWithElse, []}, | ||
| {Credo.Check.Refactor.Nesting, []}, | ||
| {Credo.Check.Refactor.PipeChainStart, | ||
| [excluded_argument_types: [:atom, :binary, :fn, :keyword], excluded_functions: []]}, | ||
| {Credo.Check.Refactor.UnlessWithElse, []}, | ||
|
|
||
| # | ||
| ## Warnings | ||
| # | ||
| {Credo.Check.Warning.BoolOperationOnSameValues, []}, | ||
| {Credo.Check.Warning.ExpensiveEmptyEnumCheck, []}, | ||
| {Credo.Check.Warning.IExPry, []}, | ||
| {Credo.Check.Warning.IoInspect, []}, | ||
| {Credo.Check.Warning.LazyLogging, []}, | ||
| {Credo.Check.Warning.OperationOnSameValues, []}, | ||
| {Credo.Check.Warning.OperationWithConstantResult, []}, | ||
| {Credo.Check.Warning.RaiseInsideRescue, []}, | ||
| {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, []}, | ||
|
|
||
| # | ||
| # Controversial and experimental checks (opt-in, just remove `, false`) | ||
| # | ||
| {Credo.Check.Consistency.MultiAliasImportRequireUse, false}, | ||
| {Credo.Check.Design.DuplicatedCode, false}, | ||
| {Credo.Check.Readability.Specs}, | ||
| {Credo.Check.Refactor.ABCSize, false}, | ||
| {Credo.Check.Refactor.AppendSingleItem, false}, | ||
| {Credo.Check.Refactor.DoubleBooleanNegation, false}, | ||
| {Credo.Check.Refactor.VariableRebinding, false}, | ||
| {Credo.Check.Warning.MapGetUnsafePass, false}, | ||
| {Credo.Check.Warning.UnsafeToAtom, false} | ||
|
|
||
| # | ||
| # 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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,46 @@ | ||
| defmodule Bonny.Naming do | ||
| @moduledoc """ | ||
| Naming functions | ||
| """ | ||
|
|
||
| @doc """ | ||
| Converts an elixir module name to a string for use as the CRD's `kind`. | ||
| ## Examples | ||
| iex> Bonny.Naming.module_to_kind(Pod) | ||
| "Pod" | ||
| iex> Bonny.Naming.module_to_kind(Controllers.V1.Pod) | ||
| "Pod" | ||
| """ | ||
| @spec module_to_kind(atom) :: String.t() | ||
| def module_to_kind(mod) do | ||
| mod | ||
| |> Macro.to_string() | ||
| |> String.split(".") | ||
| |> Enum.reverse() | ||
| |> Enum.at(0) | ||
| end | ||
|
|
||
| @doc """ | ||
| Extract the CRD API version from the module name. Defaults to `"v1"` | ||
| ## Examples | ||
| iex> Bonny.Naming.module_version(Pod) | ||
| "v1" | ||
| iex> Bonny.Naming.module_version(Controllers.V1.Pod) | ||
| "v1" | ||
| iex> Bonny.Naming.module_version(Controllers.V1Alpha1.Pod) | ||
| "v1alpha1" | ||
| """ | ||
| def module_version(mod) do | ||
| mod | ||
| |> Macro.to_string() | ||
| |> String.split(".") | ||
| |> Enum.reverse() | ||
| |> Enum.at(1, "v1") | ||
| |> String.downcase() | ||
| end | ||
| end |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| defmodule Bonny.NamingTest do | ||
| @moduledoc false | ||
| use ExUnit.Case, async: true | ||
| doctest Bonny.Naming | ||
| end |
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 |
|---|---|---|
| @@ -1,3 +1,4 @@ | ||
| # credo:disable-for-this-file | ||
| defmodule Cog do | ||
| @moduledoc false | ||
| use Bonny.Controller | ||
|
|
||
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 |
|---|---|---|
| @@ -1,3 +1,4 @@ | ||
| # credo:disable-for-this-file | ||
| defmodule Bonny.K8sMockClient do | ||
| @moduledoc """ | ||
| Mock `K8s.Client` | ||
|
|
||
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 |
|---|---|---|
| @@ -1,3 +1,4 @@ | ||
| # credo:disable-for-this-file | ||
| defmodule Whizbang do | ||
| @moduledoc false | ||
| use Bonny.Controller | ||
|
|
||
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 |
|---|---|---|
| @@ -1,3 +1,4 @@ | ||
| # credo:disable-for-this-file | ||
| defmodule Widget do | ||
| @moduledoc false | ||
| use Bonny.Controller | ||
|
|
||