Help us shape the future of Go! Take the 2026 Go Developer Survey

reqlint

package
v0.5.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 30, 2026 License: MIT Imports: 7 Imported by: 0

Documentation

Overview

ENGMODEL-OWNER-UNIT: FU-VALIDATION-ENGINE

ENGMODEL-OWNER-UNIT: FU-VALIDATION-ENGINE

ENGMODEL-OWNER-UNIT: FU-VALIDATION-ENGINE

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func LintModelRequirementsEARS

func LintModelRequirementsEARS(bundle model.Bundle, requirements model.RequirementsDocument) []validate.Diagnostic

LintModelRequirementsEARS lints requirements against the bundle's catalog and reports catalog.term_unreferenced only for terms the model uses nowhere: a term whose id the architecture, behavior, assurance, compliance, views, decisions or design documents reference, or whose name appears in any authored model text other than its own entry, is in use even when no requirement text names it. ENGMODEL-LINKS: FU-VALIDATION-ENGINE, CTRL-TRACEABILITY-COVERAGE, STATE-MODEL-VALID, STATE-MODEL-INVALID, EVT-VALIDATION-FAILED TRLC-LINKS: REQ-EMG-001, REQ-EMG-009

func LintRequirementInternalLinks(reqs model.RequirementsDocument) []validate.Diagnostic

LintRequirementInternalLinks warns when a requirement links to another requirement within the same document. Requirements carry no tiers; a requirement is either delegated to a subsystem (declared by a downward composition allocation) or implemented here. Linking requirements to one another inside a single document recreates tier coupling and is confusing across system boundaries, so it is flagged. TRLC-LINKS: REQ-EMG-023 ENGMODEL-LINKS: FU-VALIDATION-ENGINE, FU-ALLOCATION-TRACE, CTRL-TRACEABILITY-COVERAGE

func SuppressWaivedDiagnostics

func SuppressWaivedDiagnostics(diags []validate.Diagnostic, waivers map[string][]string) []validate.Diagnostic

SuppressWaivedDiagnostics removes requirement-scoped diagnostics a model has explicitly waived. waivers maps a requirement id to the diagnostic codes waived for it (for example "lint.multiple_responses"). Only warnings are suppressed: an error is never waived. Diagnostics whose path is not a requirement path are kept. ENGMODEL-LINKS: FU-VALIDATION-ENGINE, CTRL-TRACEABILITY-COVERAGE, STATE-MODEL-VALID, STATE-MODEL-INVALID TRLC-LINKS: REQ-EMG-001, REQ-EMG-009

func ValidateCatalogDescriptions

func ValidateCatalogDescriptions(doc model.CatalogDocument) []validate.Diagnostic

ENGMODEL-LINKS: FU-VALIDATION-ENGINE, CTRL-TRACEABILITY-COVERAGE, STATE-MODEL-VALID, STATE-MODEL-INVALID, EVT-VALIDATION-FAILED TRLC-LINKS: REQ-EMG-001, REQ-EMG-009

Types

This section is empty.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL