{"id":13640624,"url":"https://github.com/bpmn-io/bpmnlint","last_synced_at":"2026-02-03T13:00:40.773Z","repository":{"id":32879251,"uuid":"144814732","full_name":"bpmn-io/bpmnlint","owner":"bpmn-io","description":"Validate BPMN diagrams based on configurable lint rules.","archived":false,"fork":false,"pushed_at":"2026-01-20T14:50:45.000Z","size":4426,"stargazers_count":152,"open_issues_count":16,"forks_count":45,"subscribers_count":10,"default_branch":"main","last_synced_at":"2026-01-21T03:14:33.877Z","etag":null,"topics":["bpmn","cli","hacktoberfest","linter","static-diagram-analysis","validator"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/bpmn-io.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2018-08-15T06:31:46.000Z","updated_at":"2026-01-20T14:56:50.000Z","dependencies_parsed_at":"2023-01-14T22:31:27.690Z","dependency_job_id":"5ec05a4e-0e0f-4700-8098-b6d4164461b0","html_url":"https://github.com/bpmn-io/bpmnlint","commit_stats":null,"previous_names":[],"tags_count":72,"template":false,"template_full_name":null,"purl":"pkg:github/bpmn-io/bpmnlint","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bpmn-io%2Fbpmnlint","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bpmn-io%2Fbpmnlint/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bpmn-io%2Fbpmnlint/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bpmn-io%2Fbpmnlint/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bpmn-io","download_url":"https://codeload.github.com/bpmn-io/bpmnlint/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bpmn-io%2Fbpmnlint/sbom","scorecard":{"id":249866,"data":{"date":"2025-08-11","repo":{"name":"github.com/bpmn-io/bpmnlint","commit":"648bc39495e97eb54492590d9a0c53b3c446b161"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":4.8,"checks":[{"name":"Maintained","score":10,"reason":"12 commit(s) and 1 issue activity found in the last 90 days -- score normalized to 10","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Code-Review","score":3,"reason":"Found 10/26 approved changesets -- score normalized to 3","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/CI.yml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Pinned-Dependencies","score":6,"reason":"dependency not pinned by hash detected -- score normalized to 6","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/CI.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/bpmn-io/bpmnlint/CI.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/CI.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/bpmn-io/bpmnlint/CI.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/CI.yml:25: update your workflow using https://app.stepsecurity.io/secureworkflow/bpmn-io/bpmnlint/CI.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/CI.yml:37: update your workflow using https://app.stepsecurity.io/secureworkflow/bpmn-io/bpmnlint/CI.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/CI.yml:39: update your workflow using https://app.stepsecurity.io/secureworkflow/bpmn-io/bpmnlint/CI.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/CI.yml:57: update your workflow using https://app.stepsecurity.io/secureworkflow/bpmn-io/bpmnlint/CI.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/CI.yml:59: update your workflow using https://app.stepsecurity.io/secureworkflow/bpmn-io/bpmnlint/CI.yml/main?enable=pin","Info:   0 out of   6 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   1 third-party GitHubAction dependencies pinned","Info:   3 out of   3 npmCommand dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'main'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"Security-Policy","score":10,"reason":"security policy file detected","details":["Info: security policy file detected: github.com/bpmn-io/.github/SECURITY.md:1","Info: Found linked content: github.com/bpmn-io/.github/SECURITY.md:1","Info: Found disclosure, vulnerability, and/or timelines in security policy: github.com/bpmn-io/.github/SECURITY.md:1","Info: Found text in security policy: github.com/bpmn-io/.github/SECURITY.md:1"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 15 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Vulnerabilities","score":1,"reason":"9 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-968p-4wvh-cqc8","Warn: Project is vulnerable to: GHSA-xffm-g5w8-qvg7","Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw","Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg","Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275","Warn: Project is vulnerable to: GHSA-8cj5-5rvv-wf4v","Warn: Project is vulnerable to: GHSA-gcx4-mw62-g8wm","Warn: Project is vulnerable to: GHSA-76p7-773f-r4q5","Warn: Project is vulnerable to: GHSA-4vvj-4cpr-p986"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-17T08:14:24.447Z","repository_id":32879251,"created_at":"2025-08-17T08:14:24.448Z","updated_at":"2025-08-17T08:14:24.448Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29046502,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-03T10:09:22.136Z","status":"ssl_error","status_checked_at":"2026-02-03T10:09:16.814Z","response_time":96,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bpmn","cli","hacktoberfest","linter","static-diagram-analysis","validator"],"created_at":"2024-08-02T01:01:12.888Z","updated_at":"2026-02-03T13:00:40.766Z","avatar_url":"https://github.com/bpmn-io.png","language":"JavaScript","funding_links":[],"categories":["Extensions","Testing/Validation"],"sub_categories":["Legacy Standards"],"readme":"# bpmnlint\n\n[![CI](https://github.com/bpmn-io/bpmnlint/actions/workflows/CI.yml/badge.svg)](https://github.com/bpmn-io/bpmnlint/actions/workflows/CI.yml)\n\nValidate your BPMN diagrams based on configurable lint rules.\n\n\n## Installation\n\nInstall the utility via [npm](https://www.npmjs.com/package/bpmnlint):\n\n```sh\nnpm install -g bpmnlint\n```\n\n\n## Usage\n\nValidate your diagrams via the commandline:\n\n```sh\n\u003e bpmnlint invoice.bpmn\n\n/Projects/process-application/resources/invoice.bpmn\n  Flow_1    error    Sequence flow is missing condition  conditional-flows\n  Process   error    Process is missing end event        end-event-required\n  Task_13   warning  Element is missing label/name       label-required\n  Event_12  warning  Element is missing label/name       label-required\n  Event_27  warning  Element is missing label/name       label-required\n  Process   error    Process is missing start event      start-event-required\n\n✖ 6 problems (6 errors, 0 warnings)\n```\n\n\n## Rules\n\nOur [documentation](https://github.com/bpmn-io/bpmnlint/tree/main/docs/rules#rules) lists all currenty implemented rules, the [`./rules` folder](https://github.com/bpmn-io/bpmnlint/tree/main/rules) contains each rules implementation.\n\nDo you miss a rule that should be included? [Propose a new rule](https://github.com/bpmn-io/bpmnlint/issues/new?assignees=\u0026labels=rules\u0026template=NEW_RULE.md).\n\n\n## Configuration\n\nCreate a `.bpmnlintrc` file in your working directory and inherit from a common configuration using the `extends` block:\n\n```json\n{\n  \"extends\": \"bpmnlint:recommended\"\n}\n```\n\nAdd or customize rules using the `rules` block:\n\n```json\n{\n  \"extends\": \"bpmnlint:recommended\",\n  \"rules\": {\n    \"label-required\": \"off\"\n  }\n}\n```\n\nYou may also extend from multiple configurations, including those provided by [custom plug-ins](#writing-a-plug-in):\n\n```json\n{\n  \"extends\": [\n    \"bpmnlint:recommended\",\n    \"plugin:foo/recommended\",\n    \"plugin:@bar/bpmnlint-plugin-bar/recommended\"\n  ]\n}\n```\n\nThis will amend core `recommended` rules with `recommended` rulesets provided by `bpmnlint-plugin-foo` and `@bar/bpmnlint-plugin-bar`, respectively.\n\nPlug-ins will be resolved relative to the configuration file location, using [node module resolution](https://nodejs.org/api/modules.html#loading-from-node_modules-folders).\n\n\n### Available Configurations\n\n* [`bpmnlint:all`](./config/all.js) - all rules as errors\n* [`bpmnlint:recommended`](./config/recommended.js) - opinionated rules (\"best practices\") and rules enforcing BPMN compliance\n* [`bpmnlint:correctness`](./config/correctness.js) - rules enforcing BPMN compliance\n\n### Moddle extensions\n\nTo validate your diagrams with custom [moddle](https://github.com/bpmn-io/moddle) extensions, add `moddleExtensions` to the root configuration file:\n\n```json\n{\n  \"extends\": [\n    \"bpmnlint:recommended\",\n    \"plugin:custom/recommended\"\n  ],\n  \"moddleExtensions\": {\n    \"custom\": \"custom-bpmn-moddle/resources/custom.json\"\n  }\n}\n```\n\nThe extension will be resolved relative to the configuration file location, using [node module resolution](https://nodejs.org/api/modules.html#loading-from-node_modules-folders).\n\n## API\n\nInvoke the tool directly from [NodeJS](https://nodejs.org/en):\n\n```javascript\nimport Linter from 'bpmnlint';\nimport NodeResolver from 'bpmnlint/lib/resolver/node-resolver';\n\nimport BpmnModdle from 'bpmn-moddle';\n\nconst moddle = new BpmnModdle();\n\nconst linter = new Linter({ \n  config: {\n    extends: 'bpmnlint:recommended'\n  },\n  resolver: new NodeResolver()\n});\n\nconst xmlStr = `\n  \u003c?xml version=\"1.0\" encoding=\"UTF-8\"?\u003e\n  \u003cbpmn:definitions xmlns:bpmn=\"http://www.omg.org/spec/BPMN/20100524/MODEL\" \n                     id=\"definitions\" \n                     targetNamespace=\"http://bpmn.io/schema/bpmn\"\u003e\n    \u003cbpmn:process id=\"process\" /\u003e\n  \u003c/bpmn:definitions\u003e\n`;\n\nconst {\n  rootElement: definitions\n} = await moddle.fromXML(xmlStr);\n\nconst reports = linter.lint(definitions);\n\n// {\n//    \"end-event-required\": [\n//      {\n//        \"id\": \"process\",\n//        \"message\": \"Process is missing end event\"\n//      }\n//    ],\n//    ...\n// }\n```\n\n\n## Writing a Plug-in\n\nCreate your first plug-in using the [plugin creator](https://github.com/nikku/create-bpmnlint-plugin):\n\n```sh\nnpm init bpmnlint-plugin {PLUGIN_NAME}\n```\n\nCheckout the [bpmnlint-plugin-example](https://github.com/bpmn-io/bpmnlint-plugin-example) for details on how to define, test, and consume custom lint rules. Use the [bpmnlint playground](https://github.com/bpmn-io/bpmnlint-playground) to implement new rules with quick visual feedback.\n\n\u003e [!NOTE]\n\u003e Plug-ins must always follow the naming scheme `bpmnlint-plugin-{NAME_OF_YOUR_PLUGIN}` and may contain a namespace prefix.\n\nWhen using your custom plug-in, reference its configuration or rules via the shorthand plug-in name, or the full identifier:\n\n```json\n{\n  \"extends\": [\n    \"bpmnlint:recommended\",\n    \"plugin:foo/recommended\",\n    \"plugin:@bar/bpmnlint-plugin-bar/recommended\"\n  ],\n  \"rules\": {\n    \"foo/special-rule\": \"off\",\n    \"@bar/bar/other-rule\": \"warn\"\n  }\n}\n```\n\n\n## Bundling\n\nFor browser usage include your [linting configuration](#configuration) using your favorite bundler plug-in ([Rollup](https://www.npmjs.com/package/rollup-plugin-bpmnlint), [Webpack](https://www.npmjs.com/package/bpmnlint-loader)).\n\n\n## Visual Feedback\n\nIntegrate the linter via [bpmn-js-bpmnlint](https://github.com/bpmn-io/bpmn-js-bpmnlint) into [bpmn-js](https://github.com/bpmn-io/bpmn-js) and get direct feedback during modeling.\n\nTo try out visual validation, checkout the [bpmnlint playground](https://github.com/bpmn-io/bpmnlint-playground).\n\n\n## Related\n\n* [bpmnlint-plugin-example](https://github.com/bpmn-io/bpmnlint-plugin-example) - an example plug-in\n* [bpmnlint-playground](https://github.com/bpmn-io/bpmnlint-playground) - a playground to implement new rules with quick visual feedback\n* [bpmnlint-generate-docs-images](https://github.com/bpmn-io/bpmnlint-generate-docs-images) - Generate images for your bpmnlint documentation\n* [bpmn-js-bpmnlint](https://github.com/bpmn-io/bpmn-js-bpmnlint) - integration into [bpmn-js](https://github.com/bpmn-io/bpmn-js)\n\n\n## License\n\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbpmn-io%2Fbpmnlint","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbpmn-io%2Fbpmnlint","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbpmn-io%2Fbpmnlint/lists"}