@camunda/linting 3.27.1 → 3.28.0

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2022-present Camunda Services GmbH
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2022-present Camunda Services GmbH
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,75 +1,75 @@
-# @camunda/linting
-
-[![CI](https://github.com/camunda/linting/actions/workflows/CI.yml/badge.svg)](https://github.com/camunda/linting/actions/workflows/CI.yml)
-
-The BPMN linter used by the Camunda Desktop and Web Modeler. Batteries included. 🔋
-
-## Features
-
-* bundles [bpmnlint](https://github.com/bpmn-io/bpmnlint) and [bpmnlint-plugin-camunda-compat](https://github.com/camunda/bpmnlint-plugin-camunda-compat/)
-* configures linter based on `modeler:executionPlatform` and `modeler:executionPlatformVersion`
-* creates error messages to be shown in desktop and web modeler
-* creates errors to be shown in properties panel
-* creates error overlays to be shown on canvas 
-
-## Usage
-
-```javascript
-import Modeler from 'bpmn-js/lib/Modeler';
-
-import { Linter } from '@camunda/linting';
-
-import lintingModule from '@camunda/linting/modeler';
-
-import '@camunda/linting/assets/linting.css';
-
-const modeler = new Modeler({
-  additionalModules: [
-    lintingModule
-  ]
-});
-
-// configure to be used with desktop or web modeler
-const linter = new Linter({
-  modeler: 'web', // `desktop` or `web` modeler, defaults to `desktop`
-  type: 'cloud' // `cloud` or `platform` diagrams, defaults to `cloud`
-});
-
-// lint by passing definitions
-const reports = await linter.lint(definitions);
-
-// or passing XML
-const reports = await linter.lint(xml);
-
-...
-
-// update errors on canvas and in properties panel (requires bpmn-js-properties-panel >= 1.3.0)
-modeler.get('linting').setErrors(reports);
-
-// show error by selecting element and properties panel entry
-modeler.get('linting').showError(report);
-
-// activate and deactivate errors on canvas
-modeler.get('linting').activate();
-modeler.get('linting').deactivate();
-```
-
-## Development
-
-```sh
-# install
-npm i
-
-# run tests
-npm t
-
-# run tests in watch mode
-npm run test:watch
-
-# run example
-npm start
-```
-
-## License
-
-MIT
+# @camunda/linting
+
+[![CI](https://github.com/camunda/linting/actions/workflows/CI.yml/badge.svg)](https://github.com/camunda/linting/actions/workflows/CI.yml)
+
+The BPMN linter used by the Camunda Desktop and Web Modeler. Batteries included. 🔋
+
+## Features
+
+* bundles [bpmnlint](https://github.com/bpmn-io/bpmnlint) and [bpmnlint-plugin-camunda-compat](https://github.com/camunda/bpmnlint-plugin-camunda-compat/)
+* configures linter based on `modeler:executionPlatform` and `modeler:executionPlatformVersion`
+* creates error messages to be shown in desktop and web modeler
+* creates errors to be shown in properties panel
+* creates error overlays to be shown on canvas 
+
+## Usage
+
+```javascript
+import Modeler from 'bpmn-js/lib/Modeler';
+
+import { Linter } from '@camunda/linting';
+
+import lintingModule from '@camunda/linting/modeler';
+
+import '@camunda/linting/assets/linting.css';
+
+const modeler = new Modeler({
+  additionalModules: [
+    lintingModule
+  ]
+});
+
+// configure to be used with desktop or web modeler
+const linter = new Linter({
+  modeler: 'web', // `desktop` or `web` modeler, defaults to `desktop`
+  type: 'cloud' // `cloud` or `platform` diagrams, defaults to `cloud`
+});
+
+// lint by passing definitions
+const reports = await linter.lint(definitions);
+
+// or passing XML
+const reports = await linter.lint(xml);
+
+...
+
+// update errors on canvas and in properties panel (requires bpmn-js-properties-panel >= 1.3.0)
+modeler.get('linting').setErrors(reports);
+
+// show error by selecting element and properties panel entry
+modeler.get('linting').showError(report);
+
+// activate and deactivate errors on canvas
+modeler.get('linting').activate();
+modeler.get('linting').deactivate();
+```
+
+## Development
+
+```sh
+# install
+npm i
+
+# run tests
+npm t
+
+# run tests in watch mode
+npm run test:watch
+
+# run example
+npm start
+```
+
+## License
+
+MIT

package/assets/linting.css

@@ -1,38 +1,38 @@
-:root {
-  --cl-color-white: hsl(0, 0%, 100%);
-
-  --cl-color-info: #0f62fe;
-  --cl-color-warning: #ff832b;
-  --cl-color-error: #da1e26;
-  --cl-color-success: #52b415;
-}
-
-.cl-icon, .cl-icon * {
-  box-sizing: border-box;
-}
-
-.cl-icon {
-  --icon-color: white;
-  --icon-bg-color: #333;
-  background: var(--icon-bg-color);
-  color: var(--icon-color);
-  border-radius: 100%;
-  height: 20px;
-  width: 20px;
-  border: solid 4px var(--icon-bg-color);
-  display: flex;
-  align-items: center;
-  justify-content: center;
-}
-
-.cl-icon-error {
-  --icon-bg-color: var(--cl-color-error);
-}
-
-.cl-icon-warn {
-  --icon-bg-color: var(--cl-color-warning);
-}
-
-.cl-icon-info {
-  --icon-bg-color: var(--cl-color-info);
+:root {
+  --cl-color-white: hsl(0, 0%, 100%);
+
+  --cl-color-info: #0f62fe;
+  --cl-color-warning: #ff832b;
+  --cl-color-error: #da1e26;
+  --cl-color-success: #52b415;
+}
+
+.cl-icon, .cl-icon * {
+  box-sizing: border-box;
+}
+
+.cl-icon {
+  --icon-color: white;
+  --icon-bg-color: #333;
+  background: var(--icon-bg-color);
+  color: var(--icon-color);
+  border-radius: 100%;
+  height: 20px;
+  width: 20px;
+  border: solid 4px var(--icon-bg-color);
+  display: flex;
+  align-items: center;
+  justify-content: center;
+}
+
+.cl-icon-error {
+  --icon-bg-color: var(--cl-color-error);
+}
+
+.cl-icon-warn {
+  --icon-bg-color: var(--cl-color-warning);
+}
+
+.cl-icon-info {
+  --icon-bg-color: var(--cl-color-info);
 }

package/lib/Resolver.js

@@ -1,31 +1,31 @@
-export default class NestedResolver {
-  constructor(resolvers) {
-    this.resolvers = resolvers.slice().reverse();
-  }
-
-  resolveRule(pkg, ruleName) {
-    for (const resolver of this.resolvers) {
-      try {
-        return resolver.resolveRule(pkg, ruleName);
-      } catch (err) {
-
-        // ignore
-      }
-    }
-
-    throw new Error(`unknown rule <${ pkg }/${ ruleName }>`);
-  }
-
-  resolveConfig(pkg, configName) {
-    for (const resolver of this.resolvers) {
-      try {
-        return resolver.resolveConfig(pkg, configName);
-      } catch (err) {
-
-        // ignore
-      }
-    }
-
-    throw new Error(`unknown config <${ pkg }/${ configName }>`);
-  }
-}
+export default class NestedResolver {
+  constructor(resolvers) {
+    this.resolvers = resolvers.slice().reverse();
+  }
+
+  resolveRule(pkg, ruleName) {
+    for (const resolver of this.resolvers) {
+      try {
+        return resolver.resolveRule(pkg, ruleName);
+      } catch (err) {
+
+        // ignore
+      }
+    }
+
+    throw new Error(`unknown rule <${ pkg }/${ ruleName }>`);
+  }
+
+  resolveConfig(pkg, configName) {
+    for (const resolver of this.resolvers) {
+      try {
+        return resolver.resolveConfig(pkg, configName);
+      } catch (err) {
+
+        // ignore
+      }
+    }
+
+    throw new Error(`unknown config <${ pkg }/${ configName }>`);
+  }
+}

package/lib/compiled-config.js

@@ -73,7 +73,8 @@ const rules = {
   "camunda-compat/user-task-definition": "warn",
   "camunda-compat/user-task-form": "error",
   "camunda-compat/version-tag": "error",
-  "camunda-compat/wait-for-completion": "error"
+  "camunda-compat/wait-for-completion": "error",
+  "camunda-compat/zeebe-user-task": "error"
 };
 
 const config = {
@@ -267,4 +268,8 @@ cache['bpmnlint-plugin-camunda-compat/version-tag'] = rule_43;
 
 import rule_44 from 'bpmnlint-plugin-camunda-compat/rules/camunda-cloud/wait-for-completion';
 
-cache['bpmnlint-plugin-camunda-compat/wait-for-completion'] = rule_44;
+cache['bpmnlint-plugin-camunda-compat/wait-for-completion'] = rule_44;
+
+import rule_45 from 'bpmnlint-plugin-camunda-compat/rules/camunda-cloud/zeebe-user-task';
+
+cache['bpmnlint-plugin-camunda-compat/zeebe-user-task'] = rule_45;

package/lib/modeler/Linting.js

@@ -1,124 +1,124 @@
-import { getBusinessObject, is } from 'bpmn-js/lib/util/ModelUtil';
-
-import { getErrors } from '../utils/properties-panel';
-
-export default class Linting {
-  constructor(canvas, config, elementRegistry, eventBus, lintingAnnotations, selection) {
-    this._canvas = canvas;
-    this._elementRegistry = elementRegistry;
-    this._eventBus = eventBus;
-    this._lintingAnnotations = lintingAnnotations;
-    this._selection = selection;
-
-    this._active = config && config.active || false;
-    this._reports = [];
-
-    eventBus.on('selection.changed', () => this._update());
-
-    eventBus.on('lintingAnnotations.click', ({ report }) => this.showError(report));
-  }
-
-  showError(report) {
-    const {
-      id,
-      propertiesPanel = {}
-    } = report;
-
-    const selectableElement = this._getSelectableElement(id);
-
-    if (selectableElement) {
-      this._canvas.scrollToElement(selectableElement);
-
-      if (selectableElement === this._canvas.getRootElement()) {
-        this._selection.select();
-      } else {
-        this._selection.select(selectableElement);
-      }
-    }
-
-    const { entryIds = [] } = propertiesPanel;
-
-    // TODO(philippfromme): remove timeout once properties panel is fixed
-    setTimeout(() => {
-      this._eventBus.fire('propertiesPanel.showEntry', {
-        id: entryIds[ Math.max(0, entryIds.length - 1) ]
-      });
-    });
-  }
-
-  setErrors(reports) {
-    this._reports = reports;
-
-    this._update();
-  }
-
-  activate() {
-    this._active = true;
-
-    this._update();
-  }
-
-  deactivate() {
-    this._active = false;
-
-    this._update();
-  }
-
-  isActive() {
-    return this._active;
-  }
-
-  _update() {
-
-    // set annotations
-    this._lintingAnnotations.setErrors(this.isActive() ? this._reports : []);
-
-    // set properties panel errors
-    const selectedElement = this._getSelectedElement();
-
-    this._eventBus.fire('propertiesPanel.setErrors', {
-      errors: getErrors(this._reports, selectedElement)
-    });
-  }
-
-  _getSelectableElement(id) {
-    let element = this._elementRegistry.get(id);
-
-    if (!element) {
-      element = this._elementRegistry.filter(element => {
-        return is(element, 'bpmn:Participant') && getBusinessObject(element).get('processRef').get('id') === id;
-      })[ 0 ];
-    }
-
-    return element;
-  }
-
-  _getSelectedElement() {
-    const selection = this._selection.get();
-
-    if (!selection || !selection.length) {
-      return this._canvas.getRootElement();
-    }
-
-    const selectedElement = selection[ 0 ];
-
-    if (isLabel(selectedElement)) {
-      return selectedElement.labelTarget;
-    }
-
-    return selectedElement;
-  }
-}
-
-Linting.$inject = [
-  'canvas',
-  'config.linting',
-  'elementRegistry',
-  'eventBus',
-  'lintingAnnotations',
-  'selection'
-];
-
-function isLabel(element) {
-  return !!element.labelTarget;
-}
+import { getBusinessObject, is } from 'bpmn-js/lib/util/ModelUtil';
+
+import { getErrors } from '../utils/properties-panel';
+
+export default class Linting {
+  constructor(canvas, config, elementRegistry, eventBus, lintingAnnotations, selection) {
+    this._canvas = canvas;
+    this._elementRegistry = elementRegistry;
+    this._eventBus = eventBus;
+    this._lintingAnnotations = lintingAnnotations;
+    this._selection = selection;
+
+    this._active = config && config.active || false;
+    this._reports = [];
+
+    eventBus.on('selection.changed', () => this._update());
+
+    eventBus.on('lintingAnnotations.click', ({ report }) => this.showError(report));
+  }
+
+  showError(report) {
+    const {
+      id,
+      propertiesPanel = {}
+    } = report;
+
+    const selectableElement = this._getSelectableElement(id);
+
+    if (selectableElement) {
+      this._canvas.scrollToElement(selectableElement);
+
+      if (selectableElement === this._canvas.getRootElement()) {
+        this._selection.select();
+      } else {
+        this._selection.select(selectableElement);
+      }
+    }
+
+    const { entryIds = [] } = propertiesPanel;
+
+    // TODO(philippfromme): remove timeout once properties panel is fixed
+    setTimeout(() => {
+      this._eventBus.fire('propertiesPanel.showEntry', {
+        id: entryIds[ Math.max(0, entryIds.length - 1) ]
+      });
+    });
+  }
+
+  setErrors(reports) {
+    this._reports = reports;
+
+    this._update();
+  }
+
+  activate() {
+    this._active = true;
+
+    this._update();
+  }
+
+  deactivate() {
+    this._active = false;
+
+    this._update();
+  }
+
+  isActive() {
+    return this._active;
+  }
+
+  _update() {
+
+    // set annotations
+    this._lintingAnnotations.setErrors(this.isActive() ? this._reports : []);
+
+    // set properties panel errors
+    const selectedElement = this._getSelectedElement();
+
+    this._eventBus.fire('propertiesPanel.setErrors', {
+      errors: getErrors(this._reports, selectedElement)
+    });
+  }
+
+  _getSelectableElement(id) {
+    let element = this._elementRegistry.get(id);
+
+    if (!element) {
+      element = this._elementRegistry.filter(element => {
+        return is(element, 'bpmn:Participant') && getBusinessObject(element).get('processRef').get('id') === id;
+      })[ 0 ];
+    }
+
+    return element;
+  }
+
+  _getSelectedElement() {
+    const selection = this._selection.get();
+
+    if (!selection || !selection.length) {
+      return this._canvas.getRootElement();
+    }
+
+    const selectedElement = selection[ 0 ];
+
+    if (isLabel(selectedElement)) {
+      return selectedElement.labelTarget;
+    }
+
+    return selectedElement;
+  }
+}
+
+Linting.$inject = [
+  'canvas',
+  'config.linting',
+  'elementRegistry',
+  'eventBus',
+  'lintingAnnotations',
+  'selection'
+];
+
+function isLabel(element) {
+  return !!element.labelTarget;
+}