# bpmn-js-guideline-validation

**Repository Path**: mirrors_bpmn-io/bpmn-js-guideline-validation

## Basic Information

- **Project Name**: bpmn-js-guideline-validation
- **Description**: A guideline checker extension for bpmn-js
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-09-24
- **Last Updated**: 2025-11-09

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# bpmn-js guideline validation

A bpmn-js extention for guideline validations.

![Screencast](docs/screencast.gif)

## Installation

Install via [npm](https://www.npmjs.com/).

```shell
npm install bpmn-js-guideline-validator
```

Add as additional module to [bpmn-js](https://github.com/bpmn-io/bpmn-js)

### Usage

```javascript
var BpmnModeler = require('bpmn-js/lib/Modeler');
var guidelineValidation = require('bpmn-js-guideline-validator');

var modeler = new BpmnModeler({
    container: '#canvas',
    additionalModules: [
        guidelineValidation
    ],
    keyboard: {
        bindTo: document
    }
});
```

> For the correct style of the extension you need to copy the assets in the root directory of your `index.html` and include the `css/guideline-validation.css` to your `index.html`. Have a look at the [example](example/index.html).

## Example

Install dependencies

```shell
npm install
```

Run example

```shell
npm run dev
```

Check out `localhost:9013`

## Current Guidelines

- Crossing Sequenceflows
- Joining and Splitting Gateways
- No Labels
- No Start and End Event
- Symmetric Modelling
- Unnecessary Gateway
- Use of Parallel Gateway

> Some of the guideline validations are only working properly, if another one is already fixed. For example, you need to model a start event for the symmetric modelling check.

## Licence

MIT