Skip to content

Welcome to jQAssistant 🚀

jQAssistant is an Open-Source-Tool that helps you to analyze and control the quality of your software systems. It is centered around three main use cases:

  • Easily carry out Software Analytics to gain insights into your software systems
  • Continuously verify the correct implementation of targeted design and architecture using provided or user-defined rules to reach defined quality goals
  • Automatically enable Living Documentation by generating documentation from the code and validating documentation against the implementation to avoid the documentation-code-gap and confusion

Out-of-the-box, it brings first class support for Maven-Java-based applications including a bunch of default scanners for most used formats like JSON and YAML and default rules for jUnit. With its plugin-based architecture, it can support a multitude of technologies, frameworks and architectural concepts. And if the provided plug-ins are not enough, it is easy to create your own.

Typical technolgoies that are supported by jQAssistant as of now are shown in the visualization below. Note that the technology support may be provided by additional plug-ins from the GitHub organizations listed in section About the organization.

The jQAssistant lifecycle

The main aspect for working with jQAssistant is to understand how it is working internally. While this is described in detail in several How-Tos and the official manual (as linked in Further Information), the high-level overview is shown in below visualization. Mainly, the jQAssistant lifecycle is split into three phases:

  • Scan - jQAssistant scans the configured resources such as source/byte code, XML configuration files, Maven build- and dependency-information or documentation artifacts into a Neo4j graph database which is delivered as part of the jQAssistant distribution.
  • Analyze - jQAssistant analyses the structures in the database by executing so called concepts (enrich the graph with additional information) and constraints (validate structures in the graph). These are either defined project-specific by the user or are distributed via plugins. Reports are created containing the constraint violations (returned rows of constraints) and concept results (e.g. enriched/updated data or graphical representations).
  • Server - jQAssistant starts the Neo4j graph database and makes its UI available at http://localhost:7474. This allows the user to develop concepts and constraints or carry out software analytics.

About the organization

This GitHub organization is the main entry point for jQAssistant.

However, we created a universe around it with the following two GitHub organizations to make your life easier:

  1. jQAssistant Plugin provides a collection of useful extensions to jQAssistant such as scanners for additional formats, rule sets for frameworks and technologies, and means to report results as e.g. AsciiDoc or rendered PlantUML diagrams.
  2. jQAssistant Tutorials gives an overview of potential use cases including description on how to set them up in your environment. We recommend that every (new) user takes a look at it and be inspired.
  3. jQAssistant Tooling offers integrations for jQAssistant into other tools such as AsciidoctorJ or SonarQube.
  4. jQAssistant Archive contains the history of plugins that were either deprecated and discontinued from ongoing development or plugins that were moved in the context of the jQAssistant 2.0 migration. For the latter case, the old development stat (<2.0.0) can be found in the archive, the newer state in the Plugin organization.

Quick Start

Command Line Distribution

  • The latest command line distribution is available on Maven Central, select bin.zip from the Download menu.
  • Download and unpack the distribution, a directory jqassistant-commandline-distribution-_version_ will be created.
  • Run a scan using bin\jqassistant.cmd scan -f lib (Windows) or bin/jqassistant.sh scan -f lib (Linux)
  • Start the embedded server using bin\jqassistant.cmd server (Windows) or bin/jqassistant.sh server (Linux) and open the URL https://localhost:7474 in your browser
  • Start exploring using the Neo4j browser!
  • Read the jQAssistant Tutorials and the User Manual for further information

Maven

  • Add the jQAssistant Maven plugin to your pom.xml:
<project>
    <build>
        <plugins>
            <plugin>
                <groupId>com.buschmais.jqassistant</groupId>
                <artifactId>jqassistant-maven-plugin</artifactId>
                <version>2.0.x</version>
                <executions>
                    <execution>
                        <goals>
                            <goal>scan</goal>
                            <goal>analyze</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>
</project>
  • Run mvn verify
  • Start the embedded server using mvn jqassistant:server and open the URL https://localhost:7474 in your browser
  • Start exploring using the Neo4j browser!
  • Read the jQAssistant Tutorials and the User Manual for further information

Way of contribution

We're happy about every contribution. To make this as efficient as possible, take a look at the following guidance:

  • Issues should have a meaningful description, best with an example for reproduction. If possible to identify, put the issue into the repository of the part (e.g. core, a plugin, an example) where the issue occurred. This saves us a lot of time.
    • We're happy to accept pull requests that solve the issue.
  • Feature Requests should have a meaningful description, best with an example. If possible to identify, put the feature request into the repository of the part (e.g. core, a plugin, an example) where you expect the feature to be. This saves us a lot of time.
    • We're happy to accept pull requests that implement the request.

We also provide an Idea Hub for all your great ideas and to host discussions around jQAssistant at Idea-Hub.

For any other topics, feel free to Contact Us

Further Information

Pinned Loading

  1. Idea-Hub Idea-Hub Public

    Hub to propose and discuss new ideas, features, as well as general issues

  2. jqassistant jqassistant Public

    Your Software. Your Structures. Your Rules.

    Java 190 33

Repositories

Showing 4 of 4 repositories
  • jqassistant Public

    Your Software. Your Structures. Your Rules.

    jQAssistant/jqassistant’s past year of commit activity
    Java 190 GPL-3.0 33 63 1 Updated Jul 13, 2024
  • jqassistant-build Public

    Provides build related infrastructure and IDE configurations

    jQAssistant/jqassistant-build’s past year of commit activity
    XSLT 0 GPL-3.0 0 0 0 Updated Jul 10, 2024
  • .github Public
    jQAssistant/.github’s past year of commit activity
    0 1 0 0 Updated Mar 13, 2024
  • Idea-Hub Public

    Hub to propose and discuss new ideas, features, as well as general issues

    jQAssistant/Idea-Hub’s past year of commit activity
    0 0 7 0 Updated Jun 28, 2023

Top languages

Java XSLT

Most used topics

Loading…