Package: schema

BuiltinAttr describes a single reqmd built-in attribute.

builtinDefs is the canonical list of all reqmd built-in attributes.

Order defines the display order: trace first (most common), then theremaining attributes in the order they were added to the tool.

builtinSet is a name → true map for fast lookup.

IsBuiltin returns true if name is a reserved reqmd built-in attribute.

RejectBuiltinRedefinition checks a user schema's attrs map for anyattribute names that are reserved by reqmd. Returns an error listingall redefined names, or nil if the schema is clean.

BuiltinPropertyDefs returns a JSON Schema properties map containingall built-in attribute definitions. The returned map can be mergedinto a schema's "properties" field.

BuiltinNames returns the sorted list of built-in attribute names.

InjectBuiltins adds all built-in property definitions to the givenJSON Schema map's "properties" field, creating it if needed.It does not modify the schema's "required" list — built-ins arealways optional.

Must be called after Normalize and before Compile (JSON marshal).

T1: BuiltinNames must include "status".

T2: Compile injects the built-in status attribute with the canonicalenum [draft, approved] into an empty schema. A subsequent validateaccepts both values and rejects everything else.

Compiled holds a compiled schema ready for validation and property introspection.

Compile validates the schema, injects built-in attrs, and compiles itagainst JSON Schema 2020-12. schemaPath is the directory containing theschema file.

statusAdditionPattern matches the lowercase-only requirement forx-reqmd.additional-status-values entries: starts with a lowercase letter,then lowercase letters, digits, hyphen, or underscore.

requiresTraceFromTokenPattern mirrors the built-in requires-trace-fromitem pattern: lowercase letters, digits, hyphen, or underscore. Documentdefaults name document-ids or levels, which follow the same shape.

collectRequiresTraceFromDefault reads x-reqmd.requires-trace-from (thedocument-wide default coverage expectation) from a normalized schema map,validates each token, and returns the cleaned slice. A bare string isaccepted and treated as a one-token list. The empty list is allowed (itmeans every requirement in the document opts out of downstream coverage).Returns nil (no error) when the key is absent.

collectStatusAdditions reads x-reqmd.additional-status-values from anormalized schema map, validates each entry (lowercase only, noduplication, no built-in collision), and returns the cleaned slice.Returns nil (no error) when the field is absent or empty — emptyadditions are a no-op.

applyStatusAdditions appends the validated extension values to thebuilt-in status enum in the schema's properties. Called afterInjectBuiltins so the built-in definition is already present.

orderedPropertyNames is the single implementation of the property-orderconvention: required fields in schema order, then remaining propertykeys sorted alphabetically, then built-in attribute names not alreadylisted. Shared by PropertyNames (compiled schema) and ExtractProperties(raw schema map) so the ordering rule lives in one place.

propertyKeySet converts a property map (either form) into a key set fororderedPropertyNames. The compiled schema uses *jsonschema.Schemavalues, the raw map uses any.

Normalize validates a schema and checks for built-in redefinition.The schema must be valid JSON Schema 2020-12 (in YAML map form).It is returned as-is; built-in attrs are injected later by Compile.

ExtractProperties extracts property order from a raw JSON Schema map.Uses the google/jsonschema-go library to parse the schema struct.Required fields first (in schema's required order), then optionalfields alphabetically, then built-in attributes at the end.

Title extracts a human-readable title from a parsed schema.Uses "$id — title", "$id", or "title" from the JSON Schema.

ExtractXReqmd reads the x-reqmd extension block from a parsed schema.Returns nil if the key is absent. All fields are optional.

validSchema is a valid JSON Schema 2020-12 in YAML map form.

T9: built-in collision rejected as config-error.

T10: capitalized additions rejected (lowercase-only is config-error).

T18: duplicate additions rejected.

T12: user schema with properties: {status: ...} triggers thebuilt-in redefinition check.

T15: schemas with additionalProperties: false (e.g. 00-aspice,01-stakeholder) must still accept the new built-in status attribute.The built-in is injected before the additionalProperties check runs,so it's not flagged as an "additional" property.