defmodule NLdoc.Validation.Rules.EmptyDefinitionDetails do
  @moduledoc """
  This rule validates that definition details must always contain discernible text.
  """

  alias NLdoc.Spec.{Content, DefinitionDetails}
  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.discernible_text?()
end