diff --git a/README.md b/README.md index 99886ddc..76b5b46d 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Introduction -`eslint-plugin-astro` is [ESLint] plugin for [Astro] components. +`eslint-plugin-astro` is [ESLint] plugin for [Astro components]. You can check on the [Online DEMO](https://ota-meshi.github.io/eslint-plugin-astro/playground/). [![sponsors](https://img.shields.io/badge/-Sponsor-fafbfc?logo=GitHub%20Sponsors)](https://github.com/sponsors/ota-meshi) @@ -18,7 +18,7 @@ This plugin is in the **_experimental stages_** of development. ## :name_badge: What is this plugin? -[ESLint] plugin for [Astro] components. +[ESLint] plugin for [Astro components]. [astro-eslint-parser]: https://github.com/ota-meshi/astro-eslint-parser @@ -139,7 +139,13 @@ Example **.vscode/settings.json**: ```json { - "eslint.validate": ["javascript", "javascriptreact", "astro"] + "eslint.validate": [ + "javascript", + "javascriptreact", + "astro", // Enable .astro + "typescript", // Enable .ts + "typescriptreact" // Enable .tsx + ] } ``` @@ -216,3 +222,4 @@ See the [LICENSE](LICENSE) file for license rights and limitations (MIT). [astro]: https://astro.build/ [eslint]: https://eslint.org/ +[astro components]: https://docs.astro.build/en/core-concepts/astro-components/ diff --git a/docs/README.md b/docs/README.md index 179a8f77..7056c466 100644 --- a/docs/README.md +++ b/docs/README.md @@ -4,7 +4,7 @@ title: "eslint-plugin-astro" # Introduction -`eslint-plugin-astro` is [ESLint] plugin for [Astro] components. +`eslint-plugin-astro` is [ESLint] plugin for [Astro components]. You can check on the [Online DEMO](./playground.md). [![sponsors](https://img.shields.io/badge/-Sponsor-fafbfc?logo=GitHub%20Sponsors)](https://github.com/sponsors/ota-meshi) @@ -22,7 +22,7 @@ This plugin is in the **_experimental stages_** of development. ## :name_badge: What is this plugin? -[ESLint] plugin for [Astro] components. +[ESLint] plugin for [Astro components]. [astro-eslint-parser]: https://github.com/ota-meshi/astro-eslint-parser @@ -46,3 +46,4 @@ See the [LICENSE](https://github.com/ota-meshi/eslint-plugin-astro/blob/main/LIC [astro]: https://astro.build/ [eslint]: https://eslint.org/ +[astro components]: https://docs.astro.build/en/core-concepts/astro-components/ diff --git a/docs/user-guide.md b/docs/user-guide.md index ba44042e..16323685 100644 --- a/docs/user-guide.md +++ b/docs/user-guide.md @@ -108,7 +108,13 @@ Example **.vscode/settings.json**: ```json { - "eslint.validate": ["javascript", "javascriptreact", "astro"] + "eslint.validate": [ + "javascript", + "javascriptreact", + "astro", // Enable .astro + "typescript", // Enable .ts + "typescriptreact" // Enable .tsx + ] } ```