deploy: d9c32d6

jQAssistant · Aug 1, 2024 · a10d215 · a10d215
1 parent 99968f4
commit a10d215
Show file tree

Hide file tree

Showing 3 changed files with 141 additions and 14 deletions.
diff --git a/current/images/jqa.jpg b/current/images/jqa.jpg
diff --git a/current/index.html b/current/index.html
@@ -4,7 +4,7 @@
 <meta charset="UTF-8"/>
 <meta http-equiv="X-UA-Compatible" content="IE=edge"/>
 <meta name="viewport" content="width=device-width, initial-scale=1.0"/>
-<meta name="generator" content="Asciidoctor 2.0.18"/>
+<meta name="generator" content="Asciidoctor 2.0.20"/>
 <meta name="author" content="jQAssistant &lt;[email protected]&gt; @jqassistant"/>
 <title>jQAssistant User Manual</title>
 <style>
@@ -2183,7 +2183,7 @@ <h4 id="_explore">Explore</h4>
 <div class="ulist">
 <ul>
 <li>
-<p>Open a browser and navigate to <a href="http://localhost:7474">http://localhost:7474</a></p>
+<p>Open a browser and navigate to <a href="http://localhost:7474/?dbms=bolt://localhost:7687&amp;preselectAuthMethod=NO_AUTH">http://localhost:7474/?dbms=bolt://localhost:7687&amp;preselectAuthMethod=NO_AUTH</a> (see also <a href="#open-browser">Tip: Open browser when starting embedded server</a>)</p>
 </li>
 <li>
 <p>Enter the following query in the top level area and hit Ctrl-Enter:</p>
@@ -2228,7 +2228,7 @@ <h4 id="_add_the_plugin">Add the plugin</h4>
 <pre class="CodeRay highlight"><code data-lang="xml"><span class="tag">&lt;project&gt;</span>
     <span class="tag">&lt;properties&gt;</span>
         <span class="comment">&lt;!-- Define your desired jQAssistant version here --&gt;</span>
-        <span class="tag">&lt;jqassistant.version&gt;</span>2.4.0-SNAPSHOT<span class="tag">&lt;/jqassistant.version&gt;</span>
+        <span class="tag">&lt;jqassistant.version&gt;</span>2.4.0-RC1<span class="tag">&lt;/jqassistant.version&gt;</span>
     <span class="tag">&lt;/properties&gt;</span>
     <span class="tag">&lt;build&gt;</span>
         <span class="tag">&lt;plugins&gt;</span>
@@ -2316,7 +2316,7 @@ <h4 id="_explore_your_application">Explore your application</h4>
 <div class="ulist">
 <ul>
 <li>
-<p>Open a browser and navigate to <a href="http://localhost:7474">http://localhost:7474</a></p>
+<p>Open a browser and navigate to <a href="http://localhost:7474/?dbms=bolt://localhost:7687&amp;preselectAuthMethod=NO_AUTH">http://localhost:7474/?dbms=bolt://localhost:7687&amp;preselectAuthMethod=NO_AUTH</a> (see also <a href="#open-browser">Tip: Open browser when starting embedded server</a>)</p>
 </li>
 <li>
 <p>Enter the follwoing query in the top level area and hit Ctrl-Enter:</p>
@@ -2334,6 +2334,29 @@ <h4 id="_explore_your_application">Explore your application</h4>
 LIMIT 20</code></pre>
 </div>
 </div>
+<div id="open-browser" class="admonitionblock tip">
+<table>
+<tr>
+<td class="icon">
+<div class="title">Tip</div>
+</td>
+<td class="content">
+<div class="paragraph">
+<p>The embedded server by default is started to listen by default on URI <code>bolt://localhost:7687</code> without authentication.
+jQAssistant can open the Neo4j browser in your desktop browser automatically when running the server by activating <code>jqassistant.server.open-browser</code>, e.g. by using a <code>jqassistant.yml</code> in your home directory:</p>
+</div>
+<div class="listingblock">
+<div class="title">~/.jqassistant.yml</div>
+<div class="content">
+<pre class="CodeRay highlight"><code data-lang="yaml"><span class="key">jqassistant</span>:
+  <span class="key">server</span>:
+    <span class="key">open-browser</span>: <span class="string"><span class="content">true</span></span></code></pre>
+</div>
+</div>
+</td>
+</tr>
+</table>
+</div>
 </div>
 </div>
 </div>
