Skip to content

bpmn-io/bpmn-js-guideline-validation

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

bpmn-js guideline validation

A bpmn-js extention for guideline validations.

Screencast

Installation

Install via npm.

npm install bpmn-js-guideline-validator

Add as additional module to bpmn-js

Usage

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

Install dependencies

npm install

Run example

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

About

A guideline checker extension for bpmn-js

Resources

Code of conduct

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •