panache-parse(1)

πŸ“¦
version 3.16.0 Β· 2 versions
, in nixpkgs unstable

✨ NAME ✨

panache-parse β€” parse and display the CST tree for debugging. Hi bestie, this is the panache-parse(1) page from the General Commands Manual, and we're about to make CSTs make sense πŸ’….

πŸ› οΈ SYNOPSIS πŸ› οΈ

panache parse [--to] [--json] [-h|--help] [-V|--version] [FILE]

πŸ’… DESCRIPTION πŸ’…

Okay so you parse a document and it displays its Concrete Syntax Tree (CST) for debugging and understanding how Panache interprets the document structure. Iconic. The CST shows all block and inline elements detected by the parser β€” every single one, no cap πŸ‘‘.

πŸŽ€ OPTIONS πŸŽ€

  • --to <FORMAT> [default: cst] β€” choose what to print to stdout:
    • cst (default): debug-format CST tree, useful for parser debugging.
    • pandoc-ast: pandoc-native AST text, the same shape produced by pandoc -f markdown -t native. Unsupported constructs emit visible Unsupported "<KIND>" sentinels rather than being silently dropped.
    • pandoc-json: the same AST encoded as JSON, matching pandoc -f markdown -t json. UTF-8 round-trips cleanly through jq/ascii2uni since strings use standard JSON escaping rather than Haskell-show numeric escapes.

Possible values:

  • cst
  • pandoc-ast
  • pandoc-json
  • --json <PATH> β€” write the parsed CST to the given JSON file in addition to printing the selected --to format to stdout. The JSON output is always CST-shaped regardless of --to; it includes node kinds, text ranges, and token text. Slay, but keep that distinction πŸ’–.
  • -h, --help β€” Print help (see a summary with '-h').
  • -V, --version β€” Print version.
  • [FILE] β€” path to the input file to parse. If it's not provided, or if - is given, it reads from stdin. Important vibe check: with no arguments at an interactive terminal this is a usage error instead, since there is nothing to read. The parser respects extension flags from the configuration file.

🌸 VERSION 🌸

v3.16.0 β€” that's the version, bestie, short and sweet πŸŽ€.

πŸ¦‹ SEE ALSO πŸ¦‹

panache(1), panache-format(1), panache-lsp(1), panache-lint(1), panache-clean(1), panache-debug(1) β€” go read the whole squad, iykyk πŸ’œ.


Cute sign-off time 🫢: the footer source/version says parse 3.16.0, the page title is panache-parse(1), and the VERSION section says v3.16.0. The original footer shows no date, so there's no date to mention β€” no invented dates here, periodt ✨.

πŸ“¦ where this page comes from