Skip to content

Commit 09eaf59

Browse files
committed
Update doc
1 parent ca806b5 commit 09eaf59

File tree

4 files changed

+16
-4
lines changed

4 files changed

+16
-4
lines changed

README.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# Introduction
22

3-
`@ota-meshi/eslint-plugin-svelte` is ESLint plugin for Svelte using AST.
3+
`@ota-meshi/eslint-plugin-svelte` is ESLint plugin for Svelte.
4+
It provides many unique check rules by using the template AST.
45
You can check on the [Online DEMO](https://ota-meshi.github.io/eslint-plugin-svelte/playground/).
56

67
::: **_WORKS IN PROGRESS_** :::
@@ -18,7 +19,8 @@ You can check on the [Online DEMO](https://ota-meshi.github.io/eslint-plugin-sve
1819

1920
## :name_badge: What is this plugin?
2021

21-
An experimental ESLint plugin using [svelte-eslint-parser].
22+
ESLint plugin for Svelte.
23+
It provides many unique check rules using the AST generated by [svelte-eslint-parser].
2224

2325
### ❓ Why?
2426

docs/README.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# Introduction
22

3-
`@ota-meshi/eslint-plugin-svelte` is ESLint plugin for Svelte using AST.
3+
`@ota-meshi/eslint-plugin-svelte` is ESLint plugin for Svelte.
4+
It provides many unique check rules by using the template AST.
45
You can check on the [Online DEMO](./playground/README.md).
56

67
::: **_WORKS IN PROGRESS_** :::
@@ -18,7 +19,8 @@ You can check on the [Online DEMO](./playground/README.md).
1819

1920
## :name_badge: What is this plugin?
2021

21-
An experimental ESLint plugin using [svelte-eslint-parser].
22+
ESLint plugin for Svelte.
23+
It provides many unique check rules using the AST generated by [svelte-eslint-parser].
2224

2325
### ❓ Why?
2426

docs/rules/prefer-class-directive.md

+4
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,10 @@ This rule aims to replace a class with ternary operator with the class directive
3434

3535
</eslint-code-block>
3636

37+
You cannot enforce this style by using [prettier-plugin-svelte]. That is, this rule does not conflict with [prettier-plugin-svelte] and can be used with [prettier-plugin-svelte].
38+
39+
[prettier-plugin-svelte]: https://github.com/sveltejs/prettier-plugin-svelte
40+
3741
## :wrench: Options
3842

3943
Nothing.

docs/rules/spaced-html-comment.md

+4
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,10 @@ This rule will enforce consistency of spacing after the start of a comment `<!--
3232

3333
</eslint-code-block>
3434

35+
You cannot enforce this style by using [prettier-plugin-svelte]. That is, this rule does not conflict with [prettier-plugin-svelte] and can be used with [prettier-plugin-svelte].
36+
37+
[prettier-plugin-svelte]: https://github.com/sveltejs/prettier-plugin-svelte
38+
3539
## :wrench: Options
3640

3741
```json

0 commit comments

Comments
 (0)