bpmnlint - npm Package Compare versions

Comparing version 1.0.0-alpha2 to 1.0.0-alpha3

package.json

 {
   "name": "bpmnlint",
-  "version": "1.0.0-alpha2",
+  "version": "1.0.0-alpha3",
   "main": "index.js",
@@ -5,0 +5,0 @@ "repository": "https://github.com/siffogh/bpmnlint/",

README.md

@@ -42,10 +42,53 @@ # bpmnlint
 
+These values can be specified in an implicit or explicit way.
 
+> **Note:** bpmnlint comes with a list of built-in rules: label-required, start-event-required, and end-event-required.
 
-### Consuming Rules
-To consume built-in rules, it is enough to mention the rule name in the bpmnlint configuration
-file. 
+### Implicit Configuration
+If the specified value for a rule is a number, it will hold the rule status flag: 
+- 0: the rule is off
+- 1: problems reported by the rule are considered as warnings
+- 2: problems reported by the rule are considerd as errors
 
-Available built-in rules: label-required, start-event-required, and end-event-required.
+```json
+{
+  "label-required": 1
+}
+```
 
-### Adding Custom Rules 
+bpmnlint will then look for the rule first in the built-in rules. 
+If not found, bpmnlint will look for the rule in the npm packages installed as **bpmn-**rule-name (e.g. bpmn-no-implicit-parallel-gateway).
+
+> **Important: ** if you're referring to a non built-in rule, make sure to have it installed as an npm dependency.
+
+### Explicit Configuration
+If the specified value for a rule is an object, it will hold the following information: 
+- path to the the rule.
+- flag: rule status flag
+
+```json
+{
+  "bpmnlint-some-custom-rule": { 
+    "path": "some/local/path/bpmnlint-some-custom-rule", 
+    "flag": 2
+  }
+}
+```
+
+### Adding Custom Rules 
+> **Important:** The rule needs to have a suffix of 'bpmnlint-'.
+
+Custom rules can be added in two ways:
+
+#### As an NPM Module
+Please check out the example of [no-implicit-parallel-gateway](https://github.com/siffogh/bpmnlint-no-implicit-parallel-gateway)
+
+#### As a Local Module
+```json
+{
+  "bpmnlint-some-custom-rule": { 
+    "path": "some/local/path/bpmnlint-some-custom-rule", 
+    "flag": 2
+  }
+}
+```

No alert changes

Improved metrics

Total package byte prevSize

237715

increased by0.51%

Number of lines in readme file

93

increased by86%

Worsened metrics

Number of package files

17

decreased by-5.56%

No dependency changes