How to manually bump cmd‐help version in bat's submodules

(WIP) #TODO

• add sample to regression test sources
• update links

The sample help message we use to test cmd-help for regression on the bat project comes from bat v<X.Y.Z>.

We also track it in the project (source, highlighted).

If the highlighted version changes while running tests (and we merge into main), we have to propagate that change to bat.

Normally, cmd-help.sublime-syntax is automatically updated by bat's Dependabot setup. (example)

But when the regression test message changes, we break the tests there and the Dependabot update won't proceed. (example)

• Clone the bat repository and cd in

• Update the submodule to latest:

  git submodule update --remote assets/syntaxes/02_Extra/cmd-help

• Build a bat binary with modified syntaxes and themes:

  bash assets/create.sh
  cargo install --path . --locked --force

• Run syntax highlighting regression tests:

  tests/syntax_tests/update.sh

• Update the Changelog in their style

• Commit everything together

• Make a PR (example)

---

References:

• https://github.com/sharkdp/bat#development
• https://github.com/sharkdp/bat/blob/master/doc/assets.md#syntax-tests