diff --git a/.credo.exs b/.credo.exs
new file mode 100644
index 0000000..baa1ea2
--- /dev/null
+++ b/.credo.exs
@@ -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`.
+ #
+ ]
+ }
+ }
+ ]
+}
diff --git a/.sobelow-conf b/.sobelow-conf
new file mode 100644
index 0000000..7d8448c
--- /dev/null
+++ b/.sobelow-conf
@@ -0,0 +1,13 @@
+[
+ verbose: false,
+ private: false,
+ skip: false,
+ router: nil,
+ exit: false,
+ format: "txt",
+ out: nil,
+ threshold: :low,
+ ignore: [""],
+ ignore_files: [],
+ version: false,
+]
diff --git a/lib/type_id.ex b/lib/type_id.ex
index d3acb0d..ddb5b5a 100644
--- a/lib/type_id.ex
+++ b/lib/type_id.ex
@@ -154,7 +154,7 @@ defmodule TypeID do
end
@doc """
- Parses a `t:t/0` from a prefix and suffix.
+ Parses a `t:t/0` from a prefix and suffix.
### Example
@@ -282,12 +282,13 @@ defmodule TypeID do
end
end
+ @spec invalid_prefix!(String.t(), String.t()) :: no_return()
defp invalid_prefix!(prefix, message) do
raise ArgumentError, "invalid prefix: #{prefix}. #{message}"
end
defp validate_suffix!(suffix) do
- Base32.decode!(suffix)
+ _ = Base32.decode!(suffix)
:ok
end
diff --git a/lib/type_id/base_32.ex b/lib/type_id/base_32.ex
index 4c088e9..1f491c3 100644
--- a/lib/type_id/base_32.ex
+++ b/lib/type_id/base_32.ex
@@ -58,6 +58,7 @@ defmodule TypeID.Base32 do
defp do_decode(char), do: bad_character!(char)
+ @spec bad_character!(byte()) :: no_return()
defp bad_character!(byte) do
raise ArgumentError,
"non-alphabet character found: #{inspect(<<byte>>, binaries: :as_strings)} (byte #{byte})"
diff --git a/mix.exs b/mix.exs
index 3b95bfc..37d1f31 100644
--- a/mix.exs
+++ b/mix.exs
@@ -15,7 +15,10 @@ defmodule TypeID.MixProject do
name: "TypeID Elixir",
source_url: "https://github.com/sloanelybutsurely/typeid-elixir",
docs: docs(),
- consolidate_protocols: Mix.env() != :test
+ consolidate_protocols: Mix.env() != :test,
+ dialyzer: [
+ flags: [:no_opaque, :unmatched_returns, :error_handling, :unknown]
+ ]
]
end
@@ -48,7 +51,10 @@ defmodule TypeID.MixProject do
{:phoenix, "~> 1.7", optional: true},
{:jason, "~> 1.4", optional: true},
{:ex_doc, "~> 0.27", only: :dev, runtime: false},
- {:yaml_elixir, "~> 2.9", only: [:dev, :test], runtime: false}
+ {:yaml_elixir, "~> 2.9", only: [:dev, :test], runtime: false},
+ {:credo, "~> 1.7", only: [:dev, :test], runtime: false},
+ {:sobelow, "~> 0.13", only: [:dev, :test], runtime: false},
+ {:dialyxir, "~> 1.4", only: [:dev, :test], runtime: false}
]
end
end
diff --git a/mix.lock b/mix.lock
index e449106..1b0f7fd 100644
--- a/mix.lock
+++ b/mix.lock
@@ -1,9 +1,14 @@
%{
+ "bunt": {:hex, :bunt, "1.0.0", "081c2c665f086849e6d57900292b3a161727ab40431219529f13c4ddcf3e7a44", [:mix], [], "hexpm", "dc5f86aa08a5f6fa6b8096f0735c4e76d54ae5c9fa2c143e5a1fc7c1cd9bb6b5"},
"castore": {:hex, :castore, "1.0.3", "7130ba6d24c8424014194676d608cb989f62ef8039efd50ff4b3f33286d06db8", [:mix], [], "hexpm", "680ab01ef5d15b161ed6a95449fac5c6b8f60055677a8e79acf01b27baa4390b"},
+ "credo": {:hex, :credo, "1.7.11", "d3e805f7ddf6c9c854fd36f089649d7cf6ba74c42bc3795d587814e3c9847102", [:mix], [{:bunt, "~> 0.2.1 or ~> 1.0", [hex: :bunt, repo: "hexpm", optional: false]}, {:file_system, "~> 0.2 or ~> 1.0", [hex: :file_system, repo: "hexpm", optional: false]}, {:jason, "~> 1.0", [hex: :jason, repo: "hexpm", optional: false]}], "hexpm", "56826b4306843253a66e47ae45e98e7d284ee1f95d53d1612bb483f88a8cf219"},
"decimal": {:hex, :decimal, "2.1.1", "5611dca5d4b2c3dd497dec8f68751f1f1a54755e8ed2a966c2633cf885973ad6", [:mix], [], "hexpm", "53cfe5f497ed0e7771ae1a475575603d77425099ba5faef9394932b35020ffcc"},
+ "dialyxir": {:hex, :dialyxir, "1.4.5", "ca1571ac18e0f88d4ab245f0b60fa31ff1b12cbae2b11bd25d207f865e8ae78a", [:mix], [{:erlex, ">= 0.2.7", [hex: :erlex, repo: "hexpm", optional: false]}], "hexpm", "b0fb08bb8107c750db5c0b324fa2df5ceaa0f9307690ee3c1f6ba5b9eb5d35c3"},
"earmark_parser": {:hex, :earmark_parser, "1.4.32", "fa739a0ecfa34493de19426681b23f6814573faee95dfd4b4aafe15a7b5b32c6", [:mix], [], "hexpm", "b8b0dd77d60373e77a3d7e8afa598f325e49e8663a51bcc2b88ef41838cca755"},
"ecto": {:hex, :ecto, "3.10.2", "6b887160281a61aa16843e47735b8a266caa437f80588c3ab80a8a960e6abe37", [:mix], [{:decimal, "~> 1.6 or ~> 2.0", [hex: :decimal, repo: "hexpm", optional: false]}, {:jason, "~> 1.0", [hex: :jason, repo: "hexpm", optional: true]}, {:telemetry, "~> 0.4 or ~> 1.0", [hex: :telemetry, repo: "hexpm", optional: false]}], "hexpm", "6a895778f0d7648a4b34b486af59a1c8009041fbdf2b17f1ac215eb829c60235"},
+ "erlex": {:hex, :erlex, "0.2.7", "810e8725f96ab74d17aac676e748627a07bc87eb950d2b83acd29dc047a30595", [:mix], [], "hexpm", "3ed95f79d1a844c3f6bf0cea61e0d5612a42ce56da9c03f01df538685365efb0"},
"ex_doc": {:hex, :ex_doc, "0.29.4", "6257ecbb20c7396b1fe5accd55b7b0d23f44b6aa18017b415cb4c2b91d997729", [:mix], [{:earmark_parser, "~> 1.4.31", [hex: :earmark_parser, repo: "hexpm", optional: false]}, {:makeup_elixir, "~> 0.14", [hex: :makeup_elixir, repo: "hexpm", optional: false]}, {:makeup_erlang, "~> 0.1", [hex: :makeup_erlang, repo: "hexpm", optional: false]}], "hexpm", "2c6699a737ae46cb61e4ed012af931b57b699643b24dabe2400a8168414bc4f5"},
+ "file_system": {:hex, :file_system, "1.1.0", "08d232062284546c6c34426997dd7ef6ec9f8bbd090eb91780283c9016840e8f", [:mix], [], "hexpm", "bfcf81244f416871f2a2e15c1b515287faa5db9c6bcf290222206d120b3d43f6"},
"jason": {:hex, :jason, "1.4.1", "af1504e35f629ddcdd6addb3513c3853991f694921b1b9368b0bd32beb9f1b63", [:mix], [{:decimal, "~> 1.0 or ~> 2.0", [hex: :decimal, repo: "hexpm", optional: true]}], "hexpm", "fbb01ecdfd565b56261302f7e1fcc27c4fb8f32d56eab74db621fc154604a7a1"},
"makeup": {:hex, :makeup, "1.1.0", "6b67c8bc2882a6b6a445859952a602afc1a41c2e08379ca057c0f525366fc3ca", [:mix], [{:nimble_parsec, "~> 1.2.2 or ~> 1.3", [hex: :nimble_parsec, repo: "hexpm", optional: false]}], "hexpm", "0a45ed501f4a8897f580eabf99a2e5234ea3e75a4373c8a52824f6e873be57a6"},
"makeup_elixir": {:hex, :makeup_elixir, "0.16.1", "cc9e3ca312f1cfeccc572b37a09980287e243648108384b97ff2b76e505c3555", [:mix], [{:makeup, "~> 1.0", [hex: :makeup, repo: "hexpm", optional: false]}, {:nimble_parsec, "~> 1.2.3 or ~> 1.3", [hex: :nimble_parsec, repo: "hexpm", optional: false]}], "hexpm", "e127a341ad1b209bd80f7bd1620a15693a9908ed780c3b763bccf7d200c767c6"},
@@ -16,6 +21,7 @@
"phoenix_template": {:hex, :phoenix_template, "1.0.1", "85f79e3ad1b0180abb43f9725973e3b8c2c3354a87245f91431eec60553ed3ef", [:mix], [{:phoenix_html, "~> 2.14.2 or ~> 3.0", [hex: :phoenix_html, repo: "hexpm", optional: true]}], "hexpm", "157dc078f6226334c91cb32c1865bf3911686f8bcd6bcff86736f6253e6993ee"},
"plug": {:hex, :plug, "1.14.2", "cff7d4ec45b4ae176a227acd94a7ab536d9b37b942c8e8fa6dfc0fff98ff4d80", [:mix], [{:mime, "~> 1.0 or ~> 2.0", [hex: :mime, repo: "hexpm", optional: false]}, {:plug_crypto, "~> 1.1.1 or ~> 1.2", [hex: :plug_crypto, repo: "hexpm", optional: false]}, {:telemetry, "~> 0.4.3 or ~> 1.0", [hex: :telemetry, repo: "hexpm", optional: false]}], "hexpm", "842fc50187e13cf4ac3b253d47d9474ed6c296a8732752835ce4a86acdf68d13"},
"plug_crypto": {:hex, :plug_crypto, "1.2.5", "918772575e48e81e455818229bf719d4ab4181fcbf7f85b68a35620f78d89ced", [:mix], [], "hexpm", "26549a1d6345e2172eb1c233866756ae44a9609bd33ee6f99147ab3fd87fd842"},
+ "sobelow": {:hex, :sobelow, "0.13.0", "218afe9075904793f5c64b8837cc356e493d88fddde126a463839351870b8d1e", [:mix], [{:jason, "~> 1.0", [hex: :jason, repo: "hexpm", optional: false]}], "hexpm", "cd6e9026b85fc35d7529da14f95e85a078d9dd1907a9097b3ba6ac7ebbe34a0d"},
"telemetry": {:hex, :telemetry, "1.2.1", "68fdfe8d8f05a8428483a97d7aab2f268aaff24b49e0f599faa091f1d4e7f61c", [:rebar3], [], "hexpm", "dad9ce9d8effc621708f99eac538ef1cbe05d6a874dd741de2e689c47feafed5"},
"websock": {:hex, :websock, "0.5.2", "b3c08511d8d79ed2c2f589ff430bd1fe799bb389686dafce86d28801783d8351", [:mix], [], "hexpm", "925f5de22fca6813dfa980fb62fd542ec43a2d1a1f83d2caec907483fe66ff05"},
"websock_adapter": {:hex, :websock_adapter, "0.5.3", "4908718e42e4a548fc20e00e70848620a92f11f7a6add8cf0886c4232267498d", [:mix], [{:bandit, ">= 0.6.0", [hex: :bandit, repo: "hexpm", optional: true]}, {:plug, "~> 1.14", [hex: :plug, repo: "hexpm", optional: false]}, {:plug_cowboy, "~> 2.6", [hex: :plug_cowboy, repo: "hexpm", optional: true]}, {:websock, "~> 0.5", [hex: :websock, repo: "hexpm", optional: false]}], "hexpm", "cbe5b814c1f86b6ea002b52dd99f345aeecf1a1a6964e209d208fb404d930d3d"},