This repository contains plugins for buschmais' jQAssistant.
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
asciidoc
checkstyle
config
cpp
doc/architecture
findbugs
git
gradle
jacoco
javaparser
jqassistant
linecount
plaintext
plantuml
pmd
.gitignore
.travis.yml
LICENSE
README.md
build.gradle
gradlew
gradlew.bat
settings.gradle

README.md

jqassistant-plugins

This repository contains plugins for buschmais' jQAssistant.

How to install

  • add jQAssistant to dependencies in your project (and jgit if git processing is desired).

  • declare additional dependencies in your project:

    • groupId de.kontext-e.jqassistant.plugin
    • artifactId jqassistant.plugin.checkstyle or .findbugs or .jacoco or .git or .pmd
    • e.g. for gradle: runtime("de.kontext-e.jqassistant.plugin:jqassistant.plugin.checkstyle:1.3.3")
  • you may want to configure some properties in jqassistant.properties or as system property (java -Dpropertyname=propertyvalue):

    • jqassistant.plugin.checkstyle.basepackage=de.kontext_e.jqassistant.plugin
    • jqassistant.plugin.findbugs.filename=findbugs.xml
    • jqassistant.plugin.jacoco.filename=jacoco.xml
    • jqassistant.plugin.pmd.filename=pmd.xml
    • jqassistant.plugin.git.range= - a valid git range if not the complete history should be imported -
  • execute jQAssistant tasks

  • If you want to add the git plugins to your jQAssistant downloaded commandline installation you currently have to manually add the an org.eclipse.jgit jar file to the plugins directory of jqassistant: Use at least version 4.8.0.201706111038-r from Maven Central.

Some docs

From master branch. Note: most recent versions from branches may differ.

Latest Changes

Release 1.4.1

  • FindBugs plugin also reads new SpotBugs format (tested with SpotBugs 3.1.3)
  • AsciiDoc plugin: relations renamed: HAS_HEADER -> HAS_HEADER_ROW, HAS_BODY -> HAS_ROW, HAS_FOOTER -> HAS_FOOTER_ROW
  • AsciiDoc plugin: new rownumber property for :Row nodes
  • AsciiDoc plugin: new relation OF_COLUMN from Cell nodes to the column they belong to
  • Experimental JavaParser plugin: #58 replaced deprecated GraphDatabaseService by Cypher queries
  • #59 Plugins shall migrate existing file nodes instead of creating new ones

Release 1.4.0

  • Relation names changed, see this blog post for details
  • Use jQAssistant 1.4

Release 1.3.3

  • #52 git plugin: protect against multiple scans of the same repo
  • #53 PlantUML: scan sequence diagrams
  • #54 Try javaparser project to scan also Java sources
  • #55 Asciidoc plugin: import also attributes on tables, sections, and lists
  • #56 Asciidoc: document an example for defining labels for types matched by regular expressions in tables; see issue 56
  • #57 PlantUML: Add stereotype property

Release 1.3.2

  • #46 Git Plugin: enhanced the graph of a git repository
  • #47 guarded item.getFile() by path.endsWith("/HEAD") to speed up scanning
  • #48 For contributors: raised language level to 1.8
  • #49 Git Plugin: Add also properties committer, shortMessage, and encoding to GitCommit

Release 1.3.1

  • PlantUML plugin supports Component Diagrams

Release 1.3.0

  • Update to jQAssistant 1.3.0
  • Update to jgit 4.8.0.201706111038-r
  • Speedup Git "git:CurrentBranch" (thanks Dirk Mahler)
  • Added label "Git" to git repository node (thanks Dirk Mahler)

Work in progress

  • PlantUML class diagram packages; please note: although the plantuml plugin is version 1.1.x, it is far from a complete PlantUML import; in fact, only the packages of class diagrams were imported for now because this is the only thing that is currently needed for architecture rules

Coming later

  • Jenkins
  • More ideas? Feel free to add Issues

Continuous Build

Build Status