@@ -2405,7 +2428,7 @@ <h3 id="_rules">3.3. Rules</h3>
 <div class="content">
 <pre class="CodeRay highlight"><code data-lang="xml"><span class="tag">&lt;jqassistant-rules</span> <span class="attribute-name">xmlns</span>=<span class="string"><span class="delimiter">&quot;</span><span class="content">http://schema.jqassistant.org/rule/v2.2</span><span class="delimiter">&quot;</span></span>
                    <span class="attribute-name">xmlns:xsi</span>=<span class="string"><span class="delimiter">&quot;</span><span class="content">http://www.w3.org/2001/XMLSchema-instance</span><span class="delimiter">&quot;</span></span>
-                   <span class="attribute-name">xsi:schemaLocation</span>=<span class="string"><span class="delimiter">&quot;</span><span class="content">http://schema.jqassistant.org/rule/v2.2 https://schema.jqassistant.org/rule/jqassistant-rule-v2.2.xsd</span><span class="delimiter">&quot;</span></span><span class="tag">&gt;</span>
+                   <span class="attribute-name">xsi:schemaLocation</span>=<span class="string"><span class="delimiter">&quot;</span><span class="content">http://schema.jqassistant.org/rule/v2.2 https://jqassistant.github.io/jqassistant/current/schema/jqassistant-rule-v2.2.xsd</span><span class="delimiter">&quot;</span></span><span class="tag">&gt;</span>
 
     <span class="tag">&lt;group</span> <span class="attribute-name">id</span>=<span class="string"><span class="delimiter">&quot;</span><span class="content">default</span><span class="delimiter">&quot;</span></span><span class="tag">&gt;</span>
         <span class="tag">&lt;includeConstraint</span> <span class="attribute-name">refId</span>=<span class="string"><span class="delimiter">&quot;</span><span class="content">my-rules:MyConstraint</span><span class="delimiter">&quot;</span></span><span class="tag">/&gt;</span>
@@ -2459,6 +2482,18 @@ <h3 id="_rules">3.3. Rules</h3>
 <span class="tag">&lt;/jqassistant-rules&gt;</span></code></pre>
 </div>
 </div>
+<div class="admonitionblock note">
+<table>
+<tr>
+<td class="icon">
+<div class="title">Note</div>
+</td>
+<td class="content">
+The rule XML schema is available <a href="https://jqassistant.github.io/jqassistant/snapshot/schema/jqassistant-rule-v2.2.xsd">online</a> and should be picked automatically for code completion by your IDE.
+</td>
+</tr>
+</table>
+</div>
 <div class="paragraph">
 <p>Each rule comes with an unique id (e.g. "my-rules:MyConstraint") which can be referenced by other rules. jQAssistant will take care about executing the rules in
 the correct order. Furthermore a human readable description shall help developers to understand the rationale behind them.</p>
@@ -2631,7 +2666,7 @@ <h4 id="_rule_dependencies">Rule Dependencies</h4>
 <div class="content">
 <pre class="CodeRay highlight"><code data-lang="xml"><span class="tag">&lt;jqassistant-rules</span> <span class="attribute-name">xmlns</span>=<span class="string"><span class="delimiter">&quot;</span><span class="content">http://schema.jqassistant.org/rule/v2.2</span><span class="delimiter">&quot;</span></span>
                    <span class="attribute-name">xmlns:xsi</span>=<span class="string"><span class="delimiter">&quot;</span><span class="content">http://www.w3.org/2001/XMLSchema-instance</span><span class="delimiter">&quot;</span></span>
-                   <span class="attribute-name">xsi:schemaLocation</span>=<span class="string"><span class="delimiter">&quot;</span><span class="content">http://schema.jqassistant.org/rule/v2.2 https://schema.jqassistant.org/rule/jqassistant-rule-v2.2.xsd</span><span class="delimiter">&quot;</span></span><span class="tag">&gt;</span>
+                   <span class="attribute-name">xsi:schemaLocation</span>=<span class="string"><span class="delimiter">&quot;</span><span class="content">http://schema.jqassistant.org/rule/v2.2 https://jqassistant.github.io/jqassistant/current/schema/jqassistant-rule-v2.2.xsd</span><span class="delimiter">&quot;</span></span><span class="tag">&gt;</span>
 
     <span class="tag">&lt;group</span> <span class="attribute-name">id</span>=<span class="string"><span class="delimiter">&quot;</span><span class="content">default</span><span class="delimiter">&quot;</span></span><span class="tag">&gt;</span>
         <span class="tag">&lt;includeConcept</span> <span class="attribute-name">refId</span>=<span class="string"><span class="delimiter">&quot;</span><span class="content">plugin1:ConcreteConcept</span><span class="delimiter">&quot;</span></span><span class="tag">&gt;</span>
