Current section

Files

Jump to
nldoc_validation lib nldoc validation rules empty_definition_details.ex
Raw

lib/nldoc/validation/rules/empty_definition_details.ex

defmodule NLdoc.Validation.Rules.EmptyDefinitionDetails do
@moduledoc """
This rule validates that definition details must always contain visible text.
"""
alias NLdoc.Spec.DefinitionDetails
alias NLdoc.Validation.Content
alias NLdoc.Validation.Severity
use NLdoc.Validation.Rule,
severity: Severity.error(),
rule: "empty-definition-details",
ruleset: "https://validation.spec.nldoc.nl/",
# @TODO set `ruleset_version` to a real version
ruleset_version: "unknown",
validates: [DefinitionDetails]
@impl true
def valid?(resource = %DefinitionDetails{}, _),
do: resource |> Content.visible_text?()
end