Registry / testing / eslint-plugin-bpmn-io

eslint-plugin-bpmn-io

library2.2.0jsnpmunverified

Shared ESLint plugin for bpmn.io projects, providing lint configurations and rules for browser, node, and testing environments. Current stable version is 2.2.0 (2024). Release cadence: major updates align with ESLint major releases. Key differentiators: tailored for bpmn.io ecosystem, includes recommended profiles for common setups (browser, node, mocha, JSX), and uses flat configs (ESLint 9+) since v2.0.0. Supports ES2022 by default.

testing

npm install eslint-plugin-bpmn-io

github ↗package ↗

INSTALL

IMPORT

SIG · ESLINT-PLUGIN-BPMN

eslint-plugin-bpmn-io

testingjavascriptv2.2.0

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

bpmnIoPlugin

✓ import bpmnIoPlugin from 'eslint-plugin-bpmn-io'

✗ const bpmnIoPlugin = require('eslint-plugin-bpmn-io')

ESM-only since v2.0.0; CommonJS require() throws ERR_REQUIRE_ESM.

configs.recommended

✓ bpmnIoPlugin.configs.recommended

✗ require('eslint-plugin-bpmn-io').configs.recommended

Access configs after default import; v1 used extends arrays in .eslintrc.

configs.browser

✓ bpmnIoPlugin.configs.browser

One of several top-level configs; similar for node, mocha, jsx.

Shows how to use the plugin with flat config (ESLint 9+), spreading the recommended config and adding custom rules.

import bpmnIoPlugin from 'eslint-plugin-bpmn-io'; export default [ ...bpmnIoPlugin.configs.recommended, { rules: { 'no-console': 'warn' } } ];

Debug

Known issues

breakingv2.0.0 migrated to ES modules and flat config; requires ESLint ^9.

fix

Update to ESLint 9 and use import syntax; remove .eslintrc and use flat config array.

affects: >=2.0.0

deprecatedv1.x is deprecated; uses legacy .eslintrc format and eslint <9.

fix

Upgrade to v2.0.0+ and migrate to flat config.

affects: <2.0.0

gotchaPlugin configs must be spread into array; using them as single config object fails.

fix

Use ...bpmnIoPlugin.configs.recommended (spread operator) in export default array.

affects: >=2.0.0

gotchaThe 'mocha' config must be applied only to test files via 'files' property.

fix

Map configs and add files: ['**/*.spec.js'] or similar.

affects: >=2.0.0

Errors

Common errors & fixes

Error: Cannot find module 'eslint-plugin-bpmn-io'

Package not installed or missing from dependencies.

fix

npm install --save-dev eslint-plugin-bpmn-io

Error [ERR_REQUIRE_ESM]: require() of ES Module not supported.

Using CommonJS require() with ESM-only plugin (v2+).

fix

Use import statement or set type: 'module' in package.json.

Configuration for rule 'import/no-unresolved' is invalid: Value "error" is the wrong shape.

Using .eslintrc (legacy) with v2 plugin that expects flat config.

fix

Migrate to eslint.config.js flat config and ESLint 9.

Definition for rule 'no-console' was not found.

Plugin not properly loaded in flat config; missing import.

fix

Add import bpmnIoPlugin from 'eslint-plugin-bpmn-io' and include its configs.

Upgrade

Version history

2.2.0latest on npm

Audit

Dependencies

eslintrequiredpeer dependency; plugin requires ESLint ^9

Agent activity

6 hits · last 30 days

node

Resources

githubhttps://github.com/bpmn-io/eslint-plugin-bpmn-io ↗

packagehttps://www.npmjs.com/package/eslint-plugin-bpmn-io ↗