reqmd Package: model

Package: model

approved 41Leaf

41 requirements · 3 nested · 1 items

X Reqmd.source File
X Reqmd.source Line
X Reqmd.symbol Kind

This file is auto-generated by reqmd-code. Do not edit by hand.

IMP-model-AttrDisposition-acdff3a AttrDisposition

#

missing coverage

Built-in attribute keys used in requirement attr blocks. They areinjected into every schema by internal/schema.Compile and accessed bygraph checks and HTML export.

Details
X Reqmd.imported
true
X Reqmd.source File
internal/model/builtin.go
X Reqmd.source Line
11
X Reqmd.symbol Kind
const
Status
approved

IMP-model-AttrDispositionReason-f8355ee AttrDispositionReason

#

missing coverage

Built-in attribute keys used in requirement attr blocks. They areinjected into every schema by internal/schema.Compile and accessed bygraph checks and HTML export.

Details
X Reqmd.imported
true
X Reqmd.source File
internal/model/builtin.go
X Reqmd.source Line
11
X Reqmd.symbol Kind
const
Status
approved

IMP-model-AttrRequiresTraceFrom-261c85c AttrRequiresTraceFrom

#

missing coverage

Built-in attribute keys used in requirement attr blocks. They areinjected into every schema by internal/schema.Compile and accessed bygraph checks and HTML export.

Details
X Reqmd.imported
true
X Reqmd.source File
internal/model/builtin.go
X Reqmd.source Line
11
X Reqmd.symbol Kind
const
Status
approved

IMP-model-AttrStatus-0033655 AttrStatus

#

missing coverage

Built-in attribute keys used in requirement attr blocks. They areinjected into every schema by internal/schema.Compile and accessed bygraph checks and HTML export.

Details
X Reqmd.imported
true
X Reqmd.source File
internal/model/builtin.go
X Reqmd.source Line
11
X Reqmd.symbol Kind
const
Status
approved

IMP-model-AttrTrace-e4c0e28 AttrTrace

#

missing coverage

Built-in attribute keys used in requirement attr blocks. They areinjected into every schema by internal/schema.Compile and accessed bygraph checks and HTML export.

Details
X Reqmd.imported
true
X Reqmd.source File
internal/model/builtin.go
X Reqmd.source Line
11
X Reqmd.symbol Kind
const
Status
approved

IMP-model-AttrVerify-394826e AttrVerify

#

missing coverage

Built-in attribute keys used in requirement attr blocks. They areinjected into every schema by internal/schema.Compile and accessed bygraph checks and HTML export.

Details
X Reqmd.imported
true
X Reqmd.source File
internal/model/builtin.go
X Reqmd.source Line
11
X Reqmd.symbol Kind
const
Status
approved

IMP-model-AttrVersion-253d1dd AttrVersion

#

missing coverage

Built-in attribute keys used in requirement attr blocks. They areinjected into every schema by internal/schema.Compile and accessed bygraph checks and HTML export.

Details
X Reqmd.imported
true
X Reqmd.source File
internal/model/builtin.go
X Reqmd.source Line
11
X Reqmd.symbol Kind
const
Status
approved

IMP-model-AttrResultEvidence-cca1fcb AttrResultEvidence

#

missing coverage

Tool-owned attribute keys used on synthesized verification-resultpseudo-requirements (internal/verify). They are namespaced underx-reqmd.* — the same convention as reqmd-code's provenance attributes —so they can never collide with authored schema attributes.

Details
X Reqmd.imported
true
X Reqmd.source File
internal/model/builtin.go
X Reqmd.source Line
25
X Reqmd.symbol Kind
const
Status
approved

IMP-model-AttrResultOutcome-5a2e39e AttrResultOutcome

#

missing coverage

Tool-owned attribute keys used on synthesized verification-resultpseudo-requirements (internal/verify). They are namespaced underx-reqmd.* — the same convention as reqmd-code's provenance attributes —so they can never collide with authored schema attributes.

Details
X Reqmd.imported
true
X Reqmd.source File
internal/model/builtin.go
X Reqmd.source Line
25
X Reqmd.symbol Kind
const
Status
approved

