https://github.com/camunda/camunda-modeler-linter-plugin

Check your BPMN diagrams for common issues
https://github.com/camunda/camunda-modeler-linter-plugin

bpmnlint camunda-modeler camunda-modeler-plugin

Last synced: 2 months ago
JSON representation

Check your BPMN diagrams for common issues

• Host: GitHub
• URL: https://github.com/camunda/camunda-modeler-linter-plugin
• Owner: camunda
• Created: 2018-09-03T07:06:58.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2024-09-10T13:43:42.000Z (4 months ago)
• Last Synced: 2024-10-09T09:50:33.359Z (3 months ago)
• Topics: bpmnlint, camunda-modeler, camunda-modeler-plugin
• Language: JavaScript
• Homepage:
• Size: 1.07 MB
• Stars: 37
• Watchers: 18
• Forks: 8
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

        
> **This plugin was replaced by the built-in linting feature of [Camunda Modeler v5.3](https://github.com/camunda/camunda-modeler/blob/develop/CHANGELOG.md#530)**. Check out the [custom lint rules plugin](https://github.com/camunda/camunda-modeler-custom-linter-rules-plugin) to learn how to add custom lint rules to the built-in linting feature.

# camunda-modeler-linter-plugin

[![CI](https://github.com/camunda/camunda-modeler-linter-plugin/workflows/CI/badge.svg)](https://github.com/camunda/camunda-modeler-linter-plugin/actions?query=workflow%3ACI)

[![Compatible with Camunda Modeler version 3.3](https://img.shields.io/badge/Camunda%20Modeler%20<5.3-blue.svg)](https://github.com/camunda/camunda-modeler)

[bpmnlint](https://github.com/bpmn-io/bpmnlint/) as a plugin for the [Camunda Modeler](https://github.com/camunda/camunda-modeler/).

![Screenshot of the plug-in](./docs/screenshot.png)

## Overriding Provided Rules

This plug-ins uses the [recommended bpmnlint and Camunda rules](./.bpmnlintrc).

You may override this via your own Camunda Modeler client plug-in as shown below:

```javascript

import {

  registerBpmnJSPlugin

} from 'camunda-modeler-plugin-helpers';

import customLinterConfig from './.bpmnlintrc';

registerBpmnJSPlugin({

  __init__: [

    function(linting) {

      linting.setLinterConfig(customLinterConfig);

    }

  ]

});

```

Please note that you must use the [bpmnlint-loader](https://github.com/nikku/bpmnlint-loader) to bundle your [`.bpmnlintrc`](https://github.com/bpmn-io/bpmnlint#configuration) for usage in the browser.

For a complete example, checkout the [custom-linter-rules-plugin](https://github.com/camunda/camunda-modeler-custom-linter-rules-plugin) that accomplishes this.

## Licence

MIT