TESTASCIIDOC(1)

📦
version 10.2.1 · 11 versions
, in alpine 3.22, alpine 3.23, alpine 3.24, arch rolling, opensuse-leap 16.0

💅 testasciidoc(1)

okay bestie, welcome to the testasciidoc page — it's the testasciidoc manual, section 1, and honestly? she's a little niche but she serves. this is the girl who runs conformance tests 💖

✨ NAME ✨

testasciidoc — like, run the AsciiDoc conformance tests that are specified in a configuration file. that's the whole gig. no cap.

🦋 SYNOPSIS 🦋

testasciidoc [OPTIONS] COMMAND

🌸 DESCRIPTION 🌸

so the testasciidoc command runs AsciiDoc conformance tests specified in a configuration file. yes, that's literally it. she tests. she conforms. she's an icon. 👑

🎀 COMMANDS 🎀

the testasciidoc toolset has three different commands, and honestly the way they divvy up the work is giving organized:

testasciidoc list
testasciidoc run [-n, --number NUMBER] [-b, --backend BACKEND] [OPTIONS]
testasciidoc update [-n, --number NUMBER] [-b, --backend BACKEND] [OPTIONS]

here's what each one does, bestie:

  • list — list all the available test cases. window shopping fr.
  • run — execute the tests: regenerate the temporary test cases and compare them to the reference files. the actual vibe check. 🔥
  • update — regenerate and update the test data reference files. ⚠️ you need to launch this at least once to even have the reference files to compare against during the tests. like, you can't compare to nothing, babe.

and where:

  • NUMBER — the index number of the test case, straight from the testasciidoc list command. iykyk.
  • BACKEND — the asciidoc backend to use. ✨
  • OPTIONS — the options listed below, duh 💅

💜 OPTIONS 💜

  • -f, --conf-file=CONF_FILE — use the configuration file CONF_FILE. for more info about the configuration file format, refer to the tests documentation 🫶
  • --force — update all test data, overwriting existing data. no mercy, no survivors 💀

🌈 EXAMPLES 🌈

  • testasciidoc list — lists all the test actions available for running or updating ✨
  • testasciidoc run — runs all the testing actions available. go off, queen 🔥
  • testasciidoc run --number 1 --backend html5 --conf-file=/etc/asciidoc/testasciidoc.conf — run the test case 1 for the html5 asciidoc backend using the configuration file /etc/asciidoc/testasciidoc.conf
  • testasciidoc update --number 1 --backend html5 — generate or update the reference files used for the tests cases' 1st action of the html5 asciidoc backend

⭐ EXIT STATUS ⭐

  • 0 — success 🎉 slay
  • 1 — failure. and she's not subtle about it: syntax or usage error; configuration error; document processing failure; unexpected error 😭

🙈 BUGS 🙈

see the AsciiDoc distribution BUGS file. yes, there's a whole file. she's aware of her flaws, ok.

🧚 AUTHOR 🧚

AsciiDoc was originally written by Stuart Rackham. many people have contributed to it 💖

🍓 RESOURCES 🍓

👑 SEE ALSO 👑

asciidoc(1), a2x(1)

okay that's the whole page, bestie 🌸 this edition is dated 07/17/2024 and it's the testasciidoc(1) page from the AsciiDoc distribution — go forth and conformance-test responsibly, mwah 💅💖

📦 where this page comes from