reqmd Package: reporter

Package: reporter

approved 66Leaf

66 requirements · 8 nested · 2 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-reporter-colorBold-1d71556 colorBold

#

missing coverage

Details
X Reqmd.imported
true
X Reqmd.source File
internal/reporter/diff.go
X Reqmd.source Line
12
X Reqmd.symbol Kind
const
Status
approved

IMP-reporter-colorCyan-ce187da colorCyan

#

missing coverage

Details
X Reqmd.imported
true
X Reqmd.source File
internal/reporter/diff.go
X Reqmd.source Line
12
X Reqmd.symbol Kind
const
Status
approved

IMP-reporter-colorGreen-2c55b9c colorGreen

#

missing coverage

Details
X Reqmd.imported
true
X Reqmd.source File
internal/reporter/diff.go
X Reqmd.source Line
12
X Reqmd.symbol Kind
const
Status
approved

IMP-reporter-colorRed-a0f63fc colorRed

#

missing coverage

Details
X Reqmd.imported
true
X Reqmd.source File
internal/reporter/diff.go
X Reqmd.source Line
12
X Reqmd.symbol Kind
const
Status
approved

IMP-reporter-colorReset-7cd7b40 colorReset

#

missing coverage

Details
X Reqmd.imported
true
X Reqmd.source File
internal/reporter/diff.go
X Reqmd.source Line
12
X Reqmd.symbol Kind
const
Status
approved

IMP-reporter-colorYellow-55a4909 colorYellow

#

missing coverage

Details
X Reqmd.imported
true
X Reqmd.source File
internal/reporter/diff.go
X Reqmd.source Line
12
X Reqmd.symbol Kind
const
Status
approved

IMP-reporter-FormatDiff-2a9528e FormatDiff

#

missing coverage

FormatDiff produces a human-readable colored text diff.

Details
X Reqmd.imported
true
X Reqmd.source File
internal/reporter/diff.go
X Reqmd.source Line
22
X Reqmd.symbol Kind
function
Status
approved

IMP-reporter-shortHash-b263d54 shortHash

#

missing coverage

shortHash returns the first 7 characters of a SHA, or the full SHA if shorter.

Details
X Reqmd.imported
true
X Reqmd.source File
internal/reporter/diff.go
X Reqmd.source Line
110
X Reqmd.symbol Kind
function
Status
approved

IMP-reporter-formatSubmoduleChange-bdeb209 formatSubmoduleChange

#

missing coverage

formatSubmoduleChange returns the formatted line and color for a submodule change.

Details
X Reqmd.imported
true
X Reqmd.source File
internal/reporter/diff.go
X Reqmd.source Line
118
X Reqmd.symbol Kind
function
Status
approved

IMP-reporter-renderSubmoduleSection-dcf35fb renderSubmoduleSection

#

missing coverage

renderSubmoduleSection renders the submodule changes section.Returns an empty string if there are no submodule changes.

Details
X Reqmd.imported
true
X Reqmd.source File
internal/reporter/diff.go
X Reqmd.source Line
133
X Reqmd.symbol Kind
function
Status
approved

IMP-reporter-FormatDiffJSON-ba26c18 FormatDiffJSON

#

missing coverage

FormatDiffJSON produces JSON output.

Details
X Reqmd.imported
true
X Reqmd.source File
internal/reporter/diff.go
X Reqmd.source Line
149
X Reqmd.symbol Kind
function
Status
approved

IMP-reporter-formatValue-a56317e formatValue

#

missing coverage

formatValue renders an attribute value for display.

Details
X Reqmd.imported
true
X Reqmd.source File
internal/reporter/diff.go
X Reqmd.source Line
158
X Reqmd.symbol Kind
function
Status
approved

IMP-reporter-TestFormatDiff_Submodules-7ebb990 TestFormatDiff_Submodules

#

missing coverage

Details
X Reqmd.imported
true
X Reqmd.source File
internal/reporter/diff_test.go
X Reqmd.source Line
10
X Reqmd.symbol Kind
function
Status
approved

IMP-reporter-TestFormatDiff_NoSubmodules-321d12f TestFormatDiff_NoSubmodules

#

missing coverage

Details
X Reqmd.imported
true
X Reqmd.source File
internal/reporter/diff_test.go
X Reqmd.source Line
39
X Reqmd.symbol Kind
function
Status
approved

