eslint-plugin-vue-kuzzle

eslint-plugin-kuzzle

The Kuzzle coding standard, packaged as ESLint plugins.

This monorepo publishes two independent packages. They do not depend on each other — a full-stack repository installs both, one per workspace.

Package	For	Version
eslint-plugin-kuzzle	Node.js / TypeScript backends, plugins, SDKs
eslint-plugin-vue-kuzzle	Vue.js 3 frontends

📖 Full documentation

Quick start

Backend:

npm i -D eslint eslint-plugin-kuzzle

// eslint.config.mjs
import kuzzle from 'eslint-plugin-kuzzle';

export default [
  { ignores: ['dist/**'] },
  ...kuzzle.configs.default,
  ...kuzzle.configs.node,
  ...kuzzle.configs.typescript,
];

Vue.js:

npm i -D eslint eslint-plugin-vue-kuzzle

// eslint.config.mjs
import vueKuzzle from 'eslint-plugin-vue-kuzzle';

export default [{ ignores: ['dist/**'] }, ...vueKuzzle.configs.default];

Both packages are ESM and ship flat configs only: .eslintrc.json and the plugin:kuzzle/* syntax are gone. Both are standalone — everything they compose is a dependency, so a consuming project only needs eslint itself.

Custom rules

Shipped by eslint-plugin-kuzzle, under the kuzzle namespace:

Requirements

Repository layout

packages/backend/    eslint-plugin-kuzzle       — configs + custom rules + tests
packages/frontend/   eslint-plugin-vue-kuzzle   — Vue configs + importOptions helper
doc/1/               the pages published at docs.kuzzle.io/official-plugins/eslint/1/
doc/2/               the pages published at docs.kuzzle.io/official-plugins/eslint/2/

Development

npm ci          # install every workspace
npm run build   # turbo run build   — tsc, lib/ → dist/
npm run lint    # turbo run lint    — lints the plugins themselves
npm run test    # turbo run test    — vitest, RuleTester

The tasks run through Turborepo and are cached; the per-package scripts live in each packages/*/package.json.

See CONTRIBUTING.md for commit conventions, branches and the release process.