@camunda/linting 3.9.0 → 3.11.0

package/lib/Linter.js

@@ -1,174 +1,200 @@
-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 { getDocumentationUrl } from './utils/documentation';
-
-/**
- * @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 = 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
-            },
-            documentation: {
-              url: getDocumentationUrl(rule)
-            },
-            rule
-          };
-        })
-      ];
-    }, []);
-  }
-
-  _createConfig(configName) {
-    const configs = [
-      {
-        extends: `plugin:bpmnlint-plugin-camunda-compat/${ configName }`
-      },
-      ...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: {}
-      };
-    }
-
-    const ConfigResolver = new StaticResolver({
-      [ `config:bpmnlint-plugin-camunda-compat/${ configName }` ]: config
-    });
-
-    return new Resolver([
-      ConfigResolver,
-      RulesResolver,
-      ...this._plugins.map(({ resolver }) => resolver)
-    ]);
-  }
-}
-
-function getConfigName(executionPlatform, executionPlatformVersion) {
-  return [
-    ...executionPlatform.split(' ').map(toLowerCase),
-    ...toSemverMinor(executionPlatformVersion).split('.')
-  ].join('-');
-}
-
-function toLowerCase(string) {
-  return string.toLowerCase();
+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 { getDocumentationUrl } from './utils/documentation';
+
+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 = 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
+            },
+            documentation: {
+              url: getDocumentationUrl(rule)
+            },
+            rule
+          };
+        })
+      ];
+    }, []);
+  }
+
+  _createConfig(configName) {
+    const configs = [
+      {
+        extends: `plugin:bpmnlint-plugin-camunda-compat/${ configName }`
+      },
+      ...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
+    });
+
+    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;
 }

package/lib/compiled-config.js

@@ -57,7 +57,7 @@ const rules = {
   "camunda-compat/secrets": "error",
   "camunda-compat/sequence-flow-condition": "error",
   "camunda-compat/signal-reference": "error",
-  "camunda-compat/start-form": "error",
+  "camunda-compat/start-event-form": "error",
   "camunda-compat/subscription": "error",
   "camunda-compat/task-schedule": "error",
   "camunda-compat/timer": "error",
@@ -189,9 +189,9 @@ import rule_27 from 'bpmnlint-plugin-camunda-compat/rules/camunda-cloud/signal-r
 
 cache['bpmnlint-plugin-camunda-compat/signal-reference'] = rule_27;
 
-import rule_28 from 'bpmnlint-plugin-camunda-compat/rules/camunda-cloud/start-form';
+import rule_28 from 'bpmnlint-plugin-camunda-compat/rules/camunda-cloud/start-event-form';
 
-cache['bpmnlint-plugin-camunda-compat/start-form'] = rule_28;
+cache['bpmnlint-plugin-camunda-compat/start-event-form'] = rule_28;
 
 import rule_29 from 'bpmnlint-plugin-camunda-compat/rules/camunda-cloud/subscription';
 

package/lib/utils/error-messages.js

@@ -4,7 +4,8 @@ import { is, isAny } from 'bpmnlint-utils';
 
 import {
   every,
-  isArray
+  isArray,
+  isString
 } from 'min-dash';
 
 import { getTypeString } from './types';
@@ -394,6 +395,10 @@ function getPropertyNotAllowedErrorMessage(report, executionPlatform, executionP
     return getSupportedMessage(`${ getIndefiniteArticle(typeString) } <${ typeString }> with <${ TIMER_PROPERTY_LABELS[ property ] }>`, executionPlatform, executionPlatformVersion, allowedVersion);
   }
 
+  if (is(node, 'zeebe:FormDefinition') && property === 'formId') {
+    return getSupportedMessage(`${ getIndefiniteArticle(typeString) } <${ typeString }> with <Form type: Camunda form (linked)>`, executionPlatform, executionPlatformVersion, allowedVersion);
+  }
+
   return message;
 }
 
@@ -483,12 +488,20 @@ function getPropertyRequiredErrorMessage(report, executionPlatform, executionPla
     return `${ getIndefiniteArticle(typeString) } <${ typeString }> must have a defined <Signal Reference>`;
   }
 
-  if (is(node, 'zeebe:FormDefinition') && requiredProperty === 'formKey') {
+  if (is(node, 'zeebe:FormDefinition')
+    && (
+      requiredProperty === 'formKey'
+      || (isArray(requiredProperty) && requiredProperty.includes('formKey') && isEmptyString(node.get('formKey')))
+    )) {
     return `${ getIndefiniteArticle(typeString) } <${ typeString }> with <Form type: Custom form key> must have a defined <Form key>`;
   }
 
+  if (is(node, 'zeebe:FormDefinition') && isArray(requiredProperty) && requiredProperty.includes('formId') && isEmptyString(node.get('formId'))) {
+    return `${ getIndefiniteArticle(typeString) } <${ typeString }> with <Form type: Camunda form (linked)> must have a defined <Form ID>`;
+  }
+
   if (is(node, 'zeebe:UserTaskForm') && requiredProperty === 'body') {
-    return `${ getIndefiniteArticle(typeString) } <${ typeString }> with <Form type: Camunda forms> must have a defined <Form JSON configuration>`;
+    return `${ getIndefiniteArticle(typeString) } <${ typeString }> with <Form type: Camunda form (embedded)> must have a defined <Form JSON configuration>`;
   }
 
   if (is(node, 'bpmn:SequenceFlow') && requiredProperty === 'conditionExpression') {
@@ -672,4 +685,8 @@ function getLoopNotAllowedErrorMessage(report) {
   const { elements } = data;
 
   return `A <Process> is not allowed to contain a straight-through processing loop: ${ elements.map(element => `<${ element }>`).join(', ') }`;
+}
+
+function isEmptyString(value) {
+  return isString(value) && value.trim() === '';
 }

package/lib/utils/properties-panel.js

@@ -1,4 +1,7 @@
-import { isArray } from 'min-dash';
+import {
+  isArray,
+  isString
+} from 'min-dash';
 
 import { is } from 'bpmnlint-utils';
 
@@ -159,6 +162,23 @@ export function getEntryIds(report) {
     return [ 'customFormKey' ];
   }
 
+  if (isType(data, 'zeebe:FormDefinition')) {
+    const {
+      node,
+      requiredProperty
+    } = data;
+
+    if (isArray(requiredProperty) && requiredProperty.includes('formKey') && isEmptyString(node.get('formKey'))) {
+      return [ 'customFormKey' ];
+    } else if (isArray(requiredProperty) && requiredProperty.includes('formId') && isEmptyString(node.get('formId'))) {
+      return [ 'formId' ];
+    }
+  }
+
+  if (isPropertyError(data, 'formId', 'zeebe:FormDefinition')) {
+    return [ 'formId' ];
+  }
+
   if (isPropertyError(data, 'body', 'zeebe:UserTaskForm')) {
     return [ 'formConfiguration' ];
   }
@@ -396,6 +416,14 @@ export function getErrorMessage(id, report) {
     return 'Form key must be defined.';
   }
 
+  if (id === 'formId') {
+    if (data.type === ERROR_TYPES.PROPERTY_REQUIRED) {
+      return 'Form ID must be defined.';
+    } else if (data.type === ERROR_TYPES.PROPERTY_NOT_ALLOWED) {
+      return 'Form ID not supported.';
+    }
+  }
+
   if (id === 'formConfiguration') {
     return 'Form JSON configuration must be defined.';
   }
@@ -547,4 +575,8 @@ function isElementPropertyValueDuplicated(data, propertyName, type) {
 
 function getBusinessObject(element) {
   return element.businessObject || element;
+}
+
+function isEmptyString(value) {
+  return isString(value) && value.trim() === '';
 }

package/package.json

@@ -1,84 +1,84 @@
-{
-  "name": "@camunda/linting",
-  "version": "3.9.0",
-  "description": "Linting for Camunda",
-  "main": "index.js",
-  "scripts": {
-    "all": "npm run lint && npm test",
-    "dev": "npm run test:watch",
-    "lint": "eslint .",
-    "start": "npm run start:cloud",
-    "start:platform": "cross-env SINGLE_START=platform npm run test:watch",
-    "start:cloud": "cross-env SINGLE_START=cloud npm run test:watch",
-    "test": "npm run compile-config && karma start",
-    "test:watch": "npm test -- --auto-watch --no-single-run",
-    "compile-config": "node tasks/compile-config.js",
-    "prepublish": "npm run compile-config"
-  },
-  "keywords": [
-    "bpmnlint",
-    "camunda"
-  ],
-  "author": {
-    "name": "Philipp Fromme",
-    "url": "https://github.com/philippfromme"
-  },
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/camunda/linting"
-  },
-  "license": "MIT",
-  "dependencies": {
-    "@bpmn-io/diagram-js-ui": "^0.2.2",
-    "bpmn-moddle": "^8.0.0",
-    "bpmnlint": "^9.2.0",
-    "bpmnlint-plugin-camunda-compat": "^2.9.0",
-    "bpmnlint-utils": "^1.0.2",
-    "camunda-bpmn-moddle": "^7.0.1",
-    "clsx": "^2.0.0",
-    "min-dash": "^4.0.0",
-    "min-dom": "^4.1.0",
-    "modeler-moddle": "^0.2.0",
-    "semver-compare": "^1.0.0",
-    "zeebe-bpmn-moddle": "^1.0.0"
-  },
-  "devDependencies": {
-    "bpmn-js": "^13.2.2",
-    "bpmn-js-element-templates": "^1.3.0",
-    "bpmn-js-properties-panel": "^5.0.0",
-    "camunda-bpmn-js-behaviors": "^1.0.0",
-    "chai": "^4.3.7",
-    "cross-env": "^7.0.3",
-    "eslint": "^8.45.0",
-    "eslint-plugin-bpmn-io": "^1.0.0",
-    "karma": "^6.4.2",
-    "karma-chrome-launcher": "^3.2.0",
-    "karma-debug-launcher": "0.0.5",
-    "karma-env-preprocessor": "^0.1.1",
-    "karma-mocha": "^2.0.1",
-    "karma-sinon-chai": "^2.0.2",
-    "karma-webpack": "^5.0.0",
-    "mocha": "^10.2.0",
-    "mocha-test-container-support": "^0.2.0",
-    "puppeteer": "^20.9.0",
-    "sinon": "^15.0.1",
-    "sinon-chai": "^3.7.0",
-    "webpack": "^5.75.0"
-  },
-  "peerDependencies": {
-    "bpmn-js-properties-panel": ">= 2.0.0"
-  },
-  "peerDependenciesMeta": {
-    "bpmn-js-properties-panel": {
-      "optional": true
-    }
-  },
-  "files": [
-    "assets",
-    "lib",
-    "modeler.js"
-  ],
-  "publishConfig": {
-    "access": "public"
-  }
-}
+{
+  "name": "@camunda/linting",
+  "version": "3.11.0",
+  "description": "Linting for Camunda",
+  "main": "index.js",
+  "scripts": {
+    "all": "npm run lint && npm test",
+    "dev": "npm run test:watch",
+    "lint": "eslint .",
+    "start": "npm run start:cloud",
+    "start:platform": "cross-env SINGLE_START=platform npm run test:watch",
+    "start:cloud": "cross-env SINGLE_START=cloud npm run test:watch",
+    "test": "npm run compile-config && karma start",
+    "test:watch": "npm test -- --auto-watch --no-single-run",
+    "compile-config": "node tasks/compile-config.js",
+    "prepublish": "npm run compile-config"
+  },
+  "keywords": [
+    "bpmnlint",
+    "camunda"
+  ],
+  "author": {
+    "name": "Philipp Fromme",
+    "url": "https://github.com/philippfromme"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/camunda/linting"
+  },
+  "license": "MIT",
+  "dependencies": {
+    "@bpmn-io/diagram-js-ui": "^0.2.2",
+    "bpmn-moddle": "^8.0.0",
+    "bpmnlint": "^9.2.0",
+    "bpmnlint-plugin-camunda-compat": "^2.12.0",
+    "bpmnlint-utils": "^1.0.2",
+    "camunda-bpmn-moddle": "^7.0.1",
+    "clsx": "^2.0.0",
+    "min-dash": "^4.0.0",
+    "min-dom": "^4.1.0",
+    "modeler-moddle": "^0.2.0",
+    "semver-compare": "^1.0.0",
+    "zeebe-bpmn-moddle": "^1.0.0"
+  },
+  "devDependencies": {
+    "bpmn-js": "^13.2.2",
+    "bpmn-js-element-templates": "^1.3.0",
+    "bpmn-js-properties-panel": "^5.6.1",
+    "camunda-bpmn-js-behaviors": "^1.2.2",
+    "chai": "^4.3.7",
+    "cross-env": "^7.0.3",
+    "eslint": "^8.45.0",
+    "eslint-plugin-bpmn-io": "^1.0.0",
+    "karma": "^6.4.2",
+    "karma-chrome-launcher": "^3.2.0",
+    "karma-debug-launcher": "0.0.5",
+    "karma-env-preprocessor": "^0.1.1",
+    "karma-mocha": "^2.0.1",
+    "karma-sinon-chai": "^2.0.2",
+    "karma-webpack": "^5.0.0",
+    "mocha": "^10.2.0",
+    "mocha-test-container-support": "^0.2.0",
+    "puppeteer": "^20.9.0",
+    "sinon": "^15.0.1",
+    "sinon-chai": "^3.7.0",
+    "webpack": "^5.75.0"
+  },
+  "peerDependencies": {
+    "bpmn-js-properties-panel": ">= 2.0.0"
+  },
+  "peerDependenciesMeta": {
+    "bpmn-js-properties-panel": {
+      "optional": true
+    }
+  },
+  "files": [
+    "assets",
+    "lib",
+    "modeler.js"
+  ],
+  "publishConfig": {
+    "access": "public"
+  }
+}