update rules doc

Author: ArtARTs36

docs/Builder/RulesPageBuilder.php

@@ -54,6 +54,7 @@ public function build(): string
                     'generic' => $param->type->isGeneric() ? JsonType::to($param->type->generic) : null,
                     'description' => $param->description,
                     'examples' => new Arrayee($param->examples),
+                    'isGenericObject' => $param->type->generic && class_exists($param->type->generic),
                 ];
             }
 

docs/Builder/templates/rules.md.twig

@@ -17,14 +17,14 @@ Currently is available that rules:
 {% else %}
 <td rowspan="{{ max(rule.params.count, 1) }}">{{ rule.description }}</td>
 <td>{{ rule.params.first.name }}</td>
-<td>{{ rule.params.first.description }} {% if rule.params.first.examples.count > 0 %}<br/> Examples: {% for example in rule.params.first.examples %} {{ example }}{% if loop.last == false %},{% endif%} {% endfor %}{% endif %}</td>
+<td>{{ rule.params.first.description }} {% if rule.params.first.isGenericObject %} <br/> See details in Config JSON Schema{% endif %}{% if rule.params.first.examples.count > 0 %}<br/> Examples: {% for example in rule.params.first.examples %} {{ example }}{% if loop.last == false %},{% endif%} {% endfor %}{% endif %}</td>
 <td>{{ rule.params.first.type }}{% if rule.params.first.generic %} of {{ rule.params.first.generic }}s {% endif %}</td>
 {% endif %}
 </tr>
 {% for param in rule.params.skip(1) %}
 <tr>
     <td>{{ param.name }}</td>
-    <td>{{ param.description }} {% if rule.params.first.examples.count > 0 %}<br/> Examples: {% for example in rule.params.first.examples %} {{ example }}{% if loop.last == false %},{% endif%} {% endfor %}{% endif %}</td>
+    <td>{{ param.description }} {% if rule.params.first.isGenericObject %} <br/> See details in Config JSON Schema{% endif %} {% if rule.params.first.examples.count > 0 %}<br/> Examples: {% for example in rule.params.first.examples %} {{ example }}{% if loop.last == false %},{% endif%} {% endfor %}{% endif %}</td>
     <td>{{ param.type }}{% if param.generic %} of {{ param.generic }}s {% endif %}</td>
 </tr>
 {% endfor %}

docs/rules.md

@@ -61,7 +61,7 @@ Currently is available that rules:
 </tr>
 <tr>
     <td>projectCode</td>
-    <td>Project code </td>
+    <td>Project code  </td>
     <td>string</td>
 </tr>
 <tr>
@@ -73,7 +73,7 @@ Currently is available that rules:
 </tr>
 <tr>
     <td>projectCode</td>
-    <td>Project code <br/> Examples:  &quot;yt.my-company.ru&quot; </td>
+    <td>Project code  <br/> Examples:  &quot;yt.my-company.ru&quot; </td>
     <td>string</td>
 </tr>
 <tr>
@@ -87,7 +87,7 @@ Currently is available that rules:
 <td rowspan="1">@mr-linter/has_changes</td>
 <td rowspan="1">Merge Request must have changes in {files}.</td>
 <td>changes</td>
-<td>Array of need changes </td>
+<td>Array of need changes  <br/> See details in Config JSON Schema</td>
 <td>array of objects </td>
 </tr>
 <tr>
@@ -120,7 +120,7 @@ Currently is available that rules:
 </tr>
 <tr>
     <td>tags</td>
-    <td>Tags parsing options </td>
+    <td>Tags parsing options  </td>
     <td>object</td>
 </tr>
 <tr>
@@ -132,7 +132,7 @@ Currently is available that rules:
 </tr>
 <tr>
     <td>fileLinesMax</td>
-    <td>Maximum allowed number of changed lines in a file </td>
+    <td>Maximum allowed number of changed lines in a file  </td>
     <td>integer</td>
 </tr>
 <tr>
@@ -150,4 +150,4 @@ Currently is available that rules:
 <td>array of strings </td>
 </tr>
 </tbody>
-</table>
+</t