IMP-reporter-TestShortHash-38bc934 TestShortHash

#

missing coverage

Details
X Reqmd.imported
true
X Reqmd.source File
internal/reporter/diff_test.go
X Reqmd.source Line
51
X Reqmd.symbol Kind
function
Status
approved

IMP-reporter-ValidationError-7751545 ValidationError

#

missing coverage

ValidationError describes a single requirement that failed validation.

Details
X Reqmd.imported
true
X Reqmd.source File
internal/reporter/reporter.go
X Reqmd.source Line
16
X Reqmd.symbol Kind
type
Status
approved

IMP-reporter-ParseError-d4d4381 ParseError

#

missing coverage

ParseError describes a structural problem (file unreadable, bad YAML, etc.).

Details
X Reqmd.imported
true
X Reqmd.source File
internal/reporter/reporter.go
X Reqmd.source Line
23
X Reqmd.symbol Kind
type
Status
approved

IMP-reporter-ExitCodeError-1585eb7 ExitCodeError

#

ExitCodeError wraps a desired process exit code so that main.gocan set exit code via cobra error handling instead of os.Exit in command handlers.

Details
X Reqmd.imported
true
X Reqmd.source File
internal/reporter/reporter.go
X Reqmd.source Line
30
X Reqmd.symbol Kind
type
Status
approved

IMP-reporter-Error-d7589b1 Error

#
Details
X Reqmd.imported
true
X Reqmd.source File
internal/reporter/reporter.go
X Reqmd.source Line
34
X Reqmd.symbol Kind
method
Status
approved

IMP-reporter-ExitCode-0014db4 ExitCode

#

ExitCode returns the process exit code this error carries.

Details
X Reqmd.imported
true
X Reqmd.source File
internal/reporter/reporter.go
X Reqmd.source Line
39
X Reqmd.symbol Kind
method
Status
approved

IMP-reporter-DocHeader-4245769 DocHeader

#

missing coverage

DocHeader holds per-document metadata for the validate output header.

Details
X Reqmd.imported
true
X Reqmd.source File
internal/reporter/reporter.go
X Reqmd.source Line
42
X Reqmd.symbol Kind
type
Status
approved

IMP-reporter-Report-2c840c8 Report

#

Report holds all results from a validation run.

Details
X Reqmd.imported
true
X Reqmd.source File
internal/reporter/reporter.go
X Reqmd.source Line
50
X Reqmd.symbol Kind
type
Status
approved

IMP-reporter-NewIndex-266d9a6 NewIndex

#

NewIndex populates the pre-indexed maps from the flat slices.Bucketing by reqID makes the per-reqID lookups in Format()/FormatJSON() O(1)instead of scanning all errors/checks per requirement.

Details
X Reqmd.imported
true
X Reqmd.source File
internal/reporter/reporter.go
X Reqmd.source Line
65
X Reqmd.symbol Kind
method
Status
approved

IMP-reporter-ExitCode-22aced1 ExitCode

#

ExitCode returns the appropriate exit code per the spec:0 = all valid 1 = validation errors 2 = parse errors

Details
X Reqmd.imported
true
X Reqmd.source File
internal/reporter/reporter.go
X Reqmd.source Line
81
X Reqmd.symbol Kind
method
Status
approved

IMP-reporter-counts-5083288 counts

#

counts tallies WARNING and ERROR-level graph checks in a single pass.Shared by ExitCode, Format, and FormatJSON so the summary numbers arecomputed the same way everywhere.

Details
X Reqmd.imported
true
X Reqmd.source File
internal/reporter/reporter.go
X Reqmd.source Line
99
X Reqmd.symbol Kind
method
Status
approved

IMP-reporter-resultFindings-da40197 resultFindings

#

resultFindings returns graph checks that belong to the verificationresults layer rather than to an authored requirement: findings attributedto synthesized nodes (RESULT:/TC: IDs) and loader warnings attachedwithout a ReqID (e.g. unbound-result). These are rendered in a dedicatedresults section, never as requirement-attributed findings.

Details
X Reqmd.imported
true
X Reqmd.source File
internal/reporter/reporter.go
X Reqmd.source Line
116
X Reqmd.symbol Kind
method
Status
approved

IMP-reporter-Format-dde0447 Format

