eslint-plugin-camunda-licensed

1.1.0 verified Fri May 01 auth: no javascript

An ESLint plugin providing shared lint configurations for Camunda-licensed open source projects. Version 1.1.0 is the current stable release. It enforces license headers (MIT, commercial, Apache 2.0) via predefined flat configs. Key differentiator: specifically tailored for Camunda OSS projects, integrates with eslint-plugin-license-header, and requires ESLint 9+. Release cadence is irregular; major v1.0.0 introduced flat config support, breaking from legacy .eslintrc format.

Common errors

error ESLint couldn't find the plugin "eslint-plugin-camunda-licensed". ↓

cause Plugin is not installed or not in node_modules.

fix

Run npm install eslint-plugin-camunda-licensed --save-dev.

error Error: Flat config plugin imported as CommonJS ↓

cause Using require() instead of import for the plugin.

fix

Use import camundaLicensedPlugin from 'eslint-plugin-camunda-licensed' and ensure your config file is an ES module (set type:module in package.json).

error Configuration for rule "camunda-licensed/license-header" is invalid ↓

cause Incorrect rule options or missing configuration.

fix

Use one of the predefined configs (mit, commercial, apache) via camundaLicensedPlugin.configs.mit instead of manually specifying rule options.

Warnings

breaking v1.0.0 drops support for legacy .eslintrc format; only ESLint 9 flat config is supported. ↓

fix Migrate your ESLint config to the flat config format (use eslint.config.js).

breaking v1.0.0 requires ESLint 9; version ^9 is a peer dependency. ↓

fix Upgrade ESLint to version 9 or later.

gotcha The plugin uses eslint-plugin-license-header internally to enforce headers. Make sure eslint-plugin-license-header is installed (it's a dependency, not peer). ↓

fix Ensure eslint-plugin-license-header is in your node_modules (it's installed automatically with the plugin).

deprecated Older v0.x versions used .eslintrc config format and ESLint < 9. They are now deprecated. ↓

fix Upgrade to v1.0.0+ and rewrite config to flat format.

Install

npm install eslint-plugin-camunda-licensed

yarn add eslint-plugin-camunda-licensed

pnpm add eslint-plugin-camunda-licensed

Imports

default

wrong

const camundaLicensedPlugin = require('eslint-plugin-camunda-licensed')

correct

import camundaLicensedPlugin from 'eslint-plugin-camunda-licensed'

ESM-only; CommonJS require is unsupported for flat config plugins in ESLint 9.

configs

wrong

import { configs } from 'eslint-plugin-camunda-licensed/configs'

correct

import { configs } from 'eslint-plugin-camunda-licensed'

configs is a named export from the main entry point, not a subpath.

rules
```
import { rules } from 'eslint-plugin-camunda-licensed'
```
Rules are accessible but typically used indirectly via configs.

Quickstart

Show how to import the plugin and use its MIT configuration in an ESLint flat config.

// eslint.config.js
import camundaLicensedPlugin from 'eslint-plugin-camunda-licensed';

export default [
  // Apply MIT license header rule to all source files
  ...camundaLicensedPlugin.configs.mit,
  {
    files: ['**/*.js'],
    rules: {
      // Customize rule options if needed
    }
  }
];

// Then run: eslint --fix to add license headers.