nerves_system_linter v0.4.0 Nerves.System.Linter.Rule.Callbacks
The language for defining a rule
.
Link to this section Summary
Types
Argument to a check.
List or arguments.
The name of the check to aply.
Human readable message for a check.
Replace the message for a check.
If a check evaluates false, it should be a warning instead of error.
Functions
Ensures a boolean value.
Ensures a package is enabled.
Ensures a value.
Registers this rule to be evaluated.
Link to this section Types
Link to this type
arg()
Specs
arg() :: message_arg() | warning_arg()
Argument to a check.
Link to this type
args()
Specs
args() :: [arg()]
List or arguments.
Link to this type
check()
Specs
check() :: :ensure_package | :ensure_bool | :ensure_value
The name of the check to aply.
Link to this type
message()
Specs
message() :: String.t()
Human readable message for a check.
Link to this type
message_arg()
Specs
message_arg() :: {:message, message()}
Replace the message for a check.
Link to this type
warning_arg()
Specs
warning_arg() :: {:warn, boolean()}
If a check evaluates false, it should be a warning instead of error.
Link to this section Functions
Ensures a boolean value.
Specs
ensure_package(Nerves.System.Defconfig.config_name(), args()) :: Macro.t()
Ensures a package is enabled.
Ensures a value.
Registers this rule to be evaluated.