@@ -2679,9 +2714,9 @@ <h4 id="_severity_of_rules">Severity Of Rules</h4>
 <div class="listingblock">
 <div class="title">my-rules.xml</div>
 <div class="content">
-<pre class="CodeRay highlight"><code data-lang="xml"><span class="tag">&lt;jqassistant-rules</span> <span class="attribute-name">xmlns</span>=<span class="string"><span class="delimiter">&quot;</span><span class="content">http://schema.jqassistant.org/rule/v1.8</span><span class="delimiter">&quot;</span></span>
+<pre class="CodeRay highlight"><code data-lang="xml"><span class="tag">&lt;jqassistant-rules</span> <span class="attribute-name">xmlns</span>=<span class="string"><span class="delimiter">&quot;</span><span class="content">http://schema.jqassistant.org/rule/v2.2</span><span class="delimiter">&quot;</span></span>
                    <span class="attribute-name">xmlns:xsi</span>=<span class="string"><span class="delimiter">&quot;</span><span class="content">http://www.w3.org/2001/XMLSchema-instance</span><span class="delimiter">&quot;</span></span>
-                   <span class="attribute-name">xsi:schemaLocation</span>=<span class="string"><span class="delimiter">&quot;</span><span class="content">http://schema.jqassistant.org/rule/v1.8 https://schema.jqassistant.org/rule/jqassistant-rule-v1.8.xsd</span><span class="delimiter">&quot;</span></span><span class="tag">&gt;</span>
+                   <span class="attribute-name">xsi:schemaLocation</span>=<span class="string"><span class="delimiter">&quot;</span><span class="content">http://schema.jqassistant.org/rule/v1.8 https://jqassistant.github.io/jqassistant/current/schema/jqassistant-rule-v2.2.xsd</span><span class="delimiter">&quot;</span></span><span class="tag">&gt;</span>
 
     <span class="tag">&lt;group</span> <span class="attribute-name">id</span>=<span class="string"><span class="delimiter">&quot;</span><span class="content">my-rules:MyGroup</span><span class="delimiter">&quot;</span></span> <span class="attribute-name">severity</span>=<span class="string"><span class="delimiter">&quot;</span><span class="content">blocker</span><span class="delimiter">&quot;</span></span><span class="tag">&gt;</span>
         <span class="tag">&lt;includeConstraint</span> <span class="attribute-name">refId</span>=<span class="string"><span class="delimiter">&quot;</span><span class="content">my-rules:MyConstraint1</span><span class="delimiter">&quot;</span></span><span class="tag">/&gt;</span>
@@ -2799,7 +2834,7 @@ <h4 id="_rule_parameters">Rule Parameters</h4>
 <div class="content">
 <pre class="CodeRay highlight"><code data-lang="xml"><span class="tag">&lt;jqassistant-rules</span> <span class="attribute-name">xmlns</span>=<span class="string"><span class="delimiter">&quot;</span><span class="content">http://schema.jqassistant.org/rule/v1.8</span><span class="delimiter">&quot;</span></span>
                    <span class="attribute-name">xmlns:xsi</span>=<span class="string"><span class="delimiter">&quot;</span><span class="content">http://www.w3.org/2001/XMLSchema-instance</span><span class="delimiter">&quot;</span></span>
