Skip to content
A bpmnlint plug-in for bpmn-js.
Branch: master
Clone or download
Latest commit aa720f9 Nov 27, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
assets feat(Linting): make warnings less yellow Sep 19, 2018
docs
lib fix(Linting): clear issues on diagram.clear Sep 20, 2018
.gitignore feat(project): provide pre-packed bundles Sep 8, 2018
.npmignore feat(project): provide pre-packed bundles Sep 8, 2018
CHANGELOG.md
LICENSE chore(project): rename LICENSE.md -> LICENSE Sep 7, 2018
README.md FIXUP README Oct 22, 2018
package-lock.json 0.10.1 Nov 27, 2018
package.json 0.10.1 Nov 27, 2018
rollup.config.js chore(project): make bpmnlint an external dependency Sep 20, 2018

README.md

bpmn-js-bpmnlint

Integrates bpmnlint into bpmn-js.

Screenshot

See this extension in action as part of the bpmnlint playground.

Usage

Integrate the linter into bpmn-js:

import lintModule from 'bpmn-js-bpmnlint';

import BpmnModeler from 'bpmn-js/lib/Modeler';

import bpmnlintConfig from './.bpmnlintrc';

var modeler = new BpmnModeler({
  linting: {
    bpmnlint: bpmnlintConfig
  },
  additionalModules: [
    lintModule
  ]
});

Configure Lint Rules

When instantiating bpmn-js you must use the linting.bpmnlint option to provide linter configuration.

The option takes a packed bpmnlint configuration which you may create from your local .bpmnlintrc by using the bpmnlint-pack-config utility:

bpmnlint-pack-config -c .bpmnlintrc -o bundled-config.js

Alternatively you may use an appropriate plugin/loader for your module bundler (cf. rollup-plugin-bpmnlint, bpmnlint-loader) to bundle and consume the configuration directly as shown above.

Resources

Development Setup

npm install && npm run dev

License

MIT

You can’t perform that action at this time.