bpmn-rules

This package contains BP3's linting rules for Camunda BPMN.

Installation

Install the rules on your project using npm:

npm install @bp3global/bpmnlint-plugin-bpmn-rules

The rules included in this package

The list of rules included in this package is given in the index.js file, but an extended description provided below.

| Rule | Description | |-----------------------------------------------|-----------------------------------------------------------------------------------------------| | no-job-worker-user-task-implementation-type | Since 8.7 Job Worker User Tasks can no longer be selected | | user-task-without-assignment-details | Validates that user tasks have any assignment configuration | | artifact-with-default-id | Validates whether activities and gateways have default ids instead of meaningful ones | | activity-without-type | Validates whether activities have a type | | exclusive-gateway-has-default-flow | Validates whether gateways have default flow | | variable-name-with-invalid-character | Validates whether a variable name has invalid characters, whitespaces or starts with a number |

How to add this rules package to your project

One of the easiest ways to start linting your project is to use camunda-lint.

Add a .bpmnlintrc file to your project. You may find that you have a default one already

{
  "extends": "bpmnlint:recommended" 
}

To add the rules in this package modify your .bpmnlintrc as follows:

{
  "extends": [
    "bpmnlint:recommended",
    "plugin:@bp3global/bpmn-rules/recommended"
  ]
}

How to configure the individual rules in this package

Individual rules can be turned on or off. You can also vary the level at which the rules report, either info, warn or error.

{
  "extends": [
    "bpmnlint:recommended",
    "plugin:@bp3global/bpmn-rules/recommended"
  ],
  "rules": {
    "fake-join": "off",
    "label-required": "info",
    "@bp3global/bpmn-rules/user-task-without-assignment-details": "error"
  }
}