#

Format produces the per-file, per-requirement validation reportas specified in the spec tree under spec/.

Details
X Reqmd.imported
true
X Reqmd.source File
internal/reporter/reporter.go
X Reqmd.source Line
131
X Reqmd.symbol Kind
method
Status
approved

IMP-reporter-FormatJSON-7d0f915 FormatJSON

#

FormatJSON serializes the full check report as JSON.

Details
X Reqmd.imported
true
X Reqmd.source File
internal/reporter/reporter.go
X Reqmd.source Line
471
X Reqmd.symbol Kind
method
Status
approved

IMP-reporter-FormatList-a6f5d1d FormatList

#

missing coverage

FormatList produces a text table for reqmd list. Every node appearsin document order with a leading Type column: requirements carry theirID (+ title) and attributes, containers and info items show theirheading text with empty attribute cells.

Details
X Reqmd.imported
true
X Reqmd.source File
internal/reporter/reporter.go
X Reqmd.source Line
257
X Reqmd.symbol Kind
function
Status
approved

IMP-reporter-FormatStats-2b22ce0 FormatStats

#

missing coverage

FormatStats produces a stats breakdown. The per-document header showsrequirement and item counts; a type breakdown section precedes theattribute-value breakdowns.

Details
X Reqmd.imported
true
X Reqmd.source File
internal/reporter/reporter.go
X Reqmd.source Line
303
X Reqmd.symbol Kind
function
Status
approved

IMP-reporter-DocumentSummary-360b609 DocumentSummary

#

missing coverage

DocumentSummary is the data needed for list/stats display.

Details
X Reqmd.imported
true
X Reqmd.source File
internal/reporter/reporter.go
X Reqmd.source Line
349
X Reqmd.symbol Kind
type
Status
approved

IMP-reporter-NodeRow-a2eea22 NodeRow

#

missing coverage

NodeRow is a single row in list/stats output: a requirement or aninformation item (container/info), in document order.

Details
X Reqmd.imported
true
X Reqmd.source File
internal/reporter/reporter.go
X Reqmd.source Line
359
X Reqmd.symbol Kind
type
Status
approved

IMP-reporter-attributeCounts-eb7d80a attributeCounts

#

missing coverage

attributeCounts tallies string attribute values per declared propertyacross a document's rows. Properties with no string values are omitted.Shared by the text and JSON stats formatters so both report identicalbreakdowns.

Details
X Reqmd.imported
true
X Reqmd.source File
internal/reporter/reporter.go
X Reqmd.source Line
370
X Reqmd.symbol Kind
function
Status
approved

IMP-reporter-sortedKeys-a407aab sortedKeys

#

missing coverage

Details
X Reqmd.imported
true
X Reqmd.source File
internal/reporter/reporter.go
X Reqmd.source Line
386
X Reqmd.symbol Kind
function
Status
approved

IMP-reporter-jsonReport-d472f7e jsonReport

#

missing coverage


Details
X Reqmd.imported
true
X Reqmd.source File
internal/reporter/reporter.go
X Reqmd.source Line
399
X Reqmd.symbol Kind
type
Status
approved

JSON output types (private — serialized via json.Marshal)

IMP-reporter-jsonSummary-86ada34 jsonSummary

#

missing coverage

Details
X Reqmd.imported
true
X Reqmd.source File
internal/reporter/reporter.go
X Reqmd.source Line
408
X Reqmd.symbol Kind
type
Status
approved

IMP-reporter-jsonDocSection-6795f5d jsonDocSection

#

missing coverage

Details
X Reqmd.imported
true
X Reqmd.source File
internal/reporter/reporter.go
X Reqmd.source Line
417
X Reqmd.symbol Kind
type
Status
approved

IMP-reporter-jsonReqResult-b005c6d jsonReqResult

#

missing coverage

Details
X Reqmd.imported
true
X Reqmd.source File
internal/reporter/reporter.go
X Reqmd.source Line
424
X Reqmd.symbol Kind
type
Status
approved

IMP-reporter-jsonChk-655adcc jsonChk

#

missing coverage

Details
X Reqmd.imported
true
X Reqmd.source File
internal/reporter/reporter.go
X Reqmd.source Line
430
X Reqmd.symbol Kind
type
Status
approved

IMP-reporter-jsonParseErr-341f8fe jsonParseErr

