Skip to content

Commit 19f41d0

Browse files
committed
add initial info about interactions with other plugins
1 parent 6a8274c commit 19f41d0

File tree

2 files changed

+26
-1
lines changed

2 files changed

+26
-1
lines changed

OTHER_PLUGINS.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Interactions with other plugins
2+
3+
## `eslint-plugin-html`
4+
5+
Don't enable this at all on the files you're running `eslint-plugin-svelte3` on. Everything will almost certainly break.
6+
7+
## `eslint-plugin-prettier`
8+
9+
Don't enable this either on Svelte components. If you want to use Prettier, just use it directly, along with appropriate plugins.
10+
11+
## `eslint-plugin-import`
12+
13+
These rules are known to not work correctly together with this plugin:
14+
15+
- `import/first`
16+
- `import/no-duplicates`
17+
- `import/no-mutable-exports`
18+
19+
If you're using them on other linted files, consider adding `overrides` for them for Svelte components.
20+
21+
## Others?
22+
23+
If you've found another mainstream ESLint plugin that doesn't play nicely with this one, or has certain rules that don't work properly, please let us know!

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,9 @@ For example:
4646

4747
This plugin needs to be able to `require('svelte/compiler')`. If ESLint, this plugin, and Svelte are all installed locally in your project, this should not be a problem.
4848

49-
**Important!** Make sure you do not have `eslint-plugin-html` enabled on the files you want linted as Svelte components, as the two plugins won't get along.
49+
## Interactions with other plugins
50+
51+
Care needs to be taken when using this plugin alongside others. Take a look at [this list of things you need to watch out for](OTHER_PLUGINS.md).
5052

5153
## Configuration
5254

0 commit comments

Comments
 (0)