# eslint-plugin-ckeditor5-rules

> CKEditor 5 ESLint preset.

Latest version **21.0.0** (published 2026-09-10) · MIT license · 0 weekly downloads

## Install

```sh
npm install eslint-plugin-ckeditor5-rules
pnpm add eslint-plugin-ckeditor5-rules
yarn add eslint-plugin-ckeditor5-rules
bun add eslint-plugin-ckeditor5-rules
```

## Health

**Score 55/100 (C)** — status: active.

Positive: no vulnerabilities; recently updated; high maintenance score.

Warnings: low downloads; no types; no esm support.

## Facts

| | |
|---|---|
| Version | 21.0.0 |
| Published | 2026-09-10 |
| First published | 2018-12-19 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=24.11.0 |
| Dependencies | 7 |
| Unpacked size | 147.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | CKSource |
| Maintainers | ckeditor |
| Keywords | eslint, imports, config, lint, ckeditor, eslintplugin |

## Links

- npm: https://www.npmjs.com/package/eslint-plugin-ckeditor5-rules
- Repository: https://github.com/ckeditor/ckeditor5-linters-config
- Homepage: https://ckeditor.com/ckeditor-5
- Issues: https://github.com/ckeditor/ckeditor5/issues
- npm.io page: https://npm.io/package/eslint-plugin-ckeditor5-rules

## Dependencies (7)

- [yaml](https://npm.io/package/yaml.md) ^2.8.0
- [upath](https://npm.io/package/upath.md) ^2.0.1
- [resolve.exports](https://npm.io/package/resolve.exports.md) ^2.0.2
- [@eslint/css-tree](https://npm.io/package/@eslint/css-tree.md) ^4.0.4
- [enhanced-resolve](https://npm.io/package/enhanced-resolve.md) ^5.15.0
- [@es-joy/jsdoccomment](https://npm.io/package/@es-joy/jsdoccomment.md) ^0.50.2
- [validate-npm-package-name](https://npm.io/package/validate-npm-package-name.md) ^6.0.0

## Alternatives

- [eslint-plugin-sonarjs](https://npm.io/package/eslint-plugin-sonarjs.md) — 2.9M weekly downloads
- [eslint-config-expo](https://npm.io/package/eslint-config-expo.md) — 1.5M weekly downloads
- [@matter/protocol](https://npm.io/package/@matter/protocol.md) — 63.5K weekly downloads
- [@eventcatalog/linter](https://npm.io/package/@eventcatalog/linter.md) — 24.8K weekly downloads
- [@inrupt/eslint-config-base](https://npm.io/package/@inrupt/eslint-config-base.md) — 4.5K weekly downloads

## Recent versions

- 21.0.0 (latest) — 2026-09-10
- 13.0.1 (latest-v13) — 2026-03-16
- 10.0.0-alpha.3 (alpha) — 2025-05-14
- 20.1.0 — 2026-09-03
- 20.0.0 — 2026-07-31
- 19.1.0 — 2026-07-30
- 19.0.0 — 2026-07-22
- 18.1.0 — 2026-07-22
- 18.0.0 — 2026-07-17
- 17.1.1 — 2026-07-16
- 17.1.0 — 2026-07-14
- 17.0.0 — 2026-07-01
- 16.1.0 — 2026-06-26
- 16.0.0 — 2026-06-09
- 15.1.0 — 2026-05-05
- … 57 more at https://npm.io/package/eslint-plugin-ckeditor5-rules/versions

## README

CKEditor 5 ESLint plugins
=========================

[![npm version](https://badge.fury.io/js/eslint-plugin-ckeditor5-rules.svg)](https://www.npmjs.com/package/eslint-plugin-ckeditor5-rules)
![Dependency Status](https://img.shields.io/librariesio/release/npm/eslint-plugin-ckeditor5-rules)

A set of plugins used by the [CKEditor 5](https://ckeditor.com) team for [Eslint](https://eslint.org/)

By default this plugin is added to our [`eslint-config-ckeditor5`](https://www.npmjs.com/package/eslint-config-ckeditor5) preset.

## Usage

```
npm i --save-dev eslint-plugin-ckeditor5-rules
```

[Configure ESLint](https://eslint.org/docs/latest/use/configure/configuration-files#configuration-file) using the following contents:

```js
import { defineConfig } from 'eslint/config';
import ckeditor5Rules from 'eslint-plugin-ckeditor5-rules';

export default defineConfig( [
	{
		plugins: {
			'ckeditor5-rules': ckeditor5Rules
		},
		rules: {
			'ckeditor5-rules/no-relative-imports': 'error',
			'ckeditor5-rules/license-header': [ 'error', {
				headerLines: [
					'/**',
					' * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.',
					' * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license',
					' */'
				]
			} ]
			// ...
		}
		// ...
	}
] );
```

## Rules

The list of all ESLint rules published in `eslint-plugin-ckeditor5-rules` package is documented on https://ckeditor.com/docs/ckeditor5/latest/framework/contributing/code-style.html#ckeditor-5-custom-eslint-rules.

---
_Source: https://npm.io/package/eslint-plugin-ckeditor5-rules · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