#

missing coverage

Details
X Reqmd.imported
true
X Reqmd.source File
internal/reporter/reporter.go
X Reqmd.source Line
440
X Reqmd.symbol Kind
type
Status
approved

IMP-reporter-jsonListReport-0de3b56 jsonListReport

#

missing coverage

Details
X Reqmd.imported
true
X Reqmd.source File
internal/reporter/reporter.go
X Reqmd.source Line
445
X Reqmd.symbol Kind
type
Status
approved

IMP-reporter-jsonListDoc-8485cea jsonListDoc

#

missing coverage

Details
X Reqmd.imported
true
X Reqmd.source File
internal/reporter/reporter.go
X Reqmd.source Line
449
X Reqmd.symbol Kind
type
Status
approved

IMP-reporter-jsonListRow-72c7e70 jsonListRow

#

missing coverage

Details
X Reqmd.imported
true
X Reqmd.source File
internal/reporter/reporter.go
X Reqmd.source Line
455
X Reqmd.symbol Kind
type
Status
approved

IMP-reporter-jsonStatsDoc-6293ad3 jsonStatsDoc

#

missing coverage

Details
X Reqmd.imported
true
X Reqmd.source File
internal/reporter/reporter.go
X Reqmd.source Line
463
X Reqmd.symbol Kind
type
Status
approved

IMP-reporter-FormatListJSON-be34f2b FormatListJSON

#

missing coverage

FormatListJSON serializes list output as JSON. All nodes appear indocument order in the rows array with a type discriminator.

Details
X Reqmd.imported
true
X Reqmd.source File
internal/reporter/reporter.go
X Reqmd.source Line
563
X Reqmd.symbol Kind
function
Status
approved

IMP-reporter-FormatStatsJSON-e3ea6f2 FormatStatsJSON

#

missing coverage

FormatStatsJSON serializes stats output as JSON.

Details
X Reqmd.imported
true
X Reqmd.source File
internal/reporter/reporter.go
X Reqmd.source Line
594
X Reqmd.symbol Kind
function
Status
approved

IMP-reporter-jsonStatsOut-e998dd9 jsonStatsOut

#

missing coverage

Details
X Reqmd.imported
true
X Reqmd.source File
internal/reporter/reporter.go
X Reqmd.source Line
595
X Reqmd.symbol Kind
type
Status
approved

IMP-reporter-mustUnmarshal-cbdc45e mustUnmarshal

#

missing coverage

mustUnmarshal decodes JSON string into a map for assertion checks.

Details
X Reqmd.imported
true
X Reqmd.source File
internal/reporter/reporter_test.go
X Reqmd.source Line
12
X Reqmd.symbol Kind
function
Status
approved

IMP-reporter-TestExitCode-67062c7 TestExitCode

#

missing coverage

--- ExitCode ---

Details
X Reqmd.imported
true
X Reqmd.source File
internal/reporter/reporter_test.go
X Reqmd.source Line
23
X Reqmd.symbol Kind
function
Status
approved

IMP-reporter-TestFormat_Empty-4b3c13f TestFormat_Empty

#

missing coverage

--- Format (empty) ---

Details
X Reqmd.imported
true
X Reqmd.source File
internal/reporter/reporter_test.go
X Reqmd.source Line
85
X Reqmd.symbol Kind
function
Status
approved

IMP-reporter-TestFormat_WithValidationErrors-0fb0226 TestFormat_WithValidationErrors

#

missing coverage

--- Format (validation errors) ---

Details
X Reqmd.imported
true
X Reqmd.source File
internal/reporter/reporter_test.go
X Reqmd.source Line
95
X Reqmd.symbol Kind
function
Status
approved

IMP-reporter-TestFormat_WithNewFormat-2c91a63 TestFormat_WithNewFormat

#

missing coverage

--- Format (new format with DocHeaders) ---

Details
X Reqmd.imported
true
X Reqmd.source File
internal/reporter/reporter_test.go
X Reqmd.source Line
133
X Reqmd.symbol Kind
function
Status
approved

IMP-reporter-TestFormat_EmptyWithDocHeaders-654afa3 TestFormat_EmptyWithDocHeaders

#

missing coverage

--- Format (empty with DocHeaders) ---

