dangernoodle-io / breadboard / 28756091507

100%

push

github

feat: add bbtool docs command with marker-delimited component README generation (#747)

- new `bbtool docs gen` subcommand regenerates GENERATED marker regions
  (deps parsed from CMakeLists.txt REQUIRES/PRIV_REQUIRES, platform support
  matrix from platform/{host,espidf,arduino}/<name>/ presence) in component
  READMEs that already opt in via <!-- BEGIN/END bbtool:<key> --> markers
- CMakeLists.txt parsing strips `#`-to-end-of-line comments before
  tokenizing REQUIRES/PRIV_REQUIRES, so inline comments (as in bb_info,
  bb_button, etc.) don't pollute the parsed dependency lists
- marker rewriting refuses to touch a region whose body contains a nested
  BEGIN marker (fails loudly with a stderr message + non-zero exit instead
  of silently corrupting content), warns on a BEGIN with no matching END,
  and tolerates CRLF line endings
- new `component-readme` lint rule (profile=library, severity=warn) flags
  components/<name>/ dirs lacking a README.md; fires broadly today by
  design (B1-644/B1-646)
- wire bb_attrs and bb_filter READMEs onto the new template/marker
  convention as the first two examples
- add `make docs` + fold a `docs-check` (gen + git diff --exit-code) drift
  step into `make check`, alongside the existing docs-index-check target
- document the command, template, and marker convention in
  scripts/bbtool/README.md

Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>

3118 of 3118 branches covered (100.0%)

Branch coverage included in aggregate %.

5016 of 5016 relevant lines covered (100.0%)

10544.33 hits per line