Skip to main contentModule types
Source - Clause
- The core IR type — a single testable clause.
- ClauseId
- Stable identifier for a clause, derived from section path + clause text.
e.g.
auth::login::must_return_jwt - Metadata
- Frontmatter metadata from the top of a spec file.
- ParseError
- An error encountered during parsing.
- Section
- A section within a spec (maps to markdown headings).
- SourceLocation
- Location of a clause in a source file.
- Spec
- A parsed
.ought.md spec file. - SpecRef
- A reference to another spec file (from
requires: or inline links).
- Keyword
- Deontic keyword — the operator on a clause.
- Severity
- Severity level derived from the keyword.
- Temporal
- Temporal qualifier for MUST ALWAYS and MUST BY clauses.