-                   <span class="attribute-name">xsi:schemaLocation</span>=<span class="string"><span class="delimiter">&quot;</span><span class="content">http://schema.jqassistant.org/rule/v1.8 https://schema.jqassistant.org/rule/jqassistant-rule-v1.8.xsd</span><span class="delimiter">&quot;</span></span><span class="tag">&gt;</span>
+                   <span class="attribute-name">xsi:schemaLocation</span>=<span class="string"><span class="delimiter">&quot;</span><span class="content">http://schema.jqassistant.org/rule/v1.8 https://jqassistant.github.io/jqassistant/current/schema/jqassistant-rule-v2.2.xsd</span><span class="delimiter">&quot;</span></span><span class="tag">&gt;</span>
 
     <span class="tag">&lt;concept</span> <span class="attribute-name">id</span>=<span class="string"><span class="delimiter">&quot;</span><span class="content">my-rules:ApplicationRootPackage</span><span class="delimiter">&quot;</span></span><span class="tag">&gt;</span>
         <span class="tag">&lt;requiresParameter</span> <span class="attribute-name">name</span>=<span class="string"><span class="delimiter">&quot;</span><span class="content">rootPackage</span><span class="delimiter">&quot;</span></span> <span class="attribute-name">type</span>=<span class="string"><span class="delimiter">&quot;</span><span class="content">String</span><span class="delimiter">&quot;</span></span> <span class="attribute-name">defaultValue</span>=<span class="string"><span class="delimiter">&quot;</span><span class="content">com.buschmais</span><span class="delimiter">&quot;</span></span><span class="tag">/&gt;</span> <b class="conum">(1)</b>
@@ -3553,7 +3588,7 @@ <h3 id="_plugin_configuration">5.3. Plugin Configuration</h3>
 <div class="title">Tip</div>
 </td>
 <td class="content">
