bpmnlint 8.1.0 → 8.2.0

package/README.md

@@ -37,7 +37,7 @@ Validate your diagrams via the commandline:
 
 Our [documentation](https://github.com/bpmn-io/bpmnlint/tree/master/docs/rules#rules) lists all currenty implemented rules, the [`./rules` folder](https://github.com/bpmn-io/bpmnlint/tree/master/rules) contains each rules implementation.
 
-Do you miss a rule that should be included? [Propose a new rule](https://github.com/bpmn-io/bpmnlint/issues/new?template=NEW_RULE.md).
+Do you miss a rule that should be included? [Propose a new rule](https://github.com/bpmn-io/bpmnlint/issues/new?assignees=&labels=rules&template=NEW_RULE.md).
 
 
 ## Configuration
@@ -62,6 +62,63 @@ Add or customize rules using the `rules` block:
 ```
 
 
+## API
+
+Invoke the tool directly from [NodeJS](https://nodejs.org/en):
+
+```javascript
+import Linter from 'bpmnlint';
+import NodeResolver from 'bpmnlint/lib/resolver/node-resolver';
+
+import BpmnModdle from 'bpmn-moddle';
+
+const linter = new Linter({ 
+  config: {
+    extends: 'bpmnlint:recommended'
+  },
+  resolver: new NodeResolver()
+});
+
+const xmlStr = `
+  <?xml version="1.0" encoding="UTF-8"?>
+  <bpmn:definitions xmlns:bpmn="http://www.omg.org/spec/BPMN/20100524/MODEL" 
+                     id="definitions" 
+                     targetNamespace="http://bpmn.io/schema/bpmn">
+    <bpmn:process id="process" />
+  </bpmn:definitions>
+`;
+
+const {
+  rootElement: definitions
+} = await moddle.fromXML(xmlStr);
+
+const reports = linter.lint(definitions);
+
+// {
+//    "end-event-required": [
+//      {
+//        "id": "process",
+//        "message": "Process is missing end event"
+//      }
+//    ],
+//    ...
+// }
+```
+
+For browser usage include your [linting configuration](#configuration) using your favorite bundler plug-in ([Rollup](https://www.npmjs.com/package/rollup-plugin-bpmnlint), [Webpack](https://www.npmjs.com/package/bpmnlint-loader)).
+
+
+## Writing a Plug-in
+
+Create your first plug-in using the [plugin creator](https://github.com/nikku/create-bpmnlint-plugin):
+
+```sh
+npm init bpmnlint-plugin {PLUGIN_NAME}
+```
+
+Checkout the [bpmnlint-plugin-example](https://github.com/bpmn-io/bpmnlint-plugin-example) for details on how to define, test, and consume custom lint rules. Use the [bpmnlint playground](https://github.com/bpmn-io/bpmnlint-playground) to implement new rules with quick visual feedback.
+
+
 ## Visual Feedback
 
 Integrate the linter via [bpmn-js-bpmnlint](https://github.com/bpmn-io/bpmn-js-bpmnlint) into [bpmn-js](https://github.com/bpmn-io/bpmn-js) and get direct feedback during modeling.
@@ -69,13 +126,12 @@ Integrate the linter via [bpmn-js-bpmnlint](https://github.com/bpmn-io/bpmn-js-b
 To try out visual validation, checkout the [bpmnlint playground](https://github.com/bpmn-io/bpmnlint-playground).
 
 
-## Writing / Consuming Custom Rules
-
-Use the [bpmnlint playground](https://github.com/bpmn-io/bpmnlint-playground) to implement new rules with quick visual feedback.
-
-Create your first plug-in using the [plugin creator](https://github.com/nikku/create-bpmnlint-plugin).
+## Related
 
-Checkout the [bpmnlint-plugin-example](https://github.com/bpmn-io/bpmnlint-plugin-example) for details on how to define, test, and consume custom lint rules.
+* [bpmnlint-plugin-example](https://github.com/bpmn-io/bpmnlint-plugin-example) - an example plug-in
+* [bpmnlint-playground](https://github.com/bpmn-io/bpmnlint-playground) - a playground to implement new rules with quick visual feedback
+* [bpmnlint-generate-docs-images](https://github.com/bpmn-io/bpmnlint-generate-docs-images) - Generate images for your bpmnlint documentation
+* [bpmn-js-bpmnlint](https://github.com/bpmn-io/bpmn-js-bpmnlint) - integration into [bpmn-js](https://github.com/bpmn-io/bpmn-js)
 
 
 ## License

package/config/recommended.js

@@ -16,6 +16,6 @@ module.exports = {
     'single-event-definition': 'error',
     'start-event-required': 'error',
     'sub-process-blank-start-event': 'error',
-    'superfluous-gateway': 'warning'
+    'superfluous-gateway': 'warn'
   }
 };

package/lib/linter.js

@@ -3,7 +3,8 @@ const testRule = require('./test-rule');
 const categoryMap = {
   0: 'off',
   1: 'warn',
-  2: 'error'
+  2: 'error',
+  3: 'info'
 };
 
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "bpmnlint",
   "description": "Validate your BPMN diagrams based on configurable lint rules",
-  "version": "8.1.0",
+  "version": "8.2.0",
   "main": "lib/index.js",
   "keywords": [
     "bpmnlint",
@@ -31,7 +31,8 @@
     "lint": "eslint .",
     "dev": "npm test -- --watch",
     "test": "mocha -r esm --exclude 'test/integration/cli/**' 'test/**/*.js'",
-    "test-coverage": "nyc --reporter=lcov --reporter=html npm test"
+    "test-coverage": "nyc --reporter=lcov --reporter=html npm test",
+    "generate-docs-images": "npx @bpmn-io/bpmnlint-generate-docs-images ."
   },
   "bin": {
     "bpmnlint": "./bin/bpmnlint.js"