You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
We are working on support for Svelte v5, but it is still an experimental feature. Please note that rules and features related to Svelte v5 may be changed or removed in minor versions without notice.
33
+
`eslint-plugin-svelte` is the official [ESLint](https://eslint.org/) plugin for [Svelte](https://svelte.dev/).
34
+
It offers a variety of unique linting rules by leveraging the AST generated by [svelte-eslint-parser](https://github.com/sveltejs/svelte-eslint-parser).
35
+
It provides a variety of unique linting rules by utilizing the template AST.
44
36
45
-
<!--DOCS_IGNORE_START-->
37
+
> [!WARNING]
38
+
> The [svelte-eslint-parser](https://github.com/sveltejs/svelte-eslint-parser) and `eslint-plugin-svelte` cannot be used alongside [eslint-plugin-svelte3](https://github.com/sveltejs/eslint-plugin-svelte3).
46
39
47
-
## Versioning policy
48
-
49
-
This plugin follows [Semantic Versioning](https://semver.org/).
50
-
However, unlike [ESLint’s Semantic Versioning Policy](https://github.com/eslint/eslint#semantic-versioning-policy), this plugin adds new rules to its configs even in minor releases. For example, if you are using the recommended config, a minor update may add new rules, which could cause new lint errors in your project.
51
-
While [ESLint’s Semantic Versioning Policy](https://github.com/eslint/eslint#semantic-versioning-policy) only adds new rules to configs in major releases, most users (myself included) don’t regularly monitor new rules. This makes it challenging to manually add them to projects whenever they are introduced.
52
-
By adding new rules to configs in minor releases, this plugin ensures users can adopt them more easily. If any new rules cause issues, you can simply disable them. I believe this approach helps maintain and improve code quality with minimal effort.
40
+
<!--DOCS_IGNORE_START-->
53
41
54
42
## Migration Guide
55
43
56
44
To migrate from `eslint-plugin-svelte` v1, or [`@ota-meshi/eslint-plugin-svelte`](https://www.npmjs.com/package/@ota-meshi/eslint-plugin-svelte), please refer to the [migration guide](https://sveltejs.github.io/eslint-plugin-svelte/migration/).
57
45
58
-
## :book: Documentation
46
+
## Installation
59
47
60
-
See [documents](https://sveltejs.github.io/eslint-plugin-svelte/).
61
-
62
-
## :cd: Installation
48
+
> [!NOTE]
49
+
>
50
+
> **Requirements**
51
+
>
52
+
> - ESLint v8.57.1, v9.0.0, and above
53
+
> - Node.js v18.20.4, v20.18.0, v22.10.0, and above
> - Node.js v18.20.4, v20.18.0, v22.10.0 and above
72
-
73
59
<!--DOCS_IGNORE_END-->
74
60
75
61
## :book: Usage
@@ -302,6 +288,13 @@ Example **.vscode/settings.json**:
302
288
<!--USAGE_GUIDE_END-->
303
289
<!--USAGE_SECTION_END-->
304
290
291
+
## Versioning policy
292
+
293
+
This plugin follows [Semantic Versioning](https://semver.org/).
294
+
However, unlike [ESLint’s Semantic Versioning Policy](https://github.com/eslint/eslint#semantic-versioning-policy), this plugin adds new rules to its configs even in minor releases. For example, if you are using the recommended config, a minor update may add new rules, which could cause new lint errors in your project.
295
+
While [ESLint’s Semantic Versioning Policy](https://github.com/eslint/eslint#semantic-versioning-policy) only adds new rules to configs in major releases, most users (myself included) don’t regularly monitor new rules. This makes it challenging to manually add them to projects whenever they are introduced.
296
+
By adding new rules to configs in minor releases, this plugin ensures users can adopt them more easily. If any new rules cause issues, you can simply disable them. I believe this approach helps maintain and improve code quality with minimal effort.
Copy file name to clipboardExpand all lines: docs/README.md
+12-40Lines changed: 12 additions & 40 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,52 +4,24 @@ title: 'eslint-plugin-svelte'
4
4
5
5
# Introduction
6
6
7
-
`eslint-plugin-svelte` is the official [ESLint] plugin for [Svelte].
8
-
It provides many unique check rules by using the template AST.
9
-
You can check on the [Online DEMO](https://eslint-online-playground.netlify.app/#eslint-plugin-svelte%20with%20typescript).
7
+
`eslint-plugin-svelte` is the official [ESLint](https://eslint.org/) plugin for [Svelte](https://svelte.dev/).
8
+
It offers a variety of unique linting rules by leveraging the AST generated by [svelte-eslint-parser](https://github.com/sveltejs/svelte-eslint-parser).
9
+
It provides a variety of unique linting rules by utilizing the template AST.
10
10
11
-
> [!NOTE]
12
-
> This document is in development.\
13
-
> Please refer to the document for the version you are using.\
14
-
> For example, <https://github.com/sveltejs/eslint-plugin-svelte/blob/eslint-plugin-svelte%402.46.0/README.md>
15
-
> and <https://github.com/sveltejs/eslint-plugin-svelte/blob/eslint-plugin-svelte%402.46.0/docs>
We are working on support for Svelte v5, but it is still an experimental feature. Please note that rules and features related to Svelte v5 may be changed or removed in minor versions without notice.
11
+
> [!WARNING]
12
+
> The [svelte-eslint-parser](https://github.com/sveltejs/svelte-eslint-parser) and `eslint-plugin-svelte` cannot be used alongside [eslint-plugin-svelte3](https://github.com/sveltejs/eslint-plugin-svelte3).
48
13
49
14
## :book: Usage
50
15
51
16
See [User Guide](./user-guide.md).
52
17
18
+
## Versioning policy
19
+
20
+
This plugin follows [Semantic Versioning](https://semver.org/).
21
+
However, unlike [ESLint’s Semantic Versioning Policy](https://github.com/eslint/eslint#semantic-versioning-policy), this plugin adds new rules to its configs even in minor releases. For example, if you are using the recommended config, a minor update may add new rules, which could cause new lint errors in your project.
22
+
While [ESLint’s Semantic Versioning Policy](https://github.com/eslint/eslint#semantic-versioning-policy) only adds new rules to configs in major releases, most users (myself included) don’t regularly monitor new rules. This makes it challenging to manually add them to projects whenever they are introduced.
23
+
By adding new rules to configs in minor releases, this plugin ensures users can adopt them more easily. If any new rules cause issues, you can simply disable them. I believe this approach helps maintain and improve code quality with minimal effort.
0 commit comments