-Maven properties (e.g. <code>project.basedir</code>) or user properties defined in <code>pom.xml</code> or <code>settings.xml</code> files can be referenced in <code>.jqassistant.yml</code> files by using the <code>${&#8230;&#8203;}</code> syntax, e.g. <code>/home/runner/work/jqassistant/jqassistant/maven/src/main</code>.
+Maven properties (e.g. <code>project.basedir</code>) or user properties defined in <code>pom.xml</code> or <code>settings.xml</code> files can be referenced in <code>.jqassistant.yml</code> files by using the <code>${&#8230;&#8203;}</code> syntax, e.g. <code>/home/runner/work/jqassistant/jqassistant/target/checkout/maven/src/main</code>.
 </td>
 </tr>
 </table>
@@ -3594,7 +3629,7 @@ <h3 id="_plugin_configuration">5.3. Plugin Configuration</h3>
                         <span class="tag">&lt;configuration&gt;</span>
                             <span class="comment">&lt;!--
                             &lt;configurationLocations&gt;
-                                &lt;configurationLocation&gt;/home/runner/work/jqassistant/jqassistant/maven/.jqassistant.yml&lt;/configurationLocation&gt;
+                                &lt;configurationLocation&gt;/home/runner/work/jqassistant/jqassistant/target/checkout/maven/.jqassistant.yml&lt;/configurationLocation&gt;
                             &lt;/configurationLocations&gt;
                             &lt;yaml&gt;
                                 jqassistant:
@@ -4187,7 +4222,20 @@ <h3 id="_yaml_files">6.1. YAML files</h3>
     <span class="comment"># The execution time [seconds] for rules (concepts/constraints) to show a warning. Can be used as a hint for optimization.</span>
     <span class="comment">#</span>
     <span class="comment"># -Djqassistant.analyze.warn-on-rule-execution-time-seconds</span>
-    <span class="key">warn-on-rule-execution-time-seconds</span>: <span class="string"><span class="content">5</span></span></code></pre>
+    <span class="key">warn-on-rule-execution-time-seconds</span>: <span class="string"><span class="content">5</span></span>
+
+<span class="comment"># The embedded server configuration</span>
+  <span class="key">server</span>:
+
+    <span class="comment"># Determines whether the shall be ran as daemon. If set to false (default) then &lt;Enter&gt; must be pressed to stop the server, otherwise the process keeps running until it is killed.</span>
+    <span class="comment">#</span>
+    <span class="comment"># -Djqassistant.server.daemon: true|false</span>
+    <span class="key">daemon</span>: <span class="string"><span class="content">false</span></span>
+
+    <span class="comment"># Open the desktop browser when running the embedded server</span>
+    <span class="comment">#</span>
+    <span class="comment"># -Djqassistant.server.open-browser: true|false</span>
+    <span class="key">open-browser</span>: <span class="string"><span class="content">false</span></span></code></pre>
 </div>
 </div>
 </div>
@@ -6091,7 +6139,7 @@ <h4 id="_jqasuppress">@jQASuppress</h4>
 <pre class="CodeRay highlight"><code data-lang="xml"><span class="tag">&lt;dependency&gt;</span>
   <span class="tag">&lt;groupId&gt;</span>com.buschmais.jqassistant<span class="tag">&lt;/groupId&gt;</span>
   <span class="tag">&lt;artifactId&gt;</span>manual<span class="tag">&lt;/artifactId&gt;</span>
-  <span class="tag">&lt;version&gt;</span>2.4.0-SNAPSHOT<span class="tag">&lt;/version&gt;</span>
+  <span class="tag">&lt;version&gt;</span>2.4.0-RC1<span class="tag">&lt;/version&gt;</span>
   <span class="tag">&lt;scope&gt;</span>provided<span class="tag">&lt;/scope&gt;</span>
 <span class="tag">&lt;/dependency&gt;</span></code></pre>
 </div>
@@ -11583,7 +11631,7 @@ <h4 id="XsdFileScanner">7.5.3. Generic scanner for XSD files</h4>
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2024-07-26 09:15:44 UTC
+Last updated 2024-08-01 07:00:31 UTC
 </div>
 </div>
 </body>

diff --git a/current/schema/jqassistant-plugin-v2.4.xsd b/current/schema/jqassistant-plugin-v2.4.xsd
@@ -0,0 +1,79 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
+           xmlns:tns="http://schema.jqassistant.org/plugin/v2.4"
+           targetNamespace="http://schema.jqassistant.org/plugin/v2.4"
+           elementFormDefault="qualified">
+
+    <xs:element name="jqassistant-plugin">
+        <xs:complexType>
+            <xs:sequence>
+                <xs:element name="description" type="xs:string"/>
+                <xs:element name="model" type="tns:ClassListType" minOccurs="0"/>
+                <xs:element name="scope" type="tns:ClassListType" minOccurs="0"/>
+                <!-- deprecated: the scanner element will no longer support the id attribute -->
+                <xs:element name="scanner" type="tns:IdClassListType" minOccurs="0"/>
+                <xs:element name="rules" type="tns:RulesType" minOccurs="0"/>
+                <xs:element name="ruleParser" type="tns:IdClassListType" minOccurs="0"/>
+                <xs:element name="ruleInterpreter" type="tns:IdClassListType" minOccurs="0"/>
+                <xs:element name="report" type="tns:IdClassListType" minOccurs="0"/>
+            </xs:sequence>
+            <xs:attribute name="name" type="xs:string" use="required"/>
+            <xs:attribute name="version" type="xs:string"/>
+
+            <!--
+             ! In a later version of jQAssistant, the id attribute will
+             ! be mandatory.
+             ! Oliver B. Fischer, 2021-04-22
+             !-->
+            <xs:attribute name="id" use="optional">
+                <xs:annotation>
+                    <xs:documentation>
+                        The id attribute of a plugin contains the unique identifier
+                        of the plugin, which is used by jQAssistant
+                        to refer to the plugin during the configuration of jQAssistant.
+
+                        The id of a plugin must be unique among all plugins jQAssistant
+                        loads during the startup. Therefore it is recommended
+                        to use the first characters of the id for a namespace
+                        similar prefix followed by a dot.
+
+                        For example, all plugins provided by jQAssitant
+                        itself, will use the prefix "jqa.".
+                    </xs:documentation>
+                </xs:annotation>
+                <xs:simpleType>
+                    <xs:restriction base="xs:string">
+                        <xs:pattern value="[a-z][a-z0-9\.]+"/>
+                    </xs:restriction>
+                </xs:simpleType>
+            </xs:attribute>
+        </xs:complexType>
+    </xs:element>
+
+    <xs:complexType name="ClassListType">
+        <xs:sequence>
+            <xs:element name="class" type="xs:string" maxOccurs="unbounded"/>
+        </xs:sequence>
+    </xs:complexType>
+
+    <xs:complexType name="IdClassListType">
+        <xs:sequence>
+            <xs:element name="class" type="tns:IdClassType" maxOccurs="unbounded"/>
+        </xs:sequence>
+    </xs:complexType>
+
+    <xs:complexType name="RulesType">
+        <xs:sequence>
+            <xs:element name="resource" type="xs:string" maxOccurs="unbounded"/>
+        </xs:sequence>
+    </xs:complexType>
+
+    <xs:complexType name="IdClassType">
+        <xs:simpleContent>
+            <xs:extension base="xs:string">
+                <xs:attribute name="id" type="xs:string"/>
+            </xs:extension>
+        </xs:simpleContent>
+    </xs:complexType>
+
+</xs:schema>