npmpackage.info

bpmnlint

Validate BPMN diagrams based on configurable lint rules.

10.3.1

125

MIT

JavaScript

3.04 kB

1,344,054 4.8

Installations

npm install bpmnlint

Score

90.8

Supply Chain

97.6

Quality

Maintenance

100

Vulnerability

100

License

Pull Requests

Open

1

Total

84

Closed

14

Merged

69

Issues

Open

15

Total

68

Closed

53

Releases

v10.3.1

Published on 19 Sept 2024

v10.3.0

Published on 20 Jun 2024

v10.2.3

Published on 29 May 2024

v10.2.2

Published on 27 May 2024

v10.2.1

Published on 22 Mar 2024

v10.2.0

Published on 30 Jan 2024

View all 8 releases

Developer

bpmn-io

Developer Guide

BETA

Module System

CommonJS

Min. Node Version

>= 16

Typescript Support

No

Node Version

20.11.1

NPM Version

10.2.4 Statistics

125 Stars

516 Commits

37 Forks

12 Watching

7 Branches

17 Contributors

Updated on 01 Nov 2024

Bundle Size

9.14 kB

Minified

3.04 kB

Minified + Gzipped

Bundlephobia

Languages

JavaScript (100%)

Total Downloads

Cumulative downloads

Total Downloads

1,344,054

Last day

-29.5%

2,356

Compared to previous day

Last week

0.9%

14,537

Compared to previous week

Last month

-13.3%

65,657

Compared to previous month

Last year

65.6%

586,380

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Versions

bpmnlint

Validate your BPMN diagrams based on configurable lint rules.

Installation

Install the utility via npm:

1npm install -g bpmnlint

Usage

Validate your diagrams via the commandline:

1> bpmnlint invoice.bpmn
2
3/Projects/process-application/resources/invoice.bpmn
4  Flow_1    error    Sequence flow is missing condition  conditional-flows
5  Process   error    Process is missing end event        end-event-required
6  Task_13   warning  Element is missing label/name       label-required
7  Event_12  warning  Element is missing label/name       label-required
8  Event_27  warning  Element is missing label/name       label-required
9  Process   error    Process is missing start event      start-event-required
10
11✖ 6 problems (6 errors, 0 warnings)

Rules

Our documentation lists all currenty implemented rules, the ./rules folder contains each rules implementation.

Do you miss a rule that should be included? Propose a new rule.

Configuration

Create a .bpmnlintrc file in your working directory and inherit from a common configuration using the extends block:

1{
2  "extends": "bpmnlint:recommended"
3}

Add or customize rules using the rules block:

1{
2  "extends": "bpmnlint:recommended",
3  "rules": {
4    "label-required": "off"
5  }
6}

API

Invoke the tool directly from NodeJS:

1import Linter from 'bpmnlint';
2import NodeResolver from 'bpmnlint/lib/resolver/node-resolver';
3
4import BpmnModdle from 'bpmn-moddle';
5
6const moddle = new BpmnModdle();
7
8const linter = new Linter({ 
9  config: {
10    extends: 'bpmnlint:recommended'
11  },
12  resolver: new NodeResolver()
13});
14
15const xmlStr = `
16  <?xml version="1.0" encoding="UTF-8"?>
17  <bpmn:definitions xmlns:bpmn="http://www.omg.org/spec/BPMN/20100524/MODEL" 
18                     id="definitions" 
19                     targetNamespace="http://bpmn.io/schema/bpmn">
20    <bpmn:process id="process" />
21  </bpmn:definitions>
22`;
23
24const {
25  rootElement: definitions
26} = await moddle.fromXML(xmlStr);
27
28const reports = linter.lint(definitions);
29
30// {
31//    "end-event-required": [
32//      {
33//        "id": "process",
34//        "message": "Process is missing end event"
35//      }
36//    ],
37//    ...
38// }

Writing a Plug-in

Create your first plug-in using the plugin creator:

1npm init bpmnlint-plugin {PLUGIN_NAME}

Checkout the bpmnlint-plugin-example for details on how to define, test, and consume custom lint rules. Use the bpmnlint playground to implement new rules with quick visual feedback.

Bundling

For browser usage include your linting configuration using your favorite bundler plug-in (Rollup, Webpack).

Visual Feedback

Integrate the linter via bpmn-js-bpmnlint into bpmn-js and get direct feedback during modeling.

To try out visual validation, checkout the bpmnlint playground.

bpmnlint-plugin-example - an example plug-in
bpmnlint-playground - a playground to implement new rules with quick visual feedback
bpmnlint-generate-docs-images - Generate images for your bpmnlint documentation
bpmn-js-bpmnlint - integration into bpmn-js

License

MIT

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Maintained

Determines if the project is "actively maintained".

10

License

Determines if the project has defined a license.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

Security-Policy

Determines if the project has published a security policy.

6

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

3

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

1

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

SAST

Determines if the project uses static code analysis.

Score

4.8

/10

Last Scanned on 2024-11-25

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

Other packages similar to bpmnlint

bpmnlint-utils

1.1.1

Utilities for creating bpmnlint rules

bpmn-js-bpmnlint

0.22.3

bpmn-js integration for bpmnlint

bpmnlint-pack-config

0.8.0

Pack bpmnlint config to a browser consumable bundle

bpmnlint-loader

0.1.6

Consume bpmnlint config files with webpack

bpmnlint

Installations

Score

Pull Requests

1

84

14

69

Issues

15

68

53

Releases

Developer

bpmn-io

Developer Guide

CommonJS

>= 16

No

20.11.1

10.2.4

Statistics

Bundle Size

9.14 kB

3.04 kB

Languages

Total Downloads

1,344,054

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Dev Dependencies

bpmnlint

Installation

Usage

Rules

Configuration

API

Writing a Plug-in

Bundling

Visual Feedback

Related

License

10

10

10

10

10

6

3

1

0

0

0

0

0

4.8

/10

Other packages similar to bpmnlint