From 4f165f3780d8c59395239c336f6ce941ed2943a3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marek=20D=C4=9Bdi=C4=8D?= Date: Fri, 23 Sep 2022 11:25:58 +0200 Subject: [PATCH] More explicit docs for what the prettier config does --- README.md | 2 +- docs/user-guide.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 799c077b8..8137b77d9 100644 --- a/README.md +++ b/README.md @@ -89,7 +89,7 @@ This plugin provides configs: - `plugin:svelte/base` ... Configuration to enable correct Svelte parsing. - `plugin:svelte/recommended` ... Above, plus rules to prevent errors or unintended behavior. -- `plugin:svelte/prettier` ... Turn off rules that may conflict with [Prettier](https://prettier.io/) ([prettier-plugin-svelte](https://github.com/sveltejs/prettier-plugin-svelte)). +- `plugin:svelte/prettier` ... Turns off rules that may conflict with [Prettier](https://prettier.io/) (You still need to configure prettier to work with svelte yourself, for example by using [prettier-plugin-svelte](https://github.com/sveltejs/prettier-plugin-svelte).). See [the rule list](https://ota-meshi.github.io/eslint-plugin-svelte/rules/) to get the `rules` that this plugin provides. diff --git a/docs/user-guide.md b/docs/user-guide.md index d5a971ab5..bd1295900 100644 --- a/docs/user-guide.md +++ b/docs/user-guide.md @@ -41,7 +41,7 @@ This plugin provides configs: - `plugin:svelte/base` ... Configuration to enable correct Svelte parsing. - `plugin:svelte/recommended` ... Above, plus rules to prevent errors or unintended behavior. -- `plugin:svelte/prettier` ... Turn off rules that may conflict with [Prettier](https://prettier.io/) ([prettier-plugin-svelte](https://github.com/sveltejs/prettier-plugin-svelte)). +- `plugin:svelte/prettier` ... Turns off rules that may conflict with [Prettier](https://prettier.io/) (You still need to configure prettier to work with svelte yourself, for example by using [prettier-plugin-svelte](https://github.com/sveltejs/prettier-plugin-svelte).). See [the rule list](./rules.md) to get the `rules` that this plugin provides.