bpmnlint 7.7.0 → 7.8.0

package/CHANGELOG.md

@@ -6,6 +6,11 @@ All notable changes to [bpmnlint](https://github.com/bpmn-io/bpmnlint) are docum
 
 ___Note:__ Yet to be released changes appear here._
 
+## 7.8.0
+
+* `FEAT`: be able to configure rules ([#82](https://github.com/bpmn-io/bpmnlint/pull/82))
+* `FEAT`: be able to configure rules when testing ([#83](https://github.com/bpmn-io/bpmnlint/pull/83))
+
 ## 7.7.0
 
 * `FEAT`: fuzzy test for equality of nodes when using `RuleTester#verify` ([#79](https://github.com/bpmn-io/bpmnlint/pull/79/files))

package/lib/linter.js

@@ -77,7 +77,7 @@ Linter.prototype.applyRule = function applyRule(moddleRoot, ruleDefinition) {
 };
 
 
-Linter.prototype.resolveRule = function(name) {
+Linter.prototype.resolveRule = function(name, config) {
 
   const {
     pkg,
@@ -98,7 +98,7 @@ Linter.prototype.resolveRule = function(name) {
       throw new Error(`unknown rule <${name}>`);
     }
 
-    const rule = this.cachedRules[id] = ruleFactory();
+    const rule = this.cachedRules[id] = ruleFactory(config);
 
     return rule;
   });
@@ -163,10 +163,11 @@ Linter.prototype.resolveRules = function(config) {
     const loaders = enabledRules.map((definition) => {
 
       const {
-        name
+        name,
+        config
       } = definition;
 
-      return this.resolveRule(name).then(function(rule) {
+      return this.resolveRule(name, config).then(function(rule) {
         return {
           ...definition,
           rule

package/lib/testers/rule-tester.js

@@ -14,11 +14,12 @@ function expectEqual(a, b) {
   assert.deepStrictEqual(JSON.stringify(a, replacer, 2), JSON.stringify(b, replacer, 2));
 }
 
-
 function verify(ruleName, rule, testCases) {
-  const linterConfig = {
-    rules: { [ruleName]: 2 }
-  };
+  function createLinterConfig(config = {}) {
+    return {
+      rules: { [ruleName]: [ 2, config ] }
+    };
+  }
 
   describe(`rules/${ruleName}`, function() {
 
@@ -33,13 +34,13 @@ function verify(ruleName, rule, testCases) {
 
     describe('should lint valid', function() {
 
-      testCases.valid.forEach(({ moddleElement, name, it: _it }, idx) => (
+      testCases.valid.forEach(({ config = {}, it: _it, moddleElement, name }, idx) => (
 
         (_it || it)(getTitle(idx, name), function() {
           return (
             Promise.resolve(moddleElement)
               .then(moddleRoot => {
-                return linter.lint(moddleRoot.root, linterConfig);
+                return linter.lint(moddleRoot.root, createLinterConfig(config));
               })
               .then(lintResults => {
                 expectEqual(lintResults, {});
@@ -54,7 +55,7 @@ function verify(ruleName, rule, testCases) {
 
     describe('should lint invalid', function() {
 
-      testCases.invalid.forEach(({ moddleElement, name, report, it: _it }, idx) => (
+      testCases.invalid.forEach(({ config = {}, it: _it, moddleElement, name, report }, idx) => (
 
         (_it || it)(getTitle(idx, name), function() {
 
@@ -78,7 +79,7 @@ function verify(ruleName, rule, testCases) {
           return (
             Promise.resolve(moddleElement)
               .then(moddleRoot => {
-                return linter.lint(moddleRoot.root, linterConfig);
+                return linter.lint(moddleRoot.root, createLinterConfig(config));
               })
               .then(lintResults => {
                 expectEqual(lintResults, expectedLintResults);
@@ -98,13 +99,6 @@ function getTitle(idx, name) {
   return `test case #${ idx + 1 }${ name ? ` ${ name }`: '' }`;
 }
 
-module.exports = {
-  expectEqual,
-  verify,
-  getTitle,
-  replacer
-};
-
 function replacer(_, value) {
   if (!value) {
     return value;
@@ -133,4 +127,11 @@ function replacer(_, value) {
   }
 
   return value;
-}
+}
+
+module.exports = {
+  expectEqual,
+  verify,
+  getTitle,
+  replacer
+};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "bpmnlint",
   "description": "Validate your BPMN diagrams based on configurable lint rules",
-  "version": "7.7.0",
+  "version": "7.8.0",
   "main": "lib/index.js",
   "keywords": [
     "bpmnlint",