configref

command
v0.0.35 Latest Latest
Warning

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

Go to latest
Published: Sep 11, 2026 License: Apache-2.0 Imports: 10 Imported by: 0

Documentation

Overview

Command configref is the BUILD-TIME generator (issue #140) that emits the two committed configuration artifacts from the permconfig YAML schema:

  • the commented settings.yaml skeleton (--skeleton), embedded by `config init`, and
  • the rendered Markdown configuration reference (--reference).

It is the ONLY place go/ast is used to harvest the schema's field doc-comments; the shipped mecated binary never imports go/ast (it embeds the skeleton this program writes). Invoked by `task docs:configref`; a CI step regenerates to a temp dir and diffs against the committed files, failing on drift.

The model is built by configgen.BuildModel (reflection only); this program only adds the go/ast doc-comment harvest. So the skeleton, the reference, AND the configgen tests all walk the SAME model — none can disagree, and reflecting over the permconfig structs means none can drift from the code.

Jump to

Keyboard shortcuts

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