Skip to content

table-generation.md

Latest commit

 

History

History
77 lines (53 loc) · 2.86 KB

table-generation.md

File metadata and controls

77 lines (53 loc) · 2.86 KB

Manual Table Generation

Generate markdown tables from YAML files using the table generator script:

# Generate all formats for a single type
python3 scripts/hooks/yaml_to_markdown.py components --all-formats
# Output: components-full.md, components-summary.md

python3 scripts/hooks/yaml_to_markdown.py controls --all-formats
# Output: controls-full.md, controls-summary.md, controls-xref-risks.md, controls-xref-components.md

# Generate specific format
python3 scripts/hooks/yaml_to_markdown.py controls --format summary
python3 scripts/hooks/yaml_to_markdown.py controls --format xref-risks

# Generate all types, all formats (12 files)
python3 scripts/hooks/yaml_to_markdown.py --all --all-formats

# Generate to custom output directory
python3 scripts/hooks/yaml_to_markdown.py --all --all-formats --output-dir /tmp/tables

# Custom output file (single type, single format only)
python3 scripts/hooks/yaml_to_markdown.py components --format full -o custom.md

# Quiet mode
python3 scripts/hooks/yaml_to_markdown.py --all --all-formats --quiet

Table Formats

  • full - Complete detail tables with all columns
  • summary - Condensed tables (ID, Title, Description, Category)
  • xref-risks - Cross-reference to risks (controls, personas)
  • xref-components - Control-to-component cross-reference (controls only)
  • xref-controls - Persona-to-control cross-reference (personas only)

Flat XRef Tables

Flat xref tables (one row per mapping) are the default for all xref formats. No flag is needed to produce them.

To opt out and generate the legacy grouped format (multiple IDs packed into single cells with <br> separators), use --no-flat:

python3 scripts/hooks/yaml_to_markdown.py controls --format xref-risks --no-flat

The --no-flat flag applies to xref-controls, xref-risks, and xref-components formats. It is silently ignored for full and summary formats.

Output Files

  • Components: components-full.md, components-summary.md (2 files)
  • Controls: controls-full.md, controls-summary.md, controls-xref-risks.md, controls-xref-components.md (4 files)
  • Risks: risks-full.md, risks-summary.md (2 files)
  • Personas: personas-full.md, personas-summary.md, personas-xref-controls.md, personas-xref-risks.md (4 files)

Debugging Table Generation

Run table generation manually to test:

# Test component table generation
python3 scripts/hooks/yaml_to_markdown.py components --all-formats

# Test controls table generation (all 4 formats)
python3 scripts/hooks/yaml_to_markdown.py controls --all-formats

# Test with verbose output
python3 scripts/hooks/yaml_to_markdown.py controls --all-formats

Related: