Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Scanning work comments with annotations

The annotations command systematically scans IbiScript source files for work comments marked with specific tags (TODO, FIXME, WARN, NOTE). This tool enables the editor to track the progress of the edition and locate unresolved critical points prior to final compilation. Via the CLI options, users can restrict the scan to specific tags, collapse output onto a single line to facilitate grep integration, export results as JSON, or force a non-zero exit status if matches are found (ideal for automated validation scripts).

$ ibis annotations -h

Scan IbiScript files for tagged annotation comments (TODO, FIXME, WARN, NOTE)

Usage: ibis annotations [OPTIONS] [PATHS]...

Arguments:
  [PATHS]...  Files or directories to scan

Options:
  -t <TAGS>           Restrict to specific tags (repeatable). Omit to include all tagged comments
      --no-recursive  Do not descend into subdirectories
      --check         Exit non-zero if any matching annotation is found; suppresses listing unless --verbose
      --verbose       Print matches even when --check is set
      --json          Output as JSON
      --oneline       Collapse multi-line comment text onto a single line (useful for grep/scripting)
  -h, --help          Print help