@camunda/linting 0.17.0 → 1.1.0

package/lib/utils/error-messages.js

@@ -43,7 +43,7 @@ export function getExecutionPlatformLabel(executionPlatform, executionPlatformVe
   return `${ executionPlatform } ${ toSemverMinor(executionPlatformVersion) }`;
 }
 
-function getIndefiniteArticle(type) {
+function getIndefiniteArticle(type, uppercase = true) {
   if ([
     'Ad',
     'Error',
@@ -53,10 +53,10 @@ function getIndefiniteArticle(type) {
     'Intermediate',
     'Undefined'
   ].includes(type.split(' ')[ 0 ])) {
-    return 'An';
+    return uppercase ? 'An' : 'an';
   }
 
-  return 'A';
+  return uppercase ? 'A' : 'a';
 }
 
 export function getErrorMessage(report, executionPlatform, executionPlatformVersion, modeler = 'desktop') {
@@ -71,6 +71,10 @@ export function getErrorMessage(report, executionPlatform, executionPlatformVers
 
   const { type } = data;
 
+  if (type === ERROR_TYPES.CHILD_ELEMENT_TYPE_NOT_ALLOWED) {
+    return getChildElementTypeNotAllowedErrorMessage(report, executionPlatform, executionPlatformVersion);
+  }
+
   if (type === ERROR_TYPES.ELEMENT_COLLAPSED_NOT_ALLOWED) {
     return getElementCollapsedNotAllowedErrorMessage(report);
   }
@@ -87,8 +91,8 @@ export function getErrorMessage(report, executionPlatform, executionPlatformVers
     return getExtensionElementRequiredErrorMessage(report);
   }
 
-  if (type === ERROR_TYPES.PROPERTY_DEPENDEND_REQUIRED) {
-    return getPropertyDependendRequiredErrorMessage(report);
+  if (type === ERROR_TYPES.PROPERTY_DEPENDENT_REQUIRED) {
+    return getPropertyDependentRequiredErrorMessage(report);
   }
 
   if (type === ERROR_TYPES.PROPERTY_NOT_ALLOWED) {
@@ -122,6 +126,26 @@ export function getErrorMessage(report, executionPlatform, executionPlatformVers
   return message;
 }
 
+function getChildElementTypeNotAllowedErrorMessage(report, executionPlatform, executionPlatformVersion) {
+  const { data } = report;
+
+  const {
+    allowedVersion,
+    node,
+    parent
+  } = data;
+
+  const typeString = getTypeString(node),
+        parentTypeString = getTypeString(parent);
+
+  return getSupportedMessage(
+    `${ getIndefiniteArticle(typeString) } <${ typeString }> in ${ getIndefiniteArticle(parentTypeString, false) } <${ parentTypeString }>`,
+    executionPlatform,
+    executionPlatformVersion,
+    allowedVersion
+  );
+}
+
 function getElementCollapsedNotAllowedErrorMessage(report) {
   const {
     data,
@@ -272,7 +296,7 @@ function getExtensionElementRequiredErrorMessage(report) {
   return message;
 }
 
-function getPropertyDependendRequiredErrorMessage(report) {
+function getPropertyDependentRequiredErrorMessage(report) {
   const {
     data,
     message
@@ -282,16 +306,16 @@ function getPropertyDependendRequiredErrorMessage(report) {
     node,
     parentNode,
     property,
-    dependendRequiredProperty
+    dependentRequiredProperty
   } = data;
 
   const typeString = getTypeString(parentNode || node);
 
-  if (is(node, 'zeebe:LoopCharacteristics') && property === 'outputCollection' && dependendRequiredProperty === 'outputElement') {
+  if (is(node, 'zeebe:LoopCharacteristics') && property === 'outputCollection' && dependentRequiredProperty === 'outputElement') {
     return `${ getIndefiniteArticle(typeString) } <${ typeString }> with <Multi-instance marker> and defined <Output collection> must have a defined <Output element>`;
   }
 
-  if (is(node, 'zeebe:LoopCharacteristics') && property === 'outputElement' && dependendRequiredProperty === 'outputCollection') {
+  if (is(node, 'zeebe:LoopCharacteristics') && property === 'outputElement' && dependentRequiredProperty === 'outputCollection') {
     return `${ getIndefiniteArticle(typeString) } <${ typeString }> with <Multi-instance marker> and defined <Output element> must have a defined <Output collection>`;
   }
 
@@ -373,13 +397,7 @@ function getPropertyRequiredErrorMessage(report, executionPlatform, executionPla
   }
 
   if (is(node, 'bpmn:Error') && requiredProperty === 'errorCode') {
-
-    if (parentNode && is(parentNode, 'bpmn:CatchEvent')) {
-      return getSupportedMessage(`${ getIndefiniteArticle(typeString) } <${ typeString }> without defined <Error code>`, executionPlatform, executionPlatformVersion, allowedVersion);
-    } else if (parentNode && is(parentNode, 'bpmn:ThrowEvent')) {
-      return `${ getIndefiniteArticle(typeString) } <${ typeString }> with <Error Reference> must have a defined <Error code>`;
-    }
-
+    return `${ getIndefiniteArticle(typeString) } <${ typeString }> with <Error Reference> must have a defined <Error code>`;
   }
 
   if (is(node, 'bpmn:Escalation') && requiredProperty === 'escalationCode') {
@@ -394,6 +412,10 @@ function getPropertyRequiredErrorMessage(report, executionPlatform, executionPla
     return `${ getIndefiniteArticle(typeString) } <${ typeString }> with <Message Reference> must have a defined <Name>`;
   }
 
+  if (is(node, 'bpmn:Signal') && requiredProperty === 'name') {
+    return `${ getIndefiniteArticle(typeString) } <${ typeString }> with <Signal Reference> must have a defined <Name>`;
+  }
+
   if (is(node, 'zeebe:Subscription') && requiredProperty === 'correlationKey') {
     return `${ getIndefiniteArticle(typeString) } <${ typeString }> with <Message Reference> must have a defined <Subscription correlation key>`;
   }
@@ -416,6 +438,10 @@ function getPropertyRequiredErrorMessage(report, executionPlatform, executionPla
     return `${ getIndefiniteArticle(typeString) } <${ typeString }> must have a defined <Message Reference>`;
   }
 
+  if (requiredProperty === 'signalRef') {
+    return `${ getIndefiniteArticle(typeString) } <${ typeString }> must have a defined <Signal Reference>`;
+  }
+
   if (is(node, 'zeebe:FormDefinition') && requiredProperty === 'formKey') {
     return `${ getIndefiniteArticle(typeString) } <${ typeString }> with <Form type: Custom form key> must have a defined <Form key>`;
   }

package/lib/utils/properties-panel.js

@@ -76,6 +76,10 @@ export function getEntryIds(report) {
     return [ 'messageRef' ];
   }
 
+  if (isPropertyError(data, 'signalRef')) {
+    return [ 'signalRef' ];
+  }
+
   if (isPropertyError(data, 'decisionId', 'zeebe:CalledDecision')) {
     return [ 'decisionId' ];
   }
@@ -100,16 +104,20 @@ export function getEntryIds(report) {
     return [ 'messageName' ];
   }
 
+  if (isPropertyError(data, 'name', 'bpmn:Signal')) {
+    return [ 'signalName' ];
+  }
+
   if (isExtensionElementRequiredError(data, 'zeebe:LoopCharacteristics', 'bpmn:MultiInstanceLoopCharacteristics')
     || isPropertyError(data, 'inputCollection', 'zeebe:LoopCharacteristics')) {
     return [ 'multiInstance-inputCollection' ];
   }
 
-  if (isPropertyDependendRequiredError(data, 'outputCollection', 'zeebe:LoopCharacteristics')) {
+  if (isPropertyDependentRequiredError(data, 'outputCollection', 'zeebe:LoopCharacteristics')) {
     return [ 'multiInstance-outputCollection' ];
   }
 
-  if (isPropertyDependendRequiredError(data, 'outputElement', 'zeebe:LoopCharacteristics')) {
+  if (isPropertyDependentRequiredError(data, 'outputElement', 'zeebe:LoopCharacteristics')) {
     return [ 'multiInstance-outputElement' ];
   }
 
@@ -286,6 +294,10 @@ export function getErrorMessage(id, report) {
     return 'Global message reference must be defined.';
   }
 
+  if (id === 'signalRef') {
+    return 'Global signal reference must be defined.';
+  }
+
   if (id === 'decisionId') {
     return 'Decision ID must be defined.';
   }
@@ -310,6 +322,10 @@ export function getErrorMessage(id, report) {
     return 'Name must be defined.';
   }
 
+  if (id === 'signalName') {
+    return 'Name must be defined.';
+  }
+
   if (id === 'multiInstance-inputCollection') {
     return 'Input collection must be defined.';
   }
@@ -417,9 +433,9 @@ function isExtensionElementRequiredError(data, requiredExtensionElement, type) {
     && (!type || is(data.node, type));
 }
 
-function isPropertyDependendRequiredError(data, dependendRequiredProperty, type) {
-  return data.type === ERROR_TYPES.PROPERTY_DEPENDEND_REQUIRED
-    && data.dependendRequiredProperty === dependendRequiredProperty
+function isPropertyDependentRequiredError(data, dependentRequiredProperty, type) {
+  return data.type === ERROR_TYPES.PROPERTY_DEPENDENT_REQUIRED
+    && data.dependentRequiredProperty === dependentRequiredProperty
     && (!type || is(data.node, type));
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@camunda/linting",
-  "version": "0.17.0",
+  "version": "1.1.0",
   "description": "Linting for Camunda Platform",
   "main": "index.js",
   "scripts": {
@@ -29,7 +29,7 @@
   "dependencies": {
     "bpmn-moddle": "^8.0.0",
     "bpmnlint": "^8.0.0",
-    "bpmnlint-plugin-camunda-compat": "^0.24.0",
+    "bpmnlint-plugin-camunda-compat": "^1.1.0",
     "bpmnlint-utils": "^1.0.2",
     "min-dash": "^4.0.0",
     "min-dom": "^4.1.0",
@@ -37,7 +37,7 @@
   },
   "devDependencies": {
     "bpmn-js": "^11.1.1",
-    "bpmn-js-properties-panel": "^1.15.1",
+    "bpmn-js-properties-panel": "^1.20.0",
     "camunda-bpmn-js-behaviors": "^0.5.0",
     "chai": "^4.3.7",
     "cross-env": "^7.0.3",