chore(linting): read documentation url from rule metadata

Closes #4491
camunda · Feb 20, 2025 · 05d6802 · 05d6802
1 parent 4f72aef
commit 05d6802
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 4 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -9,6 +9,7 @@ ___Note:__ Yet to be released changes appear here._
 ### General
 
 * `FEAT`: support Camunda 8.8
+* `FEAT`: recognize documentation URLs provided via lint rules ([#4491](https://github.com/camunda/camunda-modeler/issues/4491))
 * `DEPS`: update to `@camunda/improved-canvas@1.7.6`
 * `DEPS`: update to `@camunda/linting@3.32.1`
 

diff --git a/client/src/app/panel/tabs/linting/LintingTab.js b/client/src/app/panel/tabs/linting/LintingTab.js
@@ -91,7 +91,7 @@ function LintingTabItem(props) {
 
   const {
     category,
-    documentation = {},
+    meta,
     message,
     rule
   } = report;
@@ -109,7 +109,7 @@ function LintingTabItem(props) {
     </div>;
   }
 
-  const { url: documentationUrl = null } = documentation;
+  const documentationUrl = meta?.documentation?.url;
   const reportName = getReportName(report);
 
   return <div

diff --git a/client/src/app/panel/tabs/linting/__tests__/LintingTabSpec.js b/client/src/app/panel/tabs/linting/__tests__/LintingTabSpec.js
@@ -55,8 +55,10 @@ describe('<LintingTab>', function() {
           name: 'Foo',
           message: 'Foo message',
           rule: 'foo-rule',
-          documentation: {
-            url: 'https://foo.bar'
+          meta: {
+            documentation: {
+              url: 'https://foo.bar'
+            }
           }
         }
       ]