IMP-model-AttrResultVerifiedAt-30b0e27 AttrResultVerifiedAt

#

missing coverage

Tool-owned attribute keys used on synthesized verification-resultpseudo-requirements (internal/verify). They are namespaced underx-reqmd.* — the same convention as reqmd-code's provenance attributes —so they can never collide with authored schema attributes.

Details
X Reqmd.imported
true
X Reqmd.source File
internal/model/builtin.go
X Reqmd.source Line
25
X Reqmd.symbol Kind
const
Status
approved

IMP-model-AttrResultVerifier-5a573d0 AttrResultVerifier

#

missing coverage

Tool-owned attribute keys used on synthesized verification-resultpseudo-requirements (internal/verify). They are namespaced underx-reqmd.* — the same convention as reqmd-code's provenance attributes —so they can never collide with authored schema attributes.

Details
X Reqmd.imported
true
X Reqmd.source File
internal/model/builtin.go
X Reqmd.source Line
25
X Reqmd.symbol Kind
const
Status
approved

IMP-model-StripPin-f9a274d StripPin

#

missing coverage

StripPin removes a trailing ~N version pin from a requirement ref.Returns the bare ref, the pin value, and true if a numeric pin waspresent. A ~ followed by a non-numeric suffix is NOT treated as apin (e.g. "UP-001abc" returns ("UP-001abc", 0, false)) — thismatches the graph layer's parsing and prevents mis-stripping refsthat contain ~ for other reasons.

This is the single source of truth for ~N stripping across thecodebase: graph (Pass 2 pin extraction), repin (newRefFrom, stripPinfor display), and verify (MergeLatest key normalization).

Details
X Reqmd.imported
true
X Reqmd.source File
internal/model/builtin.go
X Reqmd.source Line
42
X Reqmd.symbol Kind
function
Status
approved

IMP-model-StatusApproved-be78e3d StatusApproved

#

missing coverage

Built-in status enum values. The default (when no status attr isdeclared) is StatusApproved — see StatusDefault.

Details
X Reqmd.imported
true
X Reqmd.source File
internal/model/builtin.go
X Reqmd.source Line
58
X Reqmd.symbol Kind
const
Status
approved

IMP-model-StatusDraft-a123da1 StatusDraft

#

missing coverage

Built-in status enum values. The default (when no status attr isdeclared) is StatusApproved — see StatusDefault.

Details
X Reqmd.imported
true
X Reqmd.source File
internal/model/builtin.go
X Reqmd.source Line
58
X Reqmd.symbol Kind
const
Status
approved

IMP-model-StatusDefault-2219a8f StatusDefault

#

missing coverage

StatusDefault is the implicit status when none is declared on arequirement. The built-in status attribute is enum [draft, approved];approved is the coverage-providing value.

Details
X Reqmd.imported
true
X Reqmd.source File
internal/model/builtin.go
X Reqmd.source Line
66
X Reqmd.symbol Kind
const
Status
approved

IMP-model-TestStripPin-4488901 TestStripPin

#

missing coverage

Details
X Reqmd.imported
true
X Reqmd.source File
internal/model/builtin_test.go
X Reqmd.source Line
5
X Reqmd.symbol Kind
function
Status
approved

IMP-model-FormatScalar-41a318f FormatScalar

#

missing coverage

FormatScalar converts a primitive scalar value to its stringrepresentation. It handles the types that YAML decoding produces forattribute values: string, bool, int, int64, float64. Non-scalar types(slices, maps) return "" — callers should handle those withencoding/json or a domain-specific renderer.

This is the shared scalar formatter used by the exporter and reporterpackages to avoid duplicating the same type switch in four places.

Details
X Reqmd.imported
true
X Reqmd.source File
internal/model/format.go
X Reqmd.source Line
16
X Reqmd.symbol Kind
function
Status
approved

IMP-model-AttrString-ac410c6 AttrString

#

missing coverage

