Security News
NIST Misses 2024 Deadline to Clear NVD Backlog
NIST has failed to meet its self-imposed deadline of clearing the NVD's backlog by the end of the fiscal year. Meanwhile, CVE's awaiting analysis have increased by 33% since June.
[![Build Status](https://travis-ci.org/bpmn-io/bpmnlint.svg?branch=master)](https://travis-ci.org/bpmn-io/bpmnlint)
Validate and improve your BPMN diagrams.
npm install -s bpmnlint
Or:
yarn add bpmnlint
// .bpmnlintrc file
{
"rules": {
"label-required": "warn",
"start-event-required": "error",
"end-event-required": "error"
}
}
bpmnlint ./sample.bpmn
// some-config.json file
{
"rules": {
"label-required": "warn",
"start-event-required": "error",
"end-event-required": "error"
}
}
bpmnlint ./sample.bpmn -c some-config.json
or
bpmnlint ./sample.bpmn --config some-config.json
Note: For more information about the possible flags, run bpmnlint with the --help flag.
The configuration file is a JSON object where the keys represent the rule names and their values provide information about these rules.
These values can be specified in an implicit or explicit way.
Note: bpmnlint comes with a list of built-in rules: label-required, start-event-required, and end-event-required.
If the specified value for a rule is a number, it will hold the rule status flag:
{
"rules": {
"label-required": "warn"
}
}
bpmnlint will then look for the rule first in the built-in rules. If not found, bpmnlint will look for the rule in the npm packages installed as **bpmn-**rule-name (e.g. bpmn-no-implicit-parallel-gateway).
Important: if you're referring to a non built-in rule, make sure to have it installed as an npm dependency.
If the specified value for a rule is an object, it will hold the following information:
{
"plugins": [
"custom-rules"
],
"rules": {
"custom-rules/some-custom-rule": "error"
}
}
Important: The rule needs to have a suffix of 'bpmnlint-'.
Custom rules can be added in two ways:
Please check out the example of no-implicit-parallel-gateway
{
"plugins": [
"custom-rules"
],
"rules": {
"custom-rules/some-custom-rule": "error"
}
}
Please check out bpmn-js-bpmnlint.
1.0.0-alpha5
Initial stable release.
FEAT
: configure, resolve and execute local and external rulesFEAT
: extend external configuration via extends
FEAT
: make rule and configuration resolution asyncFEAT
: provide bpmnlint:recommended
configurationCHORE
: linter
is now a constructor, offering a #lint(moddleElement, config)
methodCHORE
: moved library to bpmn-io/bpmnlintCHORE
: full rewrite of internalsCHORE
: utils
API changeCheck git log
for earlier history.
FAQs
Validate your BPMN diagrams based on configurable lint rules
The npm package bpmnlint receives a total of 18,772 weekly downloads. As such, bpmnlint popularity was classified as popular.
We found that bpmnlint demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
NIST has failed to meet its self-imposed deadline of clearing the NVD's backlog by the end of the fiscal year. Meanwhile, CVE's awaiting analysis have increased by 33% since June.
Security News
Cloudflare has launched a setup wizard allowing users to easily create and manage a security.txt file for vulnerability disclosure on their websites.
Security News
The Socket Research team breaks down a malicious npm package targeting the legitimate DOMPurify library. It uses obfuscated code to hide that it is exfiltrating browser and crypto wallet data.