Details
X Reqmd.imported
true
X Reqmd.source File
internal/reporter/reporter_test.go
X Reqmd.source Line
187
X Reqmd.symbol Kind
function
Status
approved

IMP-reporter-TestExitCode_GraphErrorChangesExitCode-b8da1e6 TestExitCode_GraphErrorChangesExitCode

#

missing coverage

--- ExitCode with graph errors ---

Details
X Reqmd.imported
true
X Reqmd.source File
internal/reporter/reporter_test.go
X Reqmd.source Line
212
X Reqmd.symbol Kind
function
Status
approved

IMP-reporter-TestFormat_WithParseErrors-219535a TestFormat_WithParseErrors

#

missing coverage

--- Format (parse errors) ---

Details
X Reqmd.imported
true
X Reqmd.source File
internal/reporter/reporter_test.go
X Reqmd.source Line
227
X Reqmd.symbol Kind
function
Status
approved

IMP-reporter-TestFormatList-7bfaedd TestFormatList

#

missing coverage

--- FormatList ---

Details
X Reqmd.imported
true
X Reqmd.source File
internal/reporter/reporter_test.go
X Reqmd.source Line
253
X Reqmd.symbol Kind
function
Status
approved

IMP-reporter-TestFormatList_WithTitle-3a5f904 TestFormatList_WithTitle

#

missing coverage

Details
X Reqmd.imported
true
X Reqmd.source File
internal/reporter/reporter_test.go
X Reqmd.source Line
302
X Reqmd.symbol Kind
function
Status
approved

IMP-reporter-TestFormatListJSON_WithTitle-ce5e1e2 TestFormatListJSON_WithTitle

#

missing coverage

Details
X Reqmd.imported
true
X Reqmd.source File
internal/reporter/reporter_test.go
X Reqmd.source Line
325
X Reqmd.symbol Kind
function
Status
approved

IMP-reporter-TestFormatStats-fe92ba0 TestFormatStats

#

missing coverage

--- FormatStats ---

Details
X Reqmd.imported
true
X Reqmd.source File
internal/reporter/reporter_test.go
X Reqmd.source Line
363
X Reqmd.symbol Kind
function
Status
approved

IMP-reporter-TestFormatJSON_Simple-25c543a TestFormatJSON_Simple

#

missing coverage

--- JSON output ---

Details
X Reqmd.imported
true
X Reqmd.source File
internal/reporter/reporter_test.go
X Reqmd.source Line
405
X Reqmd.symbol Kind
function
Status
approved

IMP-reporter-TestFormatJSON_Empty-cedf301 TestFormatJSON_Empty

#

missing coverage

Details
X Reqmd.imported
true
X Reqmd.source File
internal/reporter/reporter_test.go
X Reqmd.source Line
490
X Reqmd.symbol Kind
function
Status
approved

IMP-reporter-TestFormatJSON_ParseErrors-9e07194 TestFormatJSON_ParseErrors

#

missing coverage

Details
X Reqmd.imported
true
X Reqmd.source File
internal/reporter/reporter_test.go
X Reqmd.source Line
508
X Reqmd.symbol Kind
function
Status
approved

IMP-reporter-TestFormatJSON_GraphErrors-936fba3 TestFormatJSON_GraphErrors

#

missing coverage

Details
X Reqmd.imported
true
X Reqmd.source File
internal/reporter/reporter_test.go
X Reqmd.source Line
530
X Reqmd.symbol Kind
function
Status
approved

IMP-reporter-TestFormatListJSON-6daeeeb TestFormatListJSON

#

missing coverage

Details
X Reqmd.imported
true
X Reqmd.source File
internal/reporter/reporter_test.go
X Reqmd.source Line
554
X Reqmd.symbol Kind
function
Status
approved

IMP-reporter-TestFormatStatsJSON-8a521b2 TestFormatStatsJSON

#

missing coverage

Details
X Reqmd.imported
true
X Reqmd.source File
internal/reporter/reporter_test.go
X Reqmd.source Line
586
X Reqmd.symbol Kind
function
Status
approved

IMP-reporter-TestFormat_ResultsSection-45a5597 TestFormat_ResultsSection

#

missing coverage

Details
X Reqmd.imported
true
X Reqmd.source File
internal/reporter/reporter_test.go
X Reqmd.source Line
620
X Reqmd.symbol Kind
function
Status
approved