Changelog

All notable changes to bpmnlint are documented here. We use semantic versioning for releases.

Unreleased

Note: Yet to be released changes appear here.

CHORE: require Node@20

Breaking Changes

Node@20 is required to use this library.

10.3.1

FIX: correct false positive in global rule (#139)
FIX: correct false positive in no-implicit-end rule (#140)
FIX: correct label-required not triggering for boundary events (#141)

10.3.0

FEAT: add global rule (#137)
FEAT: add types for RuleTester#verify API (#138)
DEPS: update to bpmn-moddle@8.1.0
DEPS: update to min-dash@4.2.1

10.2.3

CHORE: eagerly filter non-DI elements in no-overlapping-elements rule (c40cd8a)

10.2.2

FIX: gracefully handle missing DI in no-overlapping-elements rule (#135)

10.2.1

FIX: correct compensation activities triggering no-implicit-start (#132)

10.2.0

FEAT: add link-event rule (#128)

10.1.0

FEAT: add superfluous-termination rule (#19)

10.0.0

DEPS: update to @bpmn-io/moddle-utils@0.2.1
FIX: apply fake-join and no-implicit-split on all activities (#126)
CHORE: require Node >= 16

9.2.0

FEAT: compile custom rule imports to package local references (#115)
FIX: correct custom rule path compilation on Windows (#112, #114)

9.1.0

FEAT: add no-overlapping-elements rule (#107, #72)
FEAT: detect intermediate events overlapping tasks (#71, #107)

9.0.0

FEAT: introduce rule-error category for rule errors (#109)

Breaking Changes

rule errors are now reported as rule-error category instead of error

8.3.2

FIX: correct no-implicit-start and no-implicit-end in different scenarios (#106)

8.3.1

DEPS: update to @bpmn-io/moddle-utils@0.2.0

8.3.0

FEAT: add no-implicit-start and no-implicit-end rules (#88)
FEAT: allow to resolve rules from custom paths (#99)
DEPS: bump to bpmn-moddle@8.0.1
DEPS: bump to min-dash@4.1.1
DEPS: bump to bpmnlint-utils@1.1.1

8.2.0

FEAT: support info type (#102)

8.1.1

FIX: correct category in recommended config (#94)

8.1.0

FEAT: add --max-warnings cli switch (#92)

8.0.0

FEAT: detect message flows without DI (#85)
FEAT: serialize disabled rules (#90)
DEPS: depend on @bpmn-io/moddle-utils (31de95a3)
CHORE: drop Node@10 support

7.8.0

FEAT: be able to configure rules (#82)
FEAT: be able to configure rules when testing (#83)

7.7.0

FEAT: fuzzy test for equality of nodes when using RuleTester#verify (#79)

7.6.0

FEAT: allow passing object as third parameter to Reporter#report (#75)

7.5.0

FEAT: add optional path parameter to Reporter#report (#73)
FEAT: add optional name parameter to RuleTester#verify (#68)
CHORE: update to bpmn-moddle@7.1.2

7.4.0

FEAT: resolve local package by name (#64)

7.3.0

FEAT: support --version command line flag (#65)
FEAT: allow rule testers to provide custom it
FIX: make no-bpmndi handle missing LaneSet#lanes gracefully (#63, #66)

7.2.1

FIX: exclude compensation boundary and activity in no-disconnected check (#60)

7.2.0

FEAT: add no-bpmndi rule (#55)

7.1.0

FEAT: allow rules to skip sub-tree traversal (#53)
FEAT: allow rules to hook into node enter and leave (#52)

7.0.1

CHORE: drop debug log statement

7.0.0

CHORE: update to bpmn-moddle@7
CHORE: reduce library footprint
CHORE: require NodeJS>=10

6.5.0

FEAT: add globbing support (#46)
DOCS: add explaination to no-inclusive-gateway rule

6.4.0

FEAT: add superfluous-gateway check (#42)

6.3.0

FEAT: support rules and configuration provided by scoped packages (#35)
CHORE: improve Node >= 12.20 compatibility (#37)

6.2.0

DOCS: document existing rules (#14)

6.1.2

FIX: exclude event-based sub-processes from no-disconnected check (#31)

6.1.1

FEAT: allow tool to be used with Node >= 8

6.1.0

FEAT: resolve local rules in plug-ins without prefix (640e411a)

6.0.0

FEAT: resolve plug-in provided rules/configuration local to working directory (f1bf331f)
CHORE: improve errors on rule/plugin resolution failures
CHORE: require >= node@10.12

5.3.0

FEAT: add --init option to create .bpmnlintrc in current working directory

5.2.0

FEAT: provide help on missing .bpmnlintrc

5.1.2

DOCS: add package description

5.1.1

CHORE: exclude additional development assets from distribution

5.1.0

FEAT: add no-duplicate-sequence-flows rule (#22)
FEAT: catch more BPMN parse errors
FEAT: be able to define multiple expected test results in RuleTester
FIX: make nyc a development dependency
CHORE: update to bpmn-moddle@6

5.0.0

FEAT: don't expose utils to rules; use bpmnlint-utils instead

4.1.0

FEAT: handle and report diagram import errors and warnings via CLI
FEAT: properly handle generic moddle elements during rule checking
FEAT: report rule execution errors

4.0.0

FEAT: add ability to batch lint multiple files via CLI
FEAT: don't resolve disabled rules (6c45f3f9)
CHORE: unify messages of built-in rules
CHORE: adopt cli output to eslint styling

3.3.1

FIX: handle empty flow element containers in rules

3.3.0

FEAT: do not expose disabled rules when bundling .bpmnlintrc

3.2.1

DOCS: fix readme code snippet

3.2.0

FEAT: add ability to pass linter configuration via constructor

3.1.0

FEAT: add support script to compile .bpmnlintrc files to JavaScript (cf53a389)

3.0.0

Breaking Changes

FEAT: treat unprefixed rules as built-in ones

2.0.0

Breaking Changes

CHORE: make NodeResolver a constructor
CHORE: unify file names to dashed-case
CHORE: rework Resolver APIs

Other Enhancements

FEAT: add StaticResolver to load cached resources
FEAT: add { Linter } as a library export
CHORE: move rule and config name resolution to linter
CHORE: catch all cli errors and exit accordingly

1.0.0

FEAT: add numerous new rules (#5)
FEAT: add bpmnlint:all configuration
FEAT: improve label-required rule (#11)
FEAT: group lint results by rule names
FEAT: exit cli with code=1 on lint errors
FEAT: add isAny(node, [ ... types ]) method to utils
CHORE: improve / test cover existing rules
CHORE: include new rules in bpmnlint:recommended configuration

1.0.0-alpha6

DOCS: documentation simplification / improvements

1.0.0-alpha5

Initial stable release.

FEAT: configure, resolve and execute local and external rules
FEAT: extend external configuration via extends
FEAT: make rule and configuration resolution async
FEAT: provide bpmnlint:recommended configuration
CHORE: linter is now a constructor, offering a #lint(moddleElement, config) method
CHORE: moved library to bpmn-io/bpmnlint
CHORE: full rewrite of internals
CHORE: utils API change

...

Check git log for earlier history.