AsciiDoc-report usecase not well enough separated from AsciiDoc-rule usecase

32 views
Skip to first unread message

Gernot Bragenheim

unread,
Sep 26, 2024, 3:32:56 AM9/26/24
to jQAssistant
I did some testing and debugging and learned a few things
  •  AsciiDoc in jQA is used for two completely different usecases
    • providing rules (realised via jQA core)
    • creating a report (realised via jQA asciidoc-report-plugin)
=> I just became aware of the very disjunctness of these two usecases. Before I was even tempted to think, AsciiDoc has since jQA 2.0 been entirely excluded from the core

  •  AsciidocReportPlugin.end() only builds a report if rules "come from" an adoc file
    • you have to specify at least one rule exclusively within the adoc file. If provided outside (.yml now / maven back in the days) - even if additionally - the adoc does not become a "ruleSource", "filteredRuleSources" stay empty and "Calling for the Asciidoctor..." never happens.
=> I think, this might come from a similiar misconception as I had in terms of the disjunctness of previously described usecases

If you want to use AsciiDoc entirely in a report way, this feels very unintuitive. I might have all my rules specified in xml or a plugin and my entire configuration setup to execute those without an asciidoc report already. Now I just want to add an asciidoc-report additionally to show all my results but it simply won't render.

I would like to suggest to decouple the AsciiDoc-report-usecase better from the AsciiDoc-rule-Usecase with following change:
  •  If asciidoc-report-plugin is used and an adoc-file is detected (matching the given filters, default 'all') it will always get rendered (admittedly not quite sure though how to act on several adoc-files)

Rule-detection stays untouched by that and continues to work as before.
Reply all
Reply to author
Forward
0 new messages