@camunda/linting 3.37.0 → 3.38.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/Linter.js

@@ -1,203 +1,203 @@
-import BpmnModdle from 'bpmn-moddle';
-
-import { Linter as BpmnLinter } from 'bpmnlint';
-import StaticResolver from 'bpmnlint/lib/resolver/static-resolver';
-
-import Resolver from './Resolver';
-
-import { isString } from 'min-dash';
-
-import { resolver as RulesResolver } from './compiled-config';
-
-import modelerModdle from 'modeler-moddle/resources/modeler.json';
-import zeebeModdle from 'zeebe-bpmn-moddle/resources/zeebe.json';
-import camundaModdle from 'camunda-bpmn-moddle/resources/camunda.json';
-
-import { getErrorMessage } from './utils/error-messages';
-import { getEntryIds } from './utils/properties-panel';
-
-import { toSemverMinor } from './utils/version';
-
-import defaultPlugins from './plugins';
-
-import bpmnlintConfig from 'bpmnlint/config/correctness';
-
-const NoopResolver = new StaticResolver({});
-
-/**
- * @param {Object} [options]
- * @param {string} [options.modeler='desktop']
- * @param {Array<Object>} [options.plugins=[]]
- * @param {string} [options.type='cloud']
- */
-export class Linter {
-  constructor(options = {}) {
-    const {
-      modeler = 'desktop',
-      plugins = [],
-      type = 'cloud'
-    } = options;
-
-    this._moddle = new BpmnModdle({
-      modeler: modelerModdle,
-
-      // Zeebe and Camunda moddle extensions can't be used together
-      // cf. https://github.com/camunda/camunda-modeler/issues/3853#issuecomment-1731145100
-      ...(type === 'cloud' ?
-        { zeebe: zeebeModdle } :
-        { camunda: camundaModdle })
-    });
-
-    this._modeler = modeler;
-    this._plugins = [ ...defaultPlugins, ...plugins ];
-  }
-
-  async lint(contents) {
-    let rootElement;
-
-    if (isString(contents)) {
-      ({ rootElement } = await this._moddle.fromXML(contents));
-    } else {
-      rootElement = contents;
-    }
-
-    const executionPlatform = rootElement.get('modeler:executionPlatform'),
-          executionPlatformVersion = rootElement.get('modeler:executionPlatformVersion');
-
-    if (!executionPlatform || !executionPlatformVersion) {
-      return [];
-    }
-
-    const configName = getConfigName(executionPlatform, executionPlatformVersion);
-
-    const config = this._createConfig(configName);
-
-    const resolver = await this._createResolver(configName);
-
-    const linter = new BpmnLinter({
-      config,
-      resolver
-    });
-
-    const reportsByRule = await linter.lint(rootElement);
-
-    return Object.entries(reportsByRule).reduce((allReports, entry) => {
-      const [ rule, reports ] = entry;
-
-      return [
-        ...allReports,
-        ...reports.map(report => {
-          const entryIds = getEntryIds(report);
-
-          return {
-            ...report,
-            executionPlatform,
-            executionPlatformVersion,
-            message: getErrorMessage(
-              report,
-              executionPlatform,
-              executionPlatformVersion,
-              this._modeler
-            ),
-            propertiesPanel: {
-              entryIds
-            },
-            rule
-          };
-        })
-      ];
-    }, []);
-  }
-
-  _createConfig(configName) {
-    const configs = [
-      {
-        extends: `plugin:bpmnlint-plugin-camunda-compat/${ configName }`
-      },
-      {
-        extends: 'bpmnlint:correctness'
-      },
-      ...this._plugins.map(({ config = {} }) => config)
-    ];
-
-    return configs.reduce(
-      (config, _config) => {
-        let { extends: _extends = [], rules = {} } = _config;
-
-        if (isString(_extends)) {
-          _extends = [ _extends ];
-        }
-
-        return {
-          extends: [ ...config.extends, ..._extends ],
-          rules: {
-            ...config.rules,
-            ...rules
-          }
-        };
-      },
-      {
-        extends: [],
-        rules: {}
-      }
-    );
-  }
-
-  async _createResolver(configName) {
-    const { configs } = await import('bpmnlint-plugin-camunda-compat');
-
-    let { [ configName ]: config } = configs;
-
-    if (!config) {
-      config = {
-        rules: {}
-      };
-    }
-
-    config.rules = addConfig(config.rules, {
-      modeler: this._modeler
-    });
-
-    const ConfigResolver = new StaticResolver({
-      [ `config:bpmnlint-plugin-camunda-compat/${ configName }` ]: config,
-      'config:bpmnlint/correctness': bpmnlintConfig
-    });
-
-    return new Resolver([
-      ConfigResolver,
-      RulesResolver,
-      ...this._plugins.map(({ resolver = NoopResolver }) => resolver)
-    ]);
-  }
-}
-
-function getConfigName(executionPlatform, executionPlatformVersion) {
-  return [
-    ...executionPlatform.split(' ').map(toLowerCase),
-    ...toSemverMinor(executionPlatformVersion).split('.')
-  ].join('-');
-}
-
-function toLowerCase(string) {
-  return string.toLowerCase();
-}
-
-function addConfig(rules, configToAdd) {
-  let rulesWithConfig = {};
-
-  for (let name in rules) {
-    let type, config;
-
-    if (Array.isArray(rules[ name ])) {
-      type = rules[ name ][0];
-      config = rules[ name ][1] || {};
-    } else {
-      type = rules[ name ];
-      config = {};
-    }
-
-    rulesWithConfig[ name ] = [ type, { ...config, ...configToAdd } ];
-  }
-
-  return rulesWithConfig;
+import BpmnModdle from 'bpmn-moddle';
+
+import { Linter as BpmnLinter } from 'bpmnlint';
+import StaticResolver from 'bpmnlint/lib/resolver/static-resolver';
+
+import Resolver from './Resolver';
+
+import { isString } from 'min-dash';
+
+import { resolver as RulesResolver } from './compiled-config';
+
+import modelerModdle from 'modeler-moddle/resources/modeler.json';
+import zeebeModdle from 'zeebe-bpmn-moddle/resources/zeebe.json';
+import camundaModdle from 'camunda-bpmn-moddle/resources/camunda.json';
+
+import { getErrorMessage } from './utils/error-messages';
+import { getEntryIds } from './utils/properties-panel';
+
+import { toSemverMinor } from './utils/version';
+
+import defaultPlugins from './plugins';
+
+import bpmnlintConfig from 'bpmnlint/config/correctness';
+
+const NoopResolver = new StaticResolver({});
+
+/**
+ * @param {Object} [options]
+ * @param {string} [options.modeler='desktop']
+ * @param {Array<Object>} [options.plugins=[]]
+ * @param {string} [options.type='cloud']
+ */
+export class Linter {
+  constructor(options = {}) {
+    const {
+      modeler = 'desktop',
+      plugins = [],
+      type = 'cloud'
+    } = options;
+
+    this._moddle = new BpmnModdle({
+      modeler: modelerModdle,
+
+      // Zeebe and Camunda moddle extensions can't be used together
+      // cf. https://github.com/camunda/camunda-modeler/issues/3853#issuecomment-1731145100
+      ...(type === 'cloud' ?
+        { zeebe: zeebeModdle } :
+        { camunda: camundaModdle })
+    });
+
+    this._modeler = modeler;
+    this._plugins = [ ...defaultPlugins, ...plugins ];
+  }
+
+  async lint(contents) {
+    let rootElement;
+
+    if (isString(contents)) {
+      ({ rootElement } = await this._moddle.fromXML(contents));
+    } else {
+      rootElement = contents;
+    }
+
+    const executionPlatform = rootElement.get('modeler:executionPlatform'),
+          executionPlatformVersion = rootElement.get('modeler:executionPlatformVersion');
+
+    if (!executionPlatform || !executionPlatformVersion) {
+      return [];
+    }
+
+    const configName = getConfigName(executionPlatform, executionPlatformVersion);
+
+    const config = this._createConfig(configName);
+
+    const resolver = await this._createResolver(configName);
+
+    const linter = new BpmnLinter({
+      config,
+      resolver
+    });
+
+    const reportsByRule = await linter.lint(rootElement);
+
+    return Object.entries(reportsByRule).reduce((allReports, entry) => {
+      const [ rule, reports ] = entry;
+
+      return [
+        ...allReports,
+        ...reports.map(report => {
+          const entryIds = getEntryIds(report);
+
+          return {
+            ...report,
+            executionPlatform,
+            executionPlatformVersion,
+            message: getErrorMessage(
+              report,
+              executionPlatform,
+              executionPlatformVersion,
+              this._modeler
+            ),
+            propertiesPanel: {
+              entryIds
+            },
+            rule
+          };
+        })
+      ];
+    }, []);
+  }
+
+  _createConfig(configName) {
+    const configs = [
+      {
+        extends: `plugin:bpmnlint-plugin-camunda-compat/${ configName }`
+      },
+      {
+        extends: 'bpmnlint:correctness'
+      },
+      ...this._plugins.map(({ config = {} }) => config)
+    ];
+
+    return configs.reduce(
+      (config, _config) => {
+        let { extends: _extends = [], rules = {} } = _config;
+
+        if (isString(_extends)) {
+          _extends = [ _extends ];
+        }
+
+        return {
+          extends: [ ...config.extends, ..._extends ],
+          rules: {
+            ...config.rules,
+            ...rules
+          }
+        };
+      },
+      {
+        extends: [],
+        rules: {}
+      }
+    );
+  }
+
+  async _createResolver(configName) {
+    const { configs } = await import('bpmnlint-plugin-camunda-compat');
+
+    let { [ configName ]: config } = configs;
+
+    if (!config) {
+      config = {
+        rules: {}
+      };
+    }
+
+    config.rules = addConfig(config.rules, {
+      modeler: this._modeler
+    });
+
+    const ConfigResolver = new StaticResolver({
+      [ `config:bpmnlint-plugin-camunda-compat/${ configName }` ]: config,
+      'config:bpmnlint/correctness': bpmnlintConfig
+    });
+
+    return new Resolver([
+      ConfigResolver,
+      RulesResolver,
+      ...this._plugins.map(({ resolver = NoopResolver }) => resolver)
+    ]);
+  }
+}
+
+function getConfigName(executionPlatform, executionPlatformVersion) {
+  return [
+    ...executionPlatform.split(' ').map(toLowerCase),
+    ...toSemverMinor(executionPlatformVersion).split('.')
+  ].join('-');
+}
+
+function toLowerCase(string) {
+  return string.toLowerCase();
+}
+
+function addConfig(rules, configToAdd) {
+  let rulesWithConfig = {};
+
+  for (let name in rules) {
+    let type, config;
+
+    if (Array.isArray(rules[ name ])) {
+      type = rules[ name ][0];
+      config = rules[ name ][1] || {};
+    } else {
+      type = rules[ name ];
+      config = {};
+    }
+
+    rulesWithConfig[ name ] = [ type, { ...config, ...configToAdd } ];
+  }
+
+  return rulesWithConfig;
 }