feat(rules): attach documentation URL

Closes #166

rules/ad-hoc-sub-process.js

@@ -3,6 +3,11 @@ const {
   isAny
 } = require('bpmnlint-utils');
 
+const {
+  annotateRule
+} = require('./helper');
+
+
 /**
  * A rule that ensures that an Ad Hoc Sub Process is valid according to the BPMN spec:
  *
@@ -40,8 +45,8 @@ module.exports = function() {
     });
   }
 
-  return {
+  return annotateRule('ad-hoc-sub-process', {
     check
-  };
+  });
 
 };

rules/conditional-flows.js

@@ -1,3 +1,8 @@
+const {
+  annotateRule
+} = require('./helper');
+
+
 /**
  * A rule that checks that sequence flows outgoing from a
  * conditional forking gateway or activity are
@@ -27,9 +32,9 @@ module.exports = function() {
     });
   }
 
-  return {
+  return annotateRule('conditional-flows', {
     check
-  };
+  });
 
 };
 

rules/end-event-required.js

@@ -3,6 +3,10 @@ const {
   isAny
 } = require('bpmnlint-utils');
 
+const {
+  annotateRule
+} = require('./helper');
+
 
 /**
  * A rule that checks the presence of an end event per scope.
@@ -35,5 +39,7 @@ module.exports = function() {
     }
   }
 
-  return { check };
+  return annotateRule('end-event-required', {
+    check
+  });
 };

rules/event-sub-process-typed-start-event.js

@@ -2,6 +2,11 @@ const {
   is
 } = require('bpmnlint-utils');
 
+const {
+  annotateRule
+} = require('./helper');
+
+
 /**
  * A rule that checks that start events inside an event sub-process
  * are typed.
@@ -32,8 +37,8 @@ module.exports = function() {
     });
   }
 
-  return {
+  return annotateRule('event-sub-process-typed-start-event', {
     check
-  };
+  });
 
 };

rules/fake-join.js

@@ -2,6 +2,11 @@ const {
   isAny
 } = require('bpmnlint-utils');
 
+const {
+  annotateRule
+} = require('./helper');
+
+
 /**
  * A rule that checks that no fake join is modeled by attempting
  * to give a task or event join semantics.
@@ -29,8 +34,8 @@ module.exports = function() {
     }
   }
 
-  return {
+  return annotateRule('fake-join', {
     check
-  };
+  });
 
 };

rules/global.js

@@ -3,6 +3,10 @@ const {
   isAny
 } = require('bpmnlint-utils');
 
+const {
+  annotateRule
+} = require('./helper');
+
 
 /**
  * A rule that verifies that global elements are properly used.
@@ -50,9 +54,9 @@ module.exports = function() {
 
   }
 
-  return {
+  return annotateRule('global', {
     check
-  };
+  });
 
   // helpers /////////////////////////////
 

rules/helper.js

@@ -6,6 +6,7 @@ const {
  * @typedef { import('../lib/types.js').ModdleElement } ModdleElement
  *
  * @typedef { import('../lib/types.js').RuleFactory } RuleFactory
+ * @typedef { import('../lib/types.js').RuleDefinition } RuleDefinition
  */
 
 
