@camunda/linting 0.16.0 → 1.0.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,
@@ -224,6 +248,10 @@ function getExtensionElementNotAllowedErrorMessage(report, executionPlatform, ex
     return getSupportedMessage('A <Script Task> with <Implementation: FEEL expression>', executionPlatform, executionPlatformVersion, allowedVersion);
   }
 
+  if (is(node, 'bpmn:UserTask') && is(extensionElement, 'zeebe:TaskSchedule')) {
+    return getSupportedMessage('A <User Task> with <Due date> or <Follow up date>', executionPlatform, executionPlatformVersion, allowedVersion);
+  }
+
   return message;
 }
 
@@ -268,7 +296,7 @@ function getExtensionElementRequiredErrorMessage(report) {
   return message;
 }
 
-function getPropertyDependendRequiredErrorMessage(report) {
+function getPropertyDependentRequiredErrorMessage(report) {
   const {
     data,
     message
@@ -278,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>`;
   }
 
@@ -369,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') {
@@ -435,12 +457,17 @@ function getPropertyRequiredErrorMessage(report, executionPlatform, executionPla
     return `${ getIndefiniteArticle(typeString) } <${ typeString }> must have a defined <Timer duration>`;
   }
 
+  if (is(node, 'bpmn:Process') && requiredProperty === 'historyTimeToLive') {
+    return `${ getIndefiniteArticle(typeString) } <${ typeString }> must have a defined <History time to live>`;
+  }
+
   return message;
 }
 
 function getExpressionRequiredErrorMessage(report) {
   const {
-    data
+    data,
+    message
   } = report;
 
   const {
@@ -454,11 +481,14 @@ function getExpressionRequiredErrorMessage(report) {
   if (is(node, 'bpmn:FormalExpression') && TIMER_PROPERTIES.includes(property)) {
     return `${ getIndefiniteArticle(typeString) } <${ typeString }> must have a defined <Timer value>`;
   }
+
+  return message;
 }
 
 function getExpressionValueNotAllowedErrorMessage(report) {
   const {
-    data
+    data,
+    message
   } = report;
 
   const {
@@ -470,16 +500,26 @@ function getExpressionValueNotAllowedErrorMessage(report) {
   const typeString = getTypeString(parentNode || node);
 
   if (is(node, 'bpmn:FormalExpression') && property === 'timeCycle') {
-    return `${ getIndefiniteArticle(typeString) } <${ typeString }> <Time cycle> should be an expression, an ISO 8601 repeating interval, or a cron expression (cron requires Camunda Platform 8.1 or newer)`;
+    return `${ getIndefiniteArticle(typeString) } <${ typeString }> <Time cycle> must be an expression, an ISO 8601 repeating interval, or a cron expression (cron requires Camunda Platform 8.1 or newer)`;
   }
 
   if (is(node, 'bpmn:FormalExpression') && property === 'timeDate') {
-    return `${ getIndefiniteArticle(typeString) } <${ typeString }> <Time date> should be an expression, or an ISO 8601 date`;
+    return `${ getIndefiniteArticle(typeString) } <${ typeString }> <Time date> must be an expression, or an ISO 8601 date`;
   }
 
   if (is(node, 'bpmn:FormalExpression') && property === 'timeDuration') {
-    return `${ getIndefiniteArticle(typeString) } <${ typeString }> <Time duration> should be an expression, or an ISO 8601 interval`;
+    return `${ getIndefiniteArticle(typeString) } <${ typeString }> <Time duration> must be an expression, or an ISO 8601 interval`;
+  }
+
+  if (is(node, 'zeebe:TaskSchedule') && property === 'dueDate') {
+    return `${ getIndefiniteArticle(typeString) } <${ typeString }> <Due date> must be an ISO 8601 date`;
   }
+
+  if (is(node, 'zeebe:TaskSchedule') && property === 'followUpDate') {
+    return `${ getIndefiniteArticle(typeString) } <${ typeString }> <Follow up date> must be an ISO 8601 date`;
+  }
+
+  return message;
 }
 
 function getSupportedMessage(prefix, executionPlatform, executionPlatformVersion, allowedVersion) {

package/lib/utils/properties-panel.js

@@ -105,11 +105,11 @@ export function getEntryIds(report) {
     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' ];
   }
 
@@ -217,6 +217,34 @@ export function getEntryIds(report) {
     return [ 'assignmentDefinitionCandidateUsers' ];
   }
 
+  if (isPropertyError(data, 'historyTimeToLive', 'bpmn:Process')) {
+    return [ 'historyTimeToLive' ];
+  }
+
+  if (isExpressionValueNotAllowedError(data, 'dueDate', 'zeebe:TaskSchedule')) {
+    return [ 'taskScheduleDueDate' ];
+  }
+
+  if (isExpressionValueNotAllowedError(data, 'followUpDate', 'zeebe:TaskSchedule')) {
+    return [ 'taskScheduleFollowUpDate' ];
+  }
+
+  if (isExtensionElementNotAllowedError(data, 'zeebe:TaskSchedule', 'bpmn:UserTask')) {
+    const { extensionElement: taskSchedule } = data;
+
+    let ids = [];
+
+    if (taskSchedule.get('dueDate')) {
+      ids = [ ...ids, 'taskScheduleDueDate' ];
+    }
+
+    if (taskSchedule.get('followUpDate')) {
+      ids = [ ...ids, 'taskScheduleFollowUpDate' ];
+    }
+
+    return ids;
+  }
+
   return [];
 }
 
@@ -354,6 +382,26 @@ export function getErrorMessage(id, report) {
   if (id === 'assignmentDefinitionCandidateUsers') {
     return 'Not supported.';
   }
+
+  if (id === 'historyTimeToLive') {
+    return 'Time to live must be defined.';
+  }
+
+  if (id === 'taskScheduleDueDate') {
+    if (data.type === ERROR_TYPES.EXTENSION_ELEMENT_NOT_ALLOWED) {
+      return 'Not supported.';
+    } else {
+      return 'Must be an ISO 8601 date.';
+    }
+  }
+
+  if (id === 'taskScheduleFollowUpDate') {
+    if (data.type === ERROR_TYPES.EXTENSION_ELEMENT_NOT_ALLOWED) {
+      return 'Not supported.';
+    } else {
+      return 'Must be an ISO 8601 date.';
+    }
+  }
 }
 
 function isExtensionElementNotAllowedError(data, extensionElement, type) {
@@ -369,9 +417,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,13 +1,15 @@
 {
   "name": "@camunda/linting",
-  "version": "0.16.0",
+  "version": "1.0.0",
   "description": "Linting for Camunda Platform",
   "main": "index.js",
   "scripts": {
     "all": "npm run lint && npm test",
     "dev": "npm run test:watch",
     "lint": "eslint .",
-    "start": "cross-env SINGLE_START=modeler npm run test:watch",
+    "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": "karma start",
     "test:watch": "npm test -- --auto-watch --no-single-run"
   },
@@ -27,15 +29,16 @@
   "dependencies": {
     "bpmn-moddle": "^8.0.0",
     "bpmnlint": "^8.0.0",
-    "bpmnlint-plugin-camunda-compat": "^0.22.0",
+    "bpmnlint-plugin-camunda-compat": "^1.0.1",
     "bpmnlint-utils": "^1.0.2",
     "min-dash": "^4.0.0",
     "min-dom": "^4.1.0",
-    "zeebe-bpmn-moddle": "^0.17.0"
+    "zeebe-bpmn-moddle": "^0.18.0"
   },
   "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",
     "eslint": "^8.32.0",