vigiles API reference
    Preparing search index...

    Function enforce

    • Declare a rule enforced by an external tool or vigiles itself.

      When generated types are present, the linterRule argument is narrowed to only accept rules that exist in your linter configs. Vigiles-internal checks use the vigiles/<assertion-id> namespace and are dispatched to built-in mechanical validators (e.g. vigiles/orphan-docs).

      enforce("eslint/no-console", "Use structured logger.") enforce("@typescript-eslint/no-floating-promises", "Always await.") enforce("ruff/T201", "Use logging module.") enforce("vigiles/orphan-docs", "No docs without spec references.")

      Parameters

      • ref: LinterRule | `vigiles/${string}`
      • why: string
      • Optionaloptions: { verify?: boolean }

      Returns EnforceRule