2

Love the idea behind this tool, but I'm struggling with the documentation.

I am trying to generate a report of jar files using the commandline.

When I run ./bin/jqassistant.sh:

  • scan, I see the generated associated neo4j store
  • analyze produces jqassistant/reports/jqassistant-report.xml
  • report produces jqassistant-report.html

Now I'm trying to create asciidoc files as described here: https://101.jqassistant.org/generate-reports-about-structures-and-metrics/index.html

I've placed an index.adoc file in jqassistant folder, but I do not see any corresponding html files generated in jqassistant/reports/asciidoc/

I'm new to jqassistant, so it's possible I am missing a configuration step, but I have a suspicion the asciidoc-report plugin is not being loaded.

Is there clear documentation on all the parameters to pass to commandline, including any configuration files such as .jqassisant.yml?

I created a file jqassistant/index.adoc

:toc: left
= My Project

// tag::default[]
[[default]]
== jQAssistant Rules

This section describes that default rules that are executed during each build.
// end::default[]

I ran /bin/jqassistant.sh analyze /bin/jqasisstant.sh report

I expected to see a file in jqassistant/report/asciidoc/index.html

Pebbz
  • 21
  • 1
  • Does your Asciidoc document contain any rules? If yes, do you see jQAssistant reporting the execution of your concepts and constraints? – Oliver Sep 09 '22 at 15:44
  • Is there a reason why you do not use the plugin for Maven? – Oliver Sep 09 '22 at 15:45
  • I have numerous repos and I don't want to integrate jqassistant (at this moment) into all of those projects. Since the commandline is provided, I want to use it. For testing tho, I did setup a simple helloworld maven project and created an index.adoc under jqassistant and see the maven plugin flow does generate what I expected. But I want to do the same thing via the commandline. Snooping through the source code, I see tests using jqassitant.yml files to pass in additional information, but no examples for analyze tag. Is there docs for the spec of this file? – Pebbz Sep 09 '22 at 16:11
  • I might have found the possible cause. I see in this repo that the default value for ruleDirectory in the asciiPlugin is set to null. https://github.com/jqassistant-contrib/jqassistant-asciidoc-report-plugin/blob/1.7/src/main/java/org/jqassistant/contrib/plugin/asciidocreport/AsciidocReportPlugin.java#L63 – Pebbz Sep 10 '22 at 02:17
  • I also see that when i run ./bin/jqassistant.sh report -p myvalues.props, the property object is being set properly in the commandline repo, but it's not being passed properly to the asciidoc plugin repo. I haven't traced down where it's getting lost tho. – Pebbz Sep 10 '22 at 02:18
  • Sorry for my silence. Can you put your example project on Github or does it contain sensitive data? – Oliver Sep 11 '22 at 21:57
  • No worries. Thanks for your support thus far. My code does contain sensitive data and also doesn't ultimately matter. I'm trying to import any jar file and create a report. I've created an example project here: github.com/pebbz/jqassistant-demo-report. Check out the latest commandline jar jqassistant.org/get-started, i'm using jqassistant-commandline-neo4jv3-1.12.0. I scan jqassistant's jar files. As you can see, the asciidoc report is not being generated. Hopefully it's a simple mistake on my side, but you can see it's generating the report/jqassistant-report.html, but asciidoc is empty. – Pebbz Sep 12 '22 at 16:03

0 Answers0