@@ -16,7 +17,7 @@ const {
  *
  * @return { RuleFactory } ruleFactory
  */
-function disallowNodeType(type) {
+function disallowNodeType(type, ruleName) {
 
   /**
    * @type { RuleFactory }
@@ -30,9 +31,9 @@ function disallowNodeType(type) {
       }
     }
 
-    return {
+    return annotateRule(ruleName, {
       check
-    };
+    });
 
   };
 
@@ -67,4 +68,41 @@ function findParent(node, type) {
   return findParent(parent, type);
 }
 
-module.exports.findParent = findParent;
+module.exports.findParent = findParent;
+
+
+const documentationBaseUrl = 'https://github.com/bpmn-io/bpmnlint/blob/main/docs/rules';
+
+/**
+ * Annotate a rule with core information, such as the documentation url.
+ *
+ * @param {string} ruleName
+ * @param {RuleDefinition} options
+ *
+ * @return {RuleDefinition}
+ */
+function annotateRule(ruleName, options) {
+
+  const {
+    meta: {
+      documentation = {},
+      ...restMeta
+    } = {},
+    ...restOptions
+  } = options;
+
+  const documentationUrl = `${documentationBaseUrl}/${ruleName}.md`;
+
+  return {
+    meta: {
+      documentation: {
+        url: documentationUrl,
+        ...documentation
+      },
+      ...restMeta
+    },
+    ...restOptions
+  };
+}
+
+module.exports.annotateRule = annotateRule;

rules/label-required.js

@@ -3,6 +3,10 @@ const {
   isAny
 } = require('bpmnlint-utils');
 
+const {
+  annotateRule
+} = require('./helper');
+
 
 /**
  * A rule that checks the presence of a label.
@@ -53,7 +57,9 @@ module.exports = function() {
     }
   }
 
-  return { check };
+  return annotateRule('label-required', {
+    check
+  });
 };
 
 

rules/link-event.js

@@ -6,6 +6,10 @@ const {
   is
 } = require('bpmnlint-utils');
 
+const {
+  annotateRule
+} = require('./helper');
+
 
 /**
  * A rule that verifies that link events are properly used.
@@ -71,9 +75,9 @@ module.exports = function() {
 
   }
 
-  return {
+  return annotateRule('link-event', {
     check
-  };
+  });
 };
 
 

rules/no-bpmndi.js

@@ -6,10 +6,15 @@ const {
   flatten
 } = require('min-dash');
 
+const {
+  annotateRule
+} = require('./helper');
+
 /**
  * @typedef { import('../lib/types.js').ModdleElement } ModdleElement
  */
 
+
 /**
  * A rule that checks that there is no BPMNDI information missing for elements,
  * which require BPMNDI.
@@ -41,9 +46,9 @@ module.exports = function() {
     });
   }
 
-  return {
+  return annotateRule('no-bpmndi', {
     check
-  };
+  });
 
 };
 

rules/no-complex-gateway.js

@@ -1,3 +1,3 @@
 const disallowNodeType = require('./helper').disallowNodeType;
 
-module.exports = disallowNodeType('bpmn:ComplexGateway');
+module.exports = disallowNodeType('bpmn:ComplexGateway', 'no-complex-gateway');

rules/no-disconnected.js

@@ -3,6 +3,10 @@ const {
   is
 } = require('bpmnlint-utils');
 
+const {
+  annotateRule
+} = require('./helper');
+
 
 /**
  * A rule that verifies that there exists no disconnected
@@ -38,9 +42,9 @@ module.exports = function() {
     }
   }
 
-  return {
+  return annotateRule('no-disconnected', {
     check
-  };
+  });
 };
 
 

rules/no-duplicate-sequence-flows.js

@@ -2,6 +2,11 @@ const {
   is
 } = require('bpmnlint-utils');
 
+const {
+  annotateRule
+} = require('./helper');
+
+
 /**
  * A rule that verifies that there are no disconnected
  * flow elements, i.e. elements without incoming or outgoing sequence flows.
@@ -45,9 +50,9 @@ module.exports = function() {
     }
   }
 
-  return {
+  return annotateRule('no-duplicate-sequence-flows', {
     check
-  };
+  });
 
 };
 

rules/no-gateway-join-fork.js

@@ -2,6 +2,10 @@ const {
   is
 } = require('bpmnlint-utils');
 
+const {
+  annotateRule
+} = require('./helper');
+
 
 /**
  * A rule that checks, whether a gateway forks and joins
@@ -25,8 +29,8 @@ module.exports = function() {
     }
   }
 
-  return {
+  return annotateRule('no-gateway-fork-join', {
     check
-  };
+  });
 
 };

rules/no-implicit-end.js

@@ -4,9 +4,11 @@ const {
 } = require('bpmnlint-utils');
 
 const {
-  findParent
+  findParent,
+  annotateRule
 } = require('./helper');
 
+
 /**
  * A rule that checks that an element is not an implicit end (token sink).
  *
@@ -87,5 +89,7 @@ module.exports = function() {
     }
   }
 
-  return { check };
+  return annotateRule('no-implicit-end', {
+    check
+  });
 };