wip

Author: baseballyama

README.md

@@ -1,14 +1,4 @@
-# Introduction
-
-`eslint-plugin-svelte` is the official [ESLint] plugin for [Svelte].  
-It provides many unique check rules by using the template AST.  
-You can check on the [Online DEMO](https://eslint-online-playground.netlify.app/#eslint-plugin-svelte%20with%20typescript).
-
-> [!NOTE]
-> This document is in development.\
-> Please refer to the document for the version you are using.\
-> For example, <https://github.com/sveltejs/eslint-plugin-svelte/blob/eslint-plugin-svelte%402.46.0/README.md>
-> and <https://github.com/sveltejs/eslint-plugin-svelte/blob/eslint-plugin-svelte%402.46.0/docs>
+<!--DOCS_IGNORE_START-->
 
 [![NPM license](https://img.shields.io/npm/l/eslint-plugin-svelte.svg)](https://www.npmjs.com/package/eslint-plugin-svelte)
 [![NPM version](https://img.shields.io/npm/v/eslint-plugin-svelte.svg)](https://www.npmjs.com/package/eslint-plugin-svelte)
@@ -24,52 +14,48 @@ You can check on the [Online DEMO](https://eslint-online-playground.netlify.app/
 [![Code Style: Prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://github.com/prettier/prettier)
 [![changesets](https://img.shields.io/badge/maintained%20with-changesets-176de3.svg)](https://github.com/atlassian/changesets)
 
-## :name_badge: What is this plugin?
+<div align="center">
 
-[ESLint] plugin for [Svelte].  
-It provides many unique check rules using the AST generated by [svelte-eslint-parser].
+# eslint-plugin-svelte
 
-### ❗ Attention
+### ESLint plugin for Svelte using AST
 
-#### Cannot be used with eslint-plugin-svelte3
+[Live Demo](https://eslint-online-playground.netlify.app/#eslint-plugin-svelte%20with%20typescript) •
+[Documentation](https://sveltejs.github.io/eslint-plugin-svelte/) •
+[Discord](https://svelte.dev/chat)
 
-The [svelte-eslint-parser] and the `eslint-plugin-svelte` can not be used with the [eslint-plugin-svelte3].
+</div>
 
-[svelte-eslint-parser]: https://github.com/sveltejs/svelte-eslint-parser
-[eslint-plugin-svelte3]: https://github.com/sveltejs/eslint-plugin-svelte3
-
-#### Experimental support for Svelte v5
+<!--DOCS_IGNORE_END-->
 
-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.
+# Introduction
 
-<!--DOCS_IGNORE_START-->
+`eslint-plugin-svelte` is the official [ESLint](https://eslint.org/) plugin for [Svelte](https://svelte.dev/).  
+It offers a variety of unique linting rules by leveraging the AST generated by [svelte-eslint-parser](https://github.com/sveltejs/svelte-eslint-parser).  
+It provides a variety of unique linting rules by utilizing the template AST.
 
-## Versioning policy
+> [!WARNING]
+> 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).
 
-This plugin follows [Semantic Versioning](https://semver.org/).  
-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.  
-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.  
-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.
+<!--DOCS_IGNORE_START-->
 
 ## Migration Guide
 
 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/).
 
-## :book: Documentation
-
-See [documents](https://sveltejs.github.io/eslint-plugin-svelte/).
+## Installation
 
-## :cd: Installation
+> [!NOTE]
+>
+> **Requirements**
+>
+> - ESLint v8.57.1, v9.0.0, and above
+> - Node.js v18.20.4, v20.18.0, v22.10.0, and above
 
 ```bash
 npm install --save-dev eslint eslint-plugin-svelte svelte
 ```
 
-> **Requirements**
->
-> - ESLint v8.57.1, v9.0.0 and above
-> - Node.js v18.20.4, v20.18.0, v22.10.0 and above
-
 <!--DOCS_IGNORE_END-->
 
 ## :book: Usage
@@ -283,13 +269,13 @@ export default [
 ];
 ```
 
-## :computer: Editor Integrations
+## Editor Integrations
 
 ### Visual Studio Code
 
-Use the [dbaeumer.vscode-eslint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) extension that Microsoft provides officially.
+Use the [dbaeumer.vscode-eslint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) extension provided officially by Microsoft.
 
-You have to configure the `eslint.validate` option of the extension to check `.svelte` files, because the extension targets only `*.js` or `*.jsx` files by default.
+You need to configure the `eslint.validate` option in the extension settings to include `.svelte` files, as the extension only targets `*.js` and `*.jsx` files by default.
 
 Example **.vscode/settings.json**:
 
@@ -302,6 +288,17 @@ Example **.vscode/settings.json**:
 <!--USAGE_GUIDE_END-->
 <!--USAGE_SECTION_END-->
 
+<!--DOCS_IGNORE_START-->
+
+## Versioning policy
+
+This plugin follows [Semantic Versioning](https://semver.org/).  
+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.  
+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.  
+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.
+
+<!--DOCS_IGNORE_END-->
+
 ## :white_check_mark: Rules
 
 <!-- prettier-ignore-start -->
@@ -453,21 +450,17 @@ These rules relate to this plugin works:
 
 <!--DOCS_IGNORE_START-->
 
-## :beers: Contributing
-
-Welcome contributing!
-
-Please use GitHub's Issues/PRs.
+## Contributing
 
-See also [CONTRIBUTING.md](./CONTRIBUTING.md)
+Contributions are welcome! Feel free to use GitHub Issues or submit a Pull Request (PR). For more details, see [CONTRIBUTING.md](./CONTRIBUTING.md).
 
 ### Working With Rules
 
-This plugin uses [svelte-eslint-parser](https://github.com/sveltejs/svelte-eslint-parser) for the parser. Check [here](https://sveltejs.github.io/svelte-eslint-parser/) to find out about AST.
+This plugin uses [svelte-eslint-parser](https://github.com/sveltejs/svelte-eslint-parser) as its parser. Check the [AST documentation](https://sveltejs.github.io/svelte-eslint-parser/) to learn more about the AST structure.
 
 <!--DOCS_IGNORE_END-->
 
-## :lock: License
+## License
 
 See the [LICENSE](LICENSE) file for license rights and limitations (MIT).
 

docs/README.md

@@ -4,47 +4,12 @@ title: 'eslint-plugin-svelte'
 
 # Introduction
 
-`eslint-plugin-svelte` is the official [ESLint] plugin for [Svelte].  
-It provides many unique check rules by using the template AST.  
-You can check on the [Online DEMO](https://eslint-online-playground.netlify.app/#eslint-plugin-svelte%20with%20typescript).
+`eslint-plugin-svelte` is the official [ESLint](https://eslint.org/) plugin for [Svelte](https://svelte.dev/).  
+It offers a variety of unique linting rules by leveraging the AST generated by [svelte-eslint-parser](https://github.com/sveltejs/svelte-eslint-parser).  
+It provides a variety of unique linting rules by utilizing the template AST.
 
-> [!NOTE]
-> This document is in development.\
-> Please refer to the document for the version you are using.\
-> For example, <https://github.com/sveltejs/eslint-plugin-svelte/blob/eslint-plugin-svelte%402.46.0/README.md>
-> and <https://github.com/sveltejs/eslint-plugin-svelte/blob/eslint-plugin-svelte%402.46.0/docs>
-
-[![NPM license](https://img.shields.io/npm/l/eslint-plugin-svelte.svg)](https://www.npmjs.com/package/eslint-plugin-svelte)
-[![NPM version](https://img.shields.io/npm/v/eslint-plugin-svelte.svg)](https://www.npmjs.com/package/eslint-plugin-svelte)
-[![NPM downloads](https://img.shields.io/badge/dynamic/json.svg?label=downloads&colorB=green&suffix=/day&query=$.downloads&uri=https://api.npmjs.org//downloads/point/last-day/eslint-plugin-svelte&maxAge=3600)](http://www.npmtrends.com/eslint-plugin-svelte)
-[![NPM downloads](https://img.shields.io/npm/dw/eslint-plugin-svelte.svg)](http://www.npmtrends.com/eslint-plugin-svelte)
-[![NPM downloads](https://img.shields.io/npm/dm/eslint-plugin-svelte.svg)](http://www.npmtrends.com/eslint-plugin-svelte)
-[![NPM downloads](https://img.shields.io/npm/dy/eslint-plugin-svelte.svg)](http://www.npmtrends.com/eslint-plugin-svelte)
-[![NPM downloads](https://img.shields.io/npm/dt/eslint-plugin-svelte.svg)](http://www.npmtrends.com/eslint-plugin-svelte)
-[![Build Status](https://github.com/sveltejs/eslint-plugin-svelte/workflows/CI/badge.svg?branch=main)](https://github.com/sveltejs/eslint-plugin-svelte/actions?query=workflow%3ACI)
-
-[![type-coverage](https://img.shields.io/badge/dynamic/json.svg?label=type-coverage&prefix=%E2%89%A5&suffix=%&query=$.typeCoverage.atLeast&uri=https%3A%2F%2Fraw.githubusercontent.com%2Fsveltejs%2Feslint-plugin-svelte%2Fmain%2Fpackage.json)](https://github.com/plantain-00/type-coverage)
-[![Conventional Commits](https://img.shields.io/badge/conventional%20commits-1.0.0-yellow.svg)](https://conventionalcommits.org)
-[![Code Style: Prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://github.com/prettier/prettier)
-[![changesets](https://img.shields.io/badge/maintained%20with-changesets-176de3.svg)](https://github.com/atlassian/changesets)
-
-## :name_badge: What is this plugin?
-
-[ESLint] plugin for [Svelte].  
-It provides many unique check rules using the AST generated by [svelte-eslint-parser].
-
-### ❗ Attention
-
-#### Cannot be used with eslint-plugin-svelte3
-
-The [svelte-eslint-parser] and the `eslint-plugin-svelte` can not be used with the [eslint-plugin-svelte3].
-
-[svelte-eslint-parser]: https://github.com/sveltejs/svelte-eslint-parser
-[eslint-plugin-svelte3]: https://github.com/sveltejs/eslint-plugin-svelte3
-
-#### Experimental support for Svelte v5
-
-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.
+> [!WARNING]
+> 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).
 
 ## :book: Usage
 
@@ -56,7 +21,7 @@ See [User Guide](./user-guide.md).
 See [Available Rules](./rules.md).
 <!-- prettier-ignore-end -->
 
-## :lock: License
+## License
 
 See the [LICENSE](https://github.com/sveltejs/eslint-plugin-svelte/blob/main/LICENSE) file for license rights and limitations (MIT).
 

docs/user-guide.md

@@ -228,13 +228,13 @@ export default [
 ];
 ```
 
-## :computer: Editor Integrations
+## Editor Integrations
 
 ### Visual Studio Code
 
-Use the [dbaeumer.vscode-eslint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) extension that Microsoft provides officially.
+Use the [dbaeumer.vscode-eslint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) extension provided officially by Microsoft.
 
-You have to configure the `eslint.validate` option of the extension to check `.svelte` files, because the extension targets only `*.js` or `*.jsx` files by default.
+You need to configure the `eslint.validate` option in the extension settings to include `.svelte` files, as the extension only targets `*.js` and `*.jsx` files by default.
 
 Example **.vscode/settings.json**:
 

packages/eslint-plugin-svelte/tools/update-readme.ts

@@ -38,11 +38,12 @@ ${newReadme
 	)
 	.replace(/<!--DOCS_IGNORE_START-->[\s\S]*?<!--DOCS_IGNORE_END-->/gu, '')
 	.replace(
-		/\(https:\/\/sveltejs.github.io\/eslint-plugin-svelte(.*?)\)/gu,
+		/\(https:\/\/sveltejs.github.io\/eslint-plugin-svelte\/(.+)\)/gu,
 		(_ptn, filepath: string) => {
 			const [hash] = /(?:#.*)?$/u.exec(filepath)!;
 			const pathWithoutHash = hash ? filepath.slice(0, -hash.length) : filepath;
 			const normalizePathWithoutHash = pathWithoutHash.replace(/\/$/u, '');
+
 			const [file] = /[^/]+$/u.exec(normalizePathWithoutHash)!;
 			const pathWithoutFile = file
 				? normalizePathWithoutHash.slice(0, -file.length)