Attribute accessors. Attr values come from the YAML attr block and aretyped by the parser (string, bool, int, []any of those). These helpersare the single place that type-switches on them; every consumer (graphchecks, exporters, reporters) reads attrs through them instead ofreimplementing the same switch.AttrString returns the string value of attrs[key], or "" when the keyis absent or holds a non-string value.

Details
X Reqmd.imported
true
X Reqmd.source File
internal/model/format.go
X Reqmd.source Line
41
X Reqmd.symbol Kind
function
Status
approved

IMP-model-AttrStrings-b28638f AttrStrings

#

missing coverage

AttrStrings reads an array attr as []string. Returns nil when the key isabsent (so callers can tell "not set" from "explicitly empty") and[]string{} when the key is present but the array is empty. Non-stringitems are dropped.

Details
X Reqmd.imported
true
X Reqmd.source File
internal/model/format.go
X Reqmd.source Line
50
X Reqmd.symbol Kind
function
Status
approved

IMP-model-AttrList-6a7d22b AttrList

#

missing coverage

AttrList returns an array attr in its native []any form, converting a[]string. Returns nil when the key is absent or not an array.

Details
X Reqmd.imported
true
X Reqmd.source File
internal/model/format.go
X Reqmd.source Line
76
X Reqmd.symbol Kind
function
Status
approved

IMP-model-AttrInt-1b173ec AttrInt

#

missing coverage

AttrInt reads an integer attr, handling the types that appear inpractice: int and int64 (YAML decode) and float64 (JSON round-trip).Returns 0 when the key is absent or undecodable.

Details
X Reqmd.imported
true
X Reqmd.source File
internal/model/format.go
X Reqmd.source Line
93
X Reqmd.symbol Kind
function
Status
approved

IMP-model-FormatAttr-04da9dc FormatAttr

#

missing coverage

FormatAttr renders an attribute value for display: scalars throughFormatScalar, slices and maps as compact JSON. Unknown types render as"" so a table cell never shows Go syntax.

Details
X Reqmd.imported
true
X Reqmd.source File
internal/model/format.go
X Reqmd.source Line
108
X Reqmd.symbol Kind
function
Status
approved

IMP-model-Kind-382a382 Kind

#

Kind discriminates the node types in a document's content tree.

Details
X Reqmd.imported
true
X Reqmd.source File
internal/model/node.go
X Reqmd.source Line
7
X Reqmd.symbol Kind
type
Status
approved

IMP-model-String-0301365 String

#

String returns the lowercase display name used in text and JSON output.

Details
X Reqmd.imported
true
X Reqmd.source File
internal/model/node.go
X Reqmd.source Line
23
X Reqmd.symbol Kind
method
Status
approved

IMP-model-KindContainer-bf66281 KindContainer

#

missing coverage

Details
X Reqmd.imported
true
X Reqmd.source File
internal/model/node.go
X Reqmd.source Line
9
X Reqmd.symbol Kind
const
Status
approved

IMP-model-KindInfo-65558fa KindInfo

#

missing coverage

Details
X Reqmd.imported
true
X Reqmd.source File
internal/model/node.go
X Reqmd.source Line
9
X Reqmd.symbol Kind
const
Status
approved

IMP-model-KindRequirement-ace5645 KindRequirement

#

missing coverage

Details
X Reqmd.imported
true
X Reqmd.source File
internal/model/node.go
X Reqmd.source Line
9
X Reqmd.symbol Kind
const
Status
approved

IMP-model-Node-aaeb5ec Node

#

Node is a single content node in a parsed Markdown document. Everyheading becomes a node; a node is a requirement iff it has an adjacentattr block. Prose and other blocks attach to the nearest open heading'sBody. Nodes form a tree via Children, preserving document order.

Details
X Reqmd.imported
true
X Reqmd.source File
internal/model/node.go
X Reqmd.source Line
40
X Reqmd.symbol Kind
type
Status
approved

IMP-model-IsRequirement-4ca5fff IsRequirement

#

IsRequirement reports whether the node is a requirement (as opposed toa container or info item).

Details
X Reqmd.imported
true
X Reqmd.source File
internal/model/node.go
X Reqmd.source Line
56
X Reqmd.symbol Kind
method
Status
approved

