From 12ec0b4d5918bccaaa348db7560c10757c9846ef Mon Sep 17 00:00:00 2001 From: baseballyama Date: Sun, 23 Apr 2023 21:10:43 +0900 Subject: [PATCH 1/3] chore: update README --- README.md | 8 +------- docs/README.md | 8 +------- 2 files changed, 2 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 0a9910f12..3caf89c19 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Introduction -`eslint-plugin-svelte` is [ESLint] plugin for [Svelte]. +`eslint-plugin-svelte` is official [ESLint] plugin for [Svelte]. It provides many unique check rules by using the template AST. You can check on the [Online DEMO](https://sveltejs.github.io/eslint-plugin-svelte/playground/). @@ -23,12 +23,6 @@ You can check on the [Online DEMO](https://sveltejs.github.io/eslint-plugin-svel [ESLint] plugin for [Svelte]. It provides many unique check rules using the AST generated by [svelte-eslint-parser]. -### ❓ Why? - -[Svelte] has the official [ESLint] plugin the [eslint-plugin-svelte3]. The [eslint-plugin-svelte3] works well enough to check scripts. However, it does not handle the AST of the template, which makes it very difficult for third parties to create their own the [ESLint] rules for the [Svelte]. - -The [svelte-eslint-parser] aims to make it easy to create your own rules for the [Svelte] by allowing the template AST to be used in the rules. - ### ❗ Attention The [svelte-eslint-parser] and the `eslint-plugin-svelte` can not be used with the [eslint-plugin-svelte3]. diff --git a/docs/README.md b/docs/README.md index bfd7d21c7..06bd26bd3 100644 --- a/docs/README.md +++ b/docs/README.md @@ -4,7 +4,7 @@ title: "eslint-plugin-svelte" # Introduction -`eslint-plugin-svelte` is [ESLint] plugin for [Svelte]. +`eslint-plugin-svelte` is official [ESLint] plugin for [Svelte]. It provides many unique check rules by using the template AST. You can check on the [Online DEMO](./playground.md). @@ -27,12 +27,6 @@ You can check on the [Online DEMO](./playground.md). [ESLint] plugin for [Svelte]. It provides many unique check rules using the AST generated by [svelte-eslint-parser]. -### ❓ Why? - -[Svelte] has the official [ESLint] plugin the [eslint-plugin-svelte3]. The [eslint-plugin-svelte3] works well enough to check scripts. However, it does not handle the AST of the template, which makes it very difficult for third parties to create their own the [ESLint] rules for the [Svelte]. - -The [svelte-eslint-parser] aims to make it easy to create your own rules for the [Svelte] by allowing the template AST to be used in the rules. - ### ❗ Attention The [svelte-eslint-parser] and the `eslint-plugin-svelte` can not be used with the [eslint-plugin-svelte3]. From 3b004abd5828a9f0eee38729c247d8ab994233de Mon Sep 17 00:00:00 2001 From: Yuichiro Yamashita Date: Mon, 24 Apr 2023 11:29:54 +0900 Subject: [PATCH 2/3] Update README.md Co-authored-by: Daniel M. Capella --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 3caf89c19..cd8c1c95c 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Introduction -`eslint-plugin-svelte` is official [ESLint] plugin for [Svelte]. +`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://sveltejs.github.io/eslint-plugin-svelte/playground/). From 505d2eec10094f12567f9d0919b1e659c254e380 Mon Sep 17 00:00:00 2001 From: Yuichiro Yamashita Date: Mon, 24 Apr 2023 11:30:01 +0900 Subject: [PATCH 3/3] Update docs/README.md Co-authored-by: Daniel M. Capella --- docs/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/README.md b/docs/README.md index 06bd26bd3..996e593df 100644 --- a/docs/README.md +++ b/docs/README.md @@ -4,7 +4,7 @@ title: "eslint-plugin-svelte" # Introduction -`eslint-plugin-svelte` is official [ESLint] plugin for [Svelte]. +`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](./playground.md).