Skip to content
This repository was archived by the owner on Mar 7, 2025. It is now read-only.

Commit 6ac464b

Browse files
committed
Update README.md
1 parent 02090c3 commit 6ac464b

File tree

1 file changed

+9
-13
lines changed

1 file changed

+9
-13
lines changed

README.md

Lines changed: 9 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -23,13 +23,6 @@
2323

2424
Provide a `defineConfig` function for `.eslintrc.js`, and a `defineFlatConfig` function for `eslint.config.js` files.
2525

26-
> This project is written by a human and only partially automatically generated!
27-
> Some rules are even enhanced by hand!
28-
> Unfortunately, this has the disadvantage that not everything is immediately defined. For example, if a rule is not defined, it falls back to a basic definition.
29-
> However, the advantage is that you get documentation for pretty much everything in the code and usually get a direct link to the respective plugin or eslint rule. The types are also strictly typed.
30-
>
31-
> So if you are missing something like a rule or a plugin that should also be supported or a rule definition is e.g. out of date, feel free to open an issue or PR for it.
32-
3326
# Installation
3427

3528
```bash
@@ -43,18 +36,19 @@ pnpm add --save-dev eslint eslint-define-config
4336

4437
# Usage
4538

39+
By default only `eslint`'s rules are supported. To activate auto-suggestions for Rules of specific plugins, you need to install the respective types for that plugin.
40+
Plugins can either support their own types, or they could be supported by the community in the [`@eslint-types`](https://github.com/eslint-types/define-config-plugin-types) repository.
41+
42+
A list of community supported plugins can be found [here](https://www.npmjs.com/org/eslint-types).
43+
4644
`.eslintrc.js`
4745

4846
```ts
4947
// @ts-check
50-
51-
// To activate auto-suggestions for Rules of specific plugins, you need to add a `/// <reference types="eslint-plugin-PLUGIN_NAME/define-config-support" />` comment.
52-
// ⚠️ This feature is very new and requires the support of the respective plugin owners.
53-
54-
/// <reference types="@typescript-eslint/eslint-plugin/define-config-support" />
55-
5648
const { defineConfig } = require('eslint-define-config');
5749

50+
/// <reference types="@eslint-types/typescript-eslint" />
51+
5852
module.exports = defineConfig({
5953
root: true,
6054
rules: {
@@ -71,6 +65,8 @@ module.exports = defineConfig({
7165
// @ts-check
7266
const { defineFlatConfig } = require('eslint-define-config');
7367

68+
/// <reference types="@eslint-types/typescript-eslint" />
69+
7470
module.exports = defineFlatConfig([
7571
'eslint:recommended',
7672
{

0 commit comments

Comments
 (0)