Gathering detailed insights and metrics for bpmn-js-bpmnlint
Gathering detailed insights and metrics for bpmn-js-bpmnlint
Installations
npm install bpmn-js-bpmnlintDeveloper
bpmn-io
Developer Guide
BETA
Module System
CommonJS
Min. Node Version
Typescript Support
No
Node Version
20.11.1
NPM Version
10.2.4
Statistics
50 Stars
299 Commits
14 Forks
8 Watching
4 Branches
12 Contributors
Updated on 06 Nov 2024
Bundle Size
12.63 kB
Minified
4.69 kB
Minified + Gzipped
Languages
JavaScript (91.05%)
CSS (8.95%)
Total Downloads
Cumulative downloads
Total Downloads
802,589
Last day
10.5%
1,981
Compared to previous day
Last week
-1.6%
9,615
Compared to previous week
Last month
-10.7%
41,803
Compared to previous month
Last year
55.9%
329,331
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Peer Dependencies
3
Dev Dependencies
28
chaicpx2karmamochasinoneslintrollupbpmn-jswebpackbpmnlintcross-envpuppeteerdiagram-jssinon-chaikarma-mochanpm-run-all2karma-webpackbpmnlint-loaderkarma-sinon-chaikarma-debug-launcherrollup-plugin-string@rollup/plugin-tersereslint-plugin-bpmn-iokarma-chrome-launcherkarma-env-preprocessor@rollup/plugin-commonjs@rollup/plugin-node-resolvemocha-test-container-support
Versions
bpmn-js-bpmnlint
Integrates bpmnlint into bpmn-js.
See this extension in action as part of the bpmnlint playground.
Usage
Integrate the linter into bpmn-js:
1import lintModule from 'bpmn-js-bpmnlint'; 2 3import 'bpmn-js-bpmnlint/dist/assets/css/bpmn-js-bpmnlint.css'; 4 5import BpmnModeler from 'bpmn-js/lib/Modeler'; 6 7import bpmnlintConfig from './.bpmnlintrc'; 8 9const modeler = new BpmnModeler({ 10 linting: { 11 bpmnlint: bpmnlintConfig 12 }, 13 additionalModules: [ 14 lintModule 15 ] 16});
Bundle Lint Rules
Use an appropriate plugin/loader for your module bundler (cf. rollup-plugin-bpmnlint, bpmnlint-loader) to bundle the bpmnlint configuration directly with your application as shown above.
Alternatively, pack your local .bpmnlintrc file using the bpmnlint-pack-config utility:
1bpmnlint-pack-config -c .bpmnlintrc -o bundled-config.js
Plug-in Lint Rules
Provide the packed lint rules via the linting.bpmnlint option. You may set it dynamically, too:
1const linting = modeler.get('linting'); 2 3linting.setLinterConfig(bpmnlintConfig);
Resources
Development Setup
npm install
npm run dev
License
MIT
No vulnerabilities found.
Reason
no binaries found in the repo
Reason
no dangerous workflow patterns detected
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Info: FSF or OSI recognized license: MIT License: LICENSE:0
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
Reason
9 commit(s) and 1 issue activity found in the last 90 days -- score normalized to 8
Reason
2 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-7q7g-4xm8-89cq
- Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
Reason
dependency not pinned by hash detected -- score normalized to 2
Details
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/CI.yml:18: update your workflow using https://app.stepsecurity.io/secureworkflow/bpmn-io/bpmn-js-bpmnlint/CI.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/CI.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/bpmn-io/bpmn-js-bpmnlint/CI.yml/main?enable=pin
- Warn: npmCommand not pinned by hash: .github/workflows/CI.yml:29
- Info: 0 out of 2 GitHub-owned GitHubAction dependencies pinned
- Info: 1 out of 2 npmCommand dependencies pinned
Reason
Found 1/13 approved changesets -- score normalized to 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
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
branch protection not enabled on development/release branches
Details
- Warn: branch protection not enabled for branch 'main'
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 18 are checked with a SAST tool
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