Packages
credo
1.7.19
1.7.19
1.7.18
1.7.17
1.7.16
1.7.15
1.7.14
1.7.13
1.7.12
1.7.11
1.7.10
1.7.9
1.7.8
1.7.7
1.7.7-rc.0
1.7.6
1.7.5
1.7.4
1.7.3
1.7.2
1.7.2-rc.4
1.7.2-rc.3
1.7.2-rc.2
1.7.2-rc.1
1.7.2-rc.0
1.7.1
1.7.0
1.7.0-rc.2
1.7.0-rc.1
1.6.7
1.6.6
1.6.5
1.6.4
1.6.3
1.6.2
1.6.1
1.6.0
1.6.0-rc.1
1.6.0-rc.0
1.5.6
1.5.5
1.5.4
1.5.3
1.5.2
1.5.1
1.5.0
1.5.0-rc.5
1.5.0-rc.4
1.5.0-rc.3
1.5.0-rc.2
1.5.0-rc.1
1.4.1
1.4.0
1.4.0-rc.2
1.4.0-rc.1
1.3.2
1.3.1
1.3.0
1.3.0-rc3
1.3.0-rc2
1.3.0-rc1
1.2.3
1.2.2
1.2.1
1.2.0
1.2.0-rc4
1.2.0-rc3
1.2.0-rc2
1.2.0-rc1
1.1.5
1.1.4
1.1.3
1.1.2
1.1.1
1.1.0
1.1.0-rc3
1.1.0-rc2
1.1.0-rc1
1.0.5
1.0.4
1.0.3
1.0.2
1.0.1
1.0.1-rc1
1.0.0
1.0.0-rc1
0.10.2
0.10.1
0.10.0
0.9.3
0.9.2
0.9.1
0.9.0
0.9.0-rc8
0.9.0-rc7
0.9.0-rc6
0.9.0-rc5
0.9.0-rc4
0.9.0-rc3
0.9.0-rc2
0.9.0-rc1
0.8.10
0.8.9
0.8.8
0.8.7
0.8.6
0.8.5
0.8.4
0.8.3
0.8.2
0.8.1
0.8.0
0.8.0-rc7
0.8.0-rc6
0.8.0-rc5
0.8.0-rc4
0.8.0-rc3
0.8.0-rc2
0.8.0-rc1
0.7.4
0.7.3
0.7.2
0.7.1
0.7.0
0.6.1
0.6.0
0.6.0-rc2
0.6.0-rc1
0.5.3
0.5.2
0.5.1
0.5.0
0.4.14
0.4.13
0.4.12
0.4.11
0.4.10
0.4.10-dev
0.4.9
0.4.8
0.4.7
0.4.6
0.4.5
0.4.4
0.4.3
0.4.2
0.4.1
0.4.0
0.4.0-beta5
0.4.0-beta4
0.4.0-beta3
0.4.0-beta2
0.4.0-beta1
0.3.13
0.3.12
0.3.11
0.3.10
0.3.9
0.3.8
0.3.7
0.3.6
0.3.5
0.3.4
0.3.3
0.3.2
0.3.1
0.3.0
0.3.0-dev2
0.3.0-dev
0.2.6
0.2.5
0.2.4
0.2.3
0.2.2
0.2.1
0.2.0
0.1.10
0.1.9
0.1.8
0.1.7
0.1.6
0.1.5
0.1.4
0.1.3
0.1.2
0.1.1
0.1.0
0.0.1-dev
A static code analysis tool with a focus on code consistency and teaching.
Current section
Files
Jump to
Current section
Files
lib/credo/check/params.ex
defmodule Credo.Check.Params do
@moduledoc """
This module provides functions for handling parameters ("params") given to
checks through `.credo.exs` (i.e. the `Credo.ConfigFile`).
"""
@doc """
Returns the given `field`'s `params` value.
Example:
defmodule SamepleCheck do
def param_defaults do
[foo: "bar"]
end
end
iex> Credo.Check.Params.get([], :foo, SamepleCheck)
"bar"
iex> Credo.Check.Params.get([foo: "baz"], :foo, SamepleCheck)
"baz"
"""
def get(params, field, check_mod)
# this one is deprecated
def get(params, field, keywords) when is_list(keywords) do
case params[field] do
nil ->
keywords[field]
val ->
val
end
end
def get(params, field, check_mod) do
case params[field] do
nil ->
check_mod.param_defaults()[field]
val ->
val
end
end
@doc false
def get(params, check_mod) when is_atom(check_mod) do
Enum.reduce(
param_names(params, check_mod),
%{},
fn param_name, map ->
Map.put(map, param_name, get(params, param_name, check_mod))
end
)
end
@doc false
def param_names(params, check_mod) do
all_known_params =
List.wrap(check_mod.explanations()[:params]) ++
List.wrap(check_mod.param_defaults()) ++
List.wrap(params)
all_known_params
|> Keyword.keys()
|> Enum.uniq()
end
@doc false
def get_rerun_files_that_changed(params) do
List.wrap(params[:__rerun_files_that_changed__])
end
@doc false
def put_rerun_files_that_changed(params, files_that_changed) do
Keyword.put(params, :__rerun_files_that_changed__, files_that_changed)
end
@doc false
def builtin_param_names do
[
:category,
:__category__,
:exit_status,
:__exit_status__,
:files,
:__files__,
:priority,
:__priority__,
:tags,
:__tags__
]
end
@doc false
def category(params, check_mod) do
params[:__category__] || params[:category] || check_mod.category()
end
@doc false
def exit_status(params, check_mod) do
params[:__exit_status__] || params[:exit_status] || check_mod.exit_status()
end
@doc false
def files_excluded(params, check_mod) do
files = get(params, :__files__, check_mod) || get(params, :files, check_mod)
List.wrap(files[:excluded])
end
@doc false
def files_included(params, check_mod, known_files) do
files = get(params, :__files__, check_mod) || get(params, :files, check_mod)
case files[:included] do
nil -> known_files
included -> included
end
end
@doc false
def priority(params, check_mod) do
params[:__priority__] || params[:priority] || check_mod.base_priority()
end
@doc false
def tags(params, check_mod) do
params[:__tags__] || params[:tags] || check_mod.tags()
end
end