Update doc and parser

Author: ota-meshi

.github/workflows/test.yml

@@ -14,7 +14,7 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest]
-        node: [10, 12, 14]
+        node: [10, 12, 14, 16]
     steps:
       - name: Checkout
         uses: actions/checkout@v2

docs/started.md

@@ -17,6 +17,8 @@ npm install --save-dev eslint @intlify/eslint-plugin-svelte
 
 ## :rocket: Usage
 
+### Configuration
+
 Configure your `.eslintrc.*` file.
 
 For example:
@@ -42,6 +44,99 @@ module.export = {
 
 See [the rule list](./rules/README.md)
 
+::: warning ❗ Attention
+
+The `@intlify/eslint-plugin-svelte` can not be used with the [eslint-plugin-svelte3].
+If you are using [eslint-plugin-svelte3] you need to remove it.
+
+```diff
+  "plugins": [
+-   "svelte3"
+  ]
+```
+
+:::
+
+[eslint-plugin-svelte3]: https://github.com/sveltejs/eslint-plugin-svelte3
+
+#### Parser Configuration
+
+If you have specified a parser, you need to configure a parser for `.svelte`.
+
+For example, if you are using the `"@babel/eslint-parser"`, configure it as follows:
+
+```js
+module.exports = {
+  // ...
+  extends: ['plugin:@ota-meshi/svelte/recommended'],
+  // ...
+  parser: '@babel/eslint-parser',
+  // Add an `overrides` section to add a parser configuration for svelte.
+  overrides: [
+    {
+      files: ['*.svelte'],
+      parser: 'svelte-eslint-parser'
+    }
+    // ...
+  ]
+  // ...
+}
+```
+
+For example, if you are using the `"@typescript-eslint/parser"`, and if you want to use TypeScript in `<script>` of `.svelte`, you need to add more `parserOptions` configuration.
+
+```js
+module.exports = {
+  // ...
+  extends: ['plugin:@ota-meshi/svelte/recommended'],
+  // ...
+  parser: '@typescript-eslint/parser',
+  parserOptions: {
+    // ...
+    project: 'path/to/your/tsconfig.json',
+    extraFileExtensions: ['.svelte'] // This is a required setting in `@typescript-eslint/parser` v4.24.0.
+  },
+  overrides: [
+    {
+      files: ['*.svelte'],
+      parser: 'svelte-eslint-parser',
+      // Parse the `<script>` in `.svelte` as TypeScript by adding the following configuration.
+      parserOptions: {
+        parser: '@typescript-eslint/parser'
+      }
+    }
+    // ...
+  ]
+  // ...
+}
+```
+
+If you have a mix of TypeScript and JavaScript in your project, use a multiple parser configuration.
+
+```js
+module.exports = {
+  // ...
+  overrides: [
+    {
+      files: ['*.svelte'],
+      parser: 'svelte-eslint-parser',
+      parserOptions: {
+        parser: {
+          // Specify a parser for each lang.
+          ts: '@typescript-eslint/parser',
+          js: 'espree',
+          typescript: '@typescript-eslint/parser'
+        }
+      }
+    }
+    // ...
+  ]
+  // ...
+}
+```
+
+See also [https://github.com/ota-meshi/svelte-eslint-parser#readme](https://github.com/ota-meshi/svelte-eslint-parser#readme).
+
 ### Running ESLint from command line
 
 If you want to run `eslint` from command line, make sure you include the `.svelte` extension using [the `--ext` option](https://eslint.org/docs/user-guide/configuring#specifying-file-extensions-to-lint) or a glob pattern because ESLint targets only `.js` files by default.
@@ -53,6 +148,13 @@ eslint --ext .js,.svelte src
 eslint "src/**/*.{js,svelte}"
 ```
 
+## :flying_saucer: More Plugins
+
+### [@ota-meshi/eslint-plugin-svelte](https://ota-meshi.github.io/eslint-plugin-svelte/)
+
+ESLint plugin for Svelte compatible with `@intlify/eslint-plugin-svelte`.
+Use it if you want ESLint to do more checks on your Svelte files.
+
 ## :question: FAQ
 
 ### What is the "Use the latest svelte-eslint-parser" error?

package.json

@@ -22,7 +22,7 @@
   },
   "dependencies": {
     "debug": "^4.3.1",
-    "svelte-eslint-parser": "^0.1.0"
+    "svelte-eslint-parser": "^0.4.1"
   },
   "peerDependencies": {
     "eslint": "^7.0.0",

yarn.lock

@@ -4283,6 +4283,11 @@ eslint-visitor-keys@^2.0.0:
   resolved "https://registry.yarnpkg.com/eslint-visitor-keys/-/eslint-visitor-keys-2.0.0.tgz#21fdc8fbcd9c795cc0321f0563702095751511a8"
   integrity sha512-QudtT6av5WXels9WjIM7qz1XD1cWGvX4gGXvp/zBn9nXG02D0utdU3Em2m/QjTnrsk6bBjmCygl3rmj118msQQ==
 
+eslint-visitor-keys@^3.0.0:
+  version "3.0.0"
+  resolved "https://registry.yarnpkg.com/eslint-visitor-keys/-/eslint-visitor-keys-3.0.0.tgz#e32e99c6cdc2eb063f204eda5db67bfe58bb4186"
+  integrity sha512-mJOZa35trBTb3IyRmo8xmKBZlxf+N7OnUl4+ZhJHs/r+0770Wh/LEACE2pqMGMe27G/4y8P2bYGk4J70IC5k1Q==
+
 eslint4b@^7.16.0:
   version "7.16.0"
   resolved "https://registry.yarnpkg.com/eslint4b/-/eslint4b-7.16.0.tgz#6bea3e3440814828deef6e5e9e42448603edf3b2"
@@ -10011,13 +10016,13 @@ supports-color@^7.1.0:
   dependencies:
     has-flag "^4.0.0"
 
-svelte-eslint-parser@^0.1.0:
-  version "0.1.0"
-  resolved "https://registry.yarnpkg.com/svelte-eslint-parser/-/svelte-eslint-parser-0.1.0.tgz#56a627892245117ee16ae36d18c6c1a708a663f0"
-  integrity sha512-Qi+tqus7uKe9F0yQSdHE4rLLGHqFsopuy94MLV/OVmst+XCcD/fr/QTVNtgD1zmUs2iTAuN028GksIm87WihIg==
+svelte-eslint-parser@^0.4.1:
+  version "0.4.1"
+  resolved "https://registry.yarnpkg.com/svelte-eslint-parser/-/svelte-eslint-parser-0.4.1.tgz#ac645aea60a3dfa977b2693aaa654210f193ae9a"
+  integrity sha512-OoCyDI+0O7BjOCHxLiQMsS6e02T/ahh5u7o+CiQBM4RoChadYn/AfgR9SaIMHL2P+aVToxPnX94sC5e482w/Lg==
   dependencies:
     eslint-scope "^5.1.1"
-    eslint-visitor-keys "^2.0.0"
+    eslint-visitor-keys "^3.0.0"
     espree "^7.3.1"
 
 svelte@^3.37.0: