Settings.Validation (fnord v0.9.29)

Reads and normalizes project-scoped validation settings.

Validation rules live under a project's validation key in settings.json. Each rule maps one or more project-relative path globs to a command string that should be executed when matching files change.

Summary

Types

rule()

Functions

add_rule(command, path_globs)

Adds a normalized validation rule to the currently selected project so the active project's validation command set includes another file-matching rule.

add_rule(project_name, command, path_globs)

Adds a normalized validation rule to the named project as part of managing the project's persisted validation rule set.

clear()

Clears all validation rules for the currently selected project, resetting the active project's validation rule set.

clear(project_name)

Clears all validation rules for the named project by replacing its persisted validation rules with an empty list.

configured?()

Returns true when the current project has at least one valid validation rule.

configured?(project_name)

Returns true when the named project has at least one valid validation rule.

list()

Returns the normalized validation rules for the currently selected project.

list(project_name)

Returns the normalized validation rules for the named project.

remove_rule(index)

Removes the validation rule at the given 1-based index from the currently selected project so the active project's validation rule set no longer includes that entry.

remove_rule(project_name, index)

Removes the validation rule at the given 1-based index from the named project as part of maintaining its persisted validation rules.

Types

rule()

@type rule() :: %{path_globs: [String.t()], command: String.t()}

Functions

add_rule(command, path_globs)

@spec add_rule(String.t(), String.t() | [String.t()]) ::
  {:ok, [rule()]} | {:error, :invalid_rule | :project_not_set}

Adds a normalized validation rule to the currently selected project so the active project's validation command set includes another file-matching rule.

add_rule(project_name, command, path_globs)

@spec add_rule(String.t(), String.t(), String.t() | [String.t()]) ::
  {:ok, [rule()]} | {:error, :invalid_rule | :project_not_found}

Adds a normalized validation rule to the named project as part of managing the project's persisted validation rule set.

clear()

@spec clear() :: :ok | {:error, :project_not_found}

Clears all validation rules for the currently selected project, resetting the active project's validation rule set.

clear(project_name)

@spec clear(String.t()) :: :ok | {:error, :project_not_found}

Clears all validation rules for the named project by replacing its persisted validation rules with an empty list.

configured?()

@spec configured?() :: boolean()

Returns true when the current project has at least one valid validation rule.

configured?(project_name)

@spec configured?(String.t()) :: boolean()

Returns true when the named project has at least one valid validation rule.

list()

@spec list() :: [rule()]

Returns the normalized validation rules for the currently selected project.

list(project_name)

@spec list(String.t()) :: [rule()]

Returns the normalized validation rules for the named project.

remove_rule(index)

@spec remove_rule(integer()) ::
  {:ok, [rule()]}
  | {:error, :invalid_index | :project_not_set | :project_not_found}

Removes the validation rule at the given 1-based index from the currently selected project so the active project's validation rule set no longer includes that entry.

remove_rule(project_name, index)

@spec remove_rule(String.t(), integer()) ::
  {:ok, [rule()]} | {:error, :invalid_index | :project_not_found}

Removes the validation rule at the given 1-based index from the named project as part of maintaining its persisted validation rules.