jQAssistant命令行无法生成Asciidoc HTML文件的问题咨询及配置文档疑问

Hey there! Let's work through your jQAssistant issues one by one:

Fixing the Missing Asciidoc Report #

It sounds like you're missing a couple of key configuration steps to get the Asciidoc report working. Here's what to check:

1. Enable the Asciidoctor Report Plugin
   jQAssistant doesn't load the Asciidoctor plugin by default. You need to declare it in your .jqassistant.yml configuration file (create this file in your project root if it doesn't exist):

   plugins:
     - name: asciidoctor-report
       version: <your-jqassistant-version> # Match this to your core jQAssistant version, e.g., 2.0.0
   

   Make sure the plugin version matches the version of jQAssistant you're using to avoid compatibility issues.

2. Configure Report Sources and Targets
   Add a report section to .jqassistant.yml to tell jQAssistant where your Asciidoc source lives and where to output the final HTML:

   report:
     asciidoctor:
       source: ./jqassistant/index.adoc
       target: ./jqassistant/reports/asciidoc/
   

   This ensures the report command knows to process your custom index.adoc file.

3. Verify Command Execution Flow
   Stick to this exact order of commands to ensure all data is available for the report:

   • Scan your JAR first: ./bin/jqassistant.sh scan -f path/to/your/project.jar
   • Run analysis to populate rule results: ./bin/jqassistant.sh analyze
   • Generate the report explicitly (you can specify the format to be safe): ./bin/jqassistant.sh report -f asciidoctor

4. Check Your Asciidoc Tags
   Your index.adoc uses // tag::default[] and // end::default[]—these are placeholders where jQAssistant injects rule results. Make sure the analyze step is actually running the rules associated with that tag (if you're using default rules, this should happen automatically, but double-check that no custom rule filters are blocking them).

Finding Clear Docs for CLI Params and .jqassistant.yml #

You're not alone in wanting clearer docs here—here are the best ways to get the info you need:

• CLI Command Details: Run ./bin/jqassistant.sh help to see all top-level commands. For each subcommand, add --help (e.g., ./bin/jqassistant.sh scan --help or ./bin/jqassistant.sh report --help) to get a full breakdown of available flags, arguments, and descriptions.
• .jqassistant.yml Reference: The official docs cover all configuration options, but you can also find well-commented example configs in the jQAssistant GitHub repository. Additionally, running ./bin/jqassistant.sh help config will give you a quick overview of core configuration sections.

内容的提问来源于stack exchange，提问作者Pebbz