Add plugin:svelte/prettier config (#182)

Author: ota-meshi

README.md

@@ -83,6 +83,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)).
 
 See [the rule list](https://ota-meshi.github.io/eslint-plugin-svelte/rules/) to get the `rules` that this plugin provides.
 
@@ -360,7 +361,7 @@ If you want to test only one rule, run the following command (for `indent` rule)
 yarn test -g indent
 ```
 
-Take https://stackoverflow.com/questions/10832031/how-to-run-a-single-test-with-mocha as reference for details.
+Take <https://stackoverflow.com/questions/10832031/how-to-run-a-single-test-with-mocha> as reference for details.
 
 If you want to test only `my-test-input.svelte`, add `my-test-config.json` and save `{"only": true}`.  
 (Note that `{"only": true}` must be removed before making a pull request.)

docs/user-guide.md

@@ -41,6 +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)).
 
 See [the rule list](./rules.md) to get the `rules` that this plugin provides.
 

src/configs/prettier.ts

@@ -0,0 +1,17 @@
+import path from "path"
+const base = require.resolve("./base")
+const baseExtend =
+  path.extname(`${base}`) === ".ts" ? "plugin:svelte/base" : base
+export = {
+  extends: [baseExtend],
+  rules: {
+    // eslint-plugin-svelte rules
+    "svelte/first-attribute-linebreak": "off",
+    "svelte/html-quotes": "off",
+    "svelte/indent": "off",
+    "svelte/max-attributes-per-line": "off",
+    "svelte/mustache-spacing": "off",
+    "svelte/shorthand-attribute": "off",
+    "svelte/shorthand-directive": "off",
+  },
+}

src/index.ts

@@ -2,11 +2,13 @@ import type { RuleModule } from "./types"
 import { rules as ruleList } from "./utils/rules"
 import base from "./configs/base"
 import recommended from "./configs/recommended"
+import prettier from "./configs/prettier"
 import * as processor from "./processor"
 
 const configs = {
   base,
   recommended,
+  prettier,
 }
 
 const rules = ruleList.reduce((obj, r) => {

src/rules/first-attribute-linebreak.ts

@@ -7,6 +7,7 @@ export default createRule("first-attribute-linebreak", {
       description: "enforce the location of first attribute",
       category: "Stylistic Issues",
       recommended: false,
+      conflictWithPrettier: true,
     },
     fixable: "whitespace",
     schema: [

src/rules/html-quotes.ts

@@ -20,6 +20,7 @@ export default createRule("html-quotes", {
       description: "enforce quotes style of HTML attributes",
       category: "Stylistic Issues",
       recommended: false,
+      conflictWithPrettier: true,
     },
     fixable: "code",
     schema: [

src/rules/indent.ts

@@ -7,6 +7,7 @@ export default createRule("indent", {
       description: "enforce consistent indentation",
       category: "Stylistic Issues",
       recommended: false,
+      conflictWithPrettier: true,
     },
     fixable: "whitespace",
     schema: [

src/rules/max-attributes-per-line.ts

@@ -30,6 +30,7 @@ export default createRule("max-attributes-per-line", {
       description: "enforce the maximum number of attributes per line",
       category: "Stylistic Issues",
       recommended: false,
+      conflictWithPrettier: true,
     },
     fixable: "whitespace",
     schema: [

src/rules/mustache-spacing.ts

@@ -39,6 +39,7 @@ export default createRule("mustache-spacing", {
       description: "enforce unified spacing in mustache",
       category: "Stylistic Issues",
       recommended: false,
+      conflictWithPrettier: true,
     },
     fixable: "code",
     schema: [

src/rules/prefer-class-directive.ts

@@ -14,6 +14,7 @@ export default createRule("prefer-class-directive", {
       description: "require class directives instead of ternary expressions",
       category: "Stylistic Issues",
       recommended: false,
+      conflictWithPrettier: false,
     },
     fixable: "code",
     schema: [],