IMP-model-XReqmd-25ba149 XReqmd

#

missing coverage

XReqmd holds reqmd-specific directory metadata from schema.yaml.All fields map directly to the x-reqmd extension block.

Details
X Reqmd.imported
true
X Reqmd.source File
internal/model/node.go
X Reqmd.source Line
62
X Reqmd.symbol Kind
type
Status
approved

IMP-model-TraceUpstream-c4a21d4 TraceUpstream

#

missing coverage

TraceUpstream declares the expected upstream layer and source directories.

Details
X Reqmd.imported
true
X Reqmd.source File
internal/model/node.go
X Reqmd.source Line
78
X Reqmd.symbol Kind
type
Status
approved

IMP-model-SourceConfig-1cf24c7 SourceConfig

#

missing coverage

SourceConfig describes where to find and how to parse the originating artefact.

Details
X Reqmd.imported
true
X Reqmd.source File
internal/model/node.go
X Reqmd.source Line
84
X Reqmd.symbol Kind
type
Status
approved

IMP-model-Document-57ebc69 Document

#

Document groups all content sharing a single schema.yaml. Nodes holdsthe ordered content tree; every heading in every .md file is a nodeexcept the level-1 document title (see parser). Title is the firstfile's h1 heading, when present.

Synthetic marks documents that do not originate from authored Markdownon disk — currently the pseudo-document of verification resultssynthesized by internal/verify, later also synthesized test cases. Nodesof a synthetic document carry no schema, no ID prefix, and no source filethat tooling may rewrite (e.g. repin must skip them).

Details
X Reqmd.imported
true
X Reqmd.source File
internal/model/node.go
X Reqmd.source Line
99
X Reqmd.symbol Kind
type
Status
approved

IMP-model-Requirements-83ad233 Requirements

#

Requirements returns all requirement-kind nodes in document order(depth-first). The returned pointers reference the tree itself, soin-place mutation updates the document.

Details
X Reqmd.imported
true
X Reqmd.source File
internal/model/node.go
X Reqmd.source Line
113
X Reqmd.symbol Kind
method
Status
approved

IMP-model-CollectRequirements-a8770c2 CollectRequirements

#

missing coverage

CollectRequirements walks a node tree depth-first and returns allrequirement-kind nodes in document order.

Details
X Reqmd.imported
true
X Reqmd.source File
internal/model/node.go
X Reqmd.source Line
119
X Reqmd.symbol Kind
function
Status
approved

IMP-model-TestNodeAllFields-4f66d3a TestNodeAllFields

#

missing coverage

Details
X Reqmd.imported
true
X Reqmd.source File
internal/model/node_test.go
X Reqmd.source Line
5
X Reqmd.symbol Kind
function
Status
approved

IMP-model-TestNodeEdgeCases-7f138f6 TestNodeEdgeCases

#

missing coverage

Details
X Reqmd.imported
true
X Reqmd.source File
internal/model/node_test.go
X Reqmd.source Line
48
X Reqmd.symbol Kind
function
Status
approved

IMP-model-TestKindString-4623907 TestKindString

#

missing coverage

Details
X Reqmd.imported
true
X Reqmd.source File
internal/model/node_test.go
X Reqmd.source Line
73
X Reqmd.symbol Kind
function
Status
approved

IMP-model-TestCollectRequirements-e08b61e TestCollectRequirements

#

missing coverage

Details
X Reqmd.imported
true
X Reqmd.source File
internal/model/node_test.go
X Reqmd.source Line
89
X Reqmd.symbol Kind
function
Status
approved

IMP-model-TestDocumentRequirements-0d84ca1 TestDocumentRequirements

#

missing coverage

Details
X Reqmd.imported
true
X Reqmd.source File
internal/model/node_test.go
X Reqmd.source Line
109
X Reqmd.symbol Kind
function
Status
approved

IMP-model-TestDocumentZeroNodes-71758c0 TestDocumentZeroNodes

#

missing coverage

Details
X Reqmd.imported
true
X Reqmd.source File
internal/model/node_test.go
X Reqmd.source Line
135
X Reqmd.symbol Kind
function
Status
approved