Nerves.System.Linter.Rule.Callbacks (nerves_system_linter v0.4.1)

The language for defining a rule.

Summary

Types

arg()

Argument to a check.

args()

List or arguments.

check()

The name of the check to aply.

message()

Human readable message for a check.

message_arg()

Replace the message for a check.

warning_arg()

If a check evaluates false, it should be a warning instead of error.

Functions

ensure_bool(config_name, bool \\ true, opts \\ [])

Ensures a boolean value.

ensure_package(package_name, opts \\ [])

Ensures a package is enabled.

ensure_value(config_name, value, opts \\ [])

Ensures a value.

ensure_value_match(config_name, pattern, opts \\ [])
evaluate()

Registers this rule to be evaluated.

Types

arg()

@type arg() :: message_arg() | warning_arg()

Argument to a check.

args()

@type args() :: [arg()]

List or arguments.

check()

@type check() :: :ensure_package | :ensure_bool | :ensure_value

The name of the check to aply.

message()

@type message() :: String.t()

Human readable message for a check.

message_arg()

@type message_arg() :: {:message, message()}

Replace the message for a check.

warning_arg()

@type warning_arg() :: {:warn, boolean()}

If a check evaluates false, it should be a warning instead of error.

Functions

ensure_bool(config_name, bool \\ true, opts \\ [])

(macro)

Ensures a boolean value.

ensure_package(package_name, opts \\ [])

(macro) 
@spec ensure_package(Nerves.System.Defconfig.config_name(), args()) :: Macro.t()

Ensures a package is enabled.

ensure_value(config_name, value, opts \\ [])

(macro)

Ensures a value.

ensure_value_match(config_name, pattern, opts \\ [])

(macro)

evaluate()

(macro)

Registers this rule to be evaluated.