great-docs termshow validate

Check recordings and their scripts for mistakes.

great-docs termshow validate [OPTIONS] SOURCES...

Errors are things the format doesn’t allow: a malformed recording line, an unknown script key, a misspelled theme or position, a cut that ends before it starts, or a pattern that isn’t a regular expression.

Warnings are things that are allowed but probably not meant: an annotation that starts after the recording ends, overlapping cuts or snippets, chapters out of order, two annotations in the same spot, or a match pattern that never appears on screen while it’s active.

Each recording’s companion .termshow.yml is checked with it. A script can also be given on its own, and its recording is found next to it. Exits with status 1 if there are errors (or, with --strict, warnings).

Full --help output

Usage: great-docs termshow validate [OPTIONS] SOURCES...

  Check recordings and their scripts for mistakes.

  Errors are things the format doesn't allow: a malformed recording line, an
  unknown script key, a misspelled theme or position, a cut that ends before
  it starts, or a pattern that isn't a regular expression.

  Warnings are things that are allowed but probably not meant: an annotation
  that starts after the recording ends, overlapping cuts or snippets, chapters
  out of order, two annotations in the same spot, or a `match` pattern that
  never appears on screen while it's active.

  Each recording's companion .termshow.yml is checked with it. A script can
  also be given on its own, and its recording is found next to it. Exits with
  status 1 if there are errors (or, with --strict, warnings).

  Examples:   great-docs termshow validate demos/install.termshow   great-docs
  termshow validate demos/*.termshow --strict

Options:
  --script FILE  Path to .termshow.yml script (with a single recording)
  --no-script    Check the recording without its script
  --strict       Fail on warnings as well as errors
  --help         Show this message and exit.

Arguments

SOURCES: FILE

Required.

Options

--script: FILE

Path to .termshow.yml script (with a single recording)

--no-script

Check the recording without its script

--strict

Fail on warnings as well as errors

Examples

  great-docs termshow validate demos/install.termshow
  great-docs termshow validate demos/*.termshow --strict