Add config for prettier (#53)

ota-meshi · web-flow · commit 60cfab927ec6 · 2021-02-25T10:15:31.000+09:00
* Add config for prettier

* update

* fix
diff --git a/README.md b/README.md
@@ -59,7 +59,7 @@ e.g. [eslint-plugin-json-files](https://www.npmjs.com/package/eslint-plugin-json
 
 These plugins use the same AST as JavaScript for linting.
 
-Since the plugin uses the same AST as JavaScript, it may not report syntax that is not available in JSON (e.g. `1 + 1`). Also, ESLint core rules and other plug-in rules can false positives (e.g. [quote-props](https://eslint.org/docs/rules/quote-props) rule reports quote on keys), which can complicate the configuration.
+Since the plugin uses the same AST as JavaScript, it may not report syntax that is not available in JSON (e.g. `1 + 1`). Also, ESLint core rules and other plugin rules can false positives (e.g. [quote-props](https://eslint.org/docs/rules/quote-props) rule reports quote on keys), which can complicate the configuration.
 
 The AST used by **eslint-plugin-jsonc** is similar to JavaScript AST, but with a different node name. This will prevent false positives. This means that it can be easily used in combination with other plugins.
 
@@ -113,6 +113,7 @@ This plugin provides configs:
 - `plugin:jsonc/recommended-with-json` ... Recommended configuration for JSON.
 - `plugin:jsonc/recommended-with-jsonc` ... Recommended configuration for JSONC.
 - `plugin:jsonc/recommended-with-json5` ... Recommended configuration for JSON5.
+- `plugin:jsonc/prettier` ... Turn off rules that may conflict with [Prettier](https://prettier.io/).
 
 See [the rule list](https://ota-meshi.github.io/eslint-plugin-jsonc/rules/) to get the `rules` that this plugin provides.
 
diff --git a/docs/README.md b/docs/README.md
@@ -59,7 +59,7 @@ e.g. [eslint-plugin-json-files](https://www.npmjs.com/package/eslint-plugin-json
 
 These plugins use the same AST as JavaScript for linting.
 
-Since the plugin uses the same AST as JavaScript, it may not report syntax that is not available in JSON (e.g. `1 + 1`). Also, ESLint core rules and other plug-in rules can false positives (e.g. [quote-props](https://eslint.org/docs/rules/quote-props) rule reports quote on keys), which can complicate the configuration.
+Since the plugin uses the same AST as JavaScript, it may not report syntax that is not available in JSON (e.g. `1 + 1`). Also, ESLint core rules and other plugin rules can false positives (e.g. [quote-props](https://eslint.org/docs/rules/quote-props) rule reports quote on keys), which can complicate the configuration.
 
 The AST used by **eslint-plugin-jsonc** is similar to JavaScript AST, but with a different node name. This will prevent false positives. This means that it can be easily used in combination with other plugins.
 
diff --git a/docs/user-guide/README.md b/docs/user-guide/README.md
@@ -42,6 +42,7 @@ This plugin provides configs:
 - `plugin:jsonc/recommended-with-json` ... Recommended configuration for JSON.
 - `plugin:jsonc/recommended-with-jsonc` ... Recommended configuration for JSONC.
 - `plugin:jsonc/recommended-with-json5` ... Recommended configuration for JSON5.
+- `plugin:jsonc/prettier` ... Turn off rules that may conflict with [Prettier](https://prettier.io/).
 
 See [the rule list](../rules/README.md) to get the `rules` that this plugin provides.
 
diff --git a/lib/configs/prettier.ts b/lib/configs/prettier.ts
@@ -0,0 +1,23 @@
+import path from "path"
+const base = require.resolve("./base")
+const baseExtend =
+    path.extname(`${base}`) === ".ts" ? "plugin:jsonc/base" : base
+export = {
+    extends: [baseExtend],
+    rules: {
+        // eslint-plugin-jsonc rules
+        "jsonc/array-bracket-newline": "off",
+        "jsonc/array-bracket-spacing": "off",
+        "jsonc/array-element-newline": "off",
+        "jsonc/comma-dangle": "off",
+        "jsonc/comma-style": "off",
+        "jsonc/indent": "off",
+        "jsonc/key-spacing": "off",
+        "jsonc/object-curly-newline": "off",
+        "jsonc/object-curly-spacing": "off",
+        "jsonc/object-property-newline": "off",
+        "jsonc/quote-props": "off",
+        "jsonc/quotes": "off",
+        "jsonc/space-unary-ops": "off",
+    },
+}
diff --git a/lib/index.ts b/lib/index.ts
@@ -5,6 +5,7 @@ import autoConfig from "./configs/auto-config"
 import recommendedWithJson from "./configs/recommended-with-json"
 import recommendedWithJsonc from "./configs/recommended-with-jsonc"
 import recommendedWithJson5 from "./configs/recommended-with-json5"
+import prettier from "./configs/prettier"
 // backward compatibility
 import {
     parseForESLint,
@@ -19,6 +20,7 @@ const configs = {
     "recommended-with-json": recommendedWithJson,
     "recommended-with-jsonc": recommendedWithJsonc,
     "recommended-with-json5": recommendedWithJson5,
+    prettier,
 }
 
 const rules = ruleList.reduce((obj, r) => {
diff --git a/lib/rules/array-bracket-newline.ts b/lib/rules/array-bracket-newline.ts
@@ -8,6 +8,7 @@ export default createRule("array-bracket-newline", {
                 "enforce line breaks after opening and before closing array brackets",
             recommended: null,
             extensionRule: true,
+            layout: true,
         },
         fixable: coreRule.meta?.fixable,
         schema: coreRule.meta!.schema!,
diff --git a/lib/rules/array-bracket-spacing.ts b/lib/rules/array-bracket-spacing.ts
@@ -7,6 +7,7 @@ export default createRule("array-bracket-spacing", {
             description: "disallow or enforce spaces inside of brackets",
             recommended: null,
             extensionRule: true,
+            layout: true,
         },
         fixable: coreRule.meta?.fixable,
         schema: coreRule.meta!.schema!,
diff --git a/lib/rules/array-element-newline.ts b/lib/rules/array-element-newline.ts
@@ -7,6 +7,7 @@ export default createRule("array-element-newline", {
             description: "enforce line breaks between array elements",
             recommended: null,
             extensionRule: true,
+            layout: true,
         },
         fixable: coreRule.meta?.fixable,
         schema: coreRule.meta!.schema!,
diff --git a/lib/rules/auto.ts b/lib/rules/auto.ts
@@ -9,6 +9,7 @@ export default createRule("auto", {
                 "apply jsonc rules similar to your configured ESLint core rules",
             recommended: null,
             extensionRule: false,
+            layout: false,
         },
         fixable: "code",
         schema: [],
diff --git a/lib/rules/comma-dangle.ts b/lib/rules/comma-dangle.ts
@@ -7,6 +7,7 @@ export default createRule("comma-dangle", {
             description: "require or disallow trailing commas",
             recommended: ["json"],
             extensionRule: true,
+            layout: true,
         },
         fixable: coreRule.meta?.fixable,
         schema: coreRule.meta!.schema!,
diff --git a/lib/rules/comma-style.ts b/lib/rules/comma-style.ts
@@ -7,6 +7,7 @@ export default createRule("comma-style", {
             description: "enforce consistent comma style",
             recommended: null,
             extensionRule: true,
+            layout: true,
         },
         fixable: coreRule.meta?.fixable,
         schema: coreRule.meta!.schema!,
diff --git a/lib/rules/indent.ts b/lib/rules/indent.ts
@@ -7,6 +7,7 @@ export default createRule("indent", {
             description: "enforce consistent indentation",
             recommended: null,
             extensionRule: true,
+            layout: true,
         },
         fixable: coreRule.meta?.fixable,
         schema: coreRule.meta!.schema!,
diff --git a/lib/rules/key-name-casing.ts b/lib/rules/key-name-casing.ts
@@ -16,6 +16,7 @@ export default createRule("key-name-casing", {
             description: "enforce naming convention to property key names",
             recommended: null,
             extensionRule: false,
+            layout: false,
         },
         schema: [
             {
@@ -60,7 +61,7 @@ export default createRule("key-name-casing", {
             doesNotMatchFormat:
                 "Property name `{{name}}` must match one of the following formats: {{formats}}",
         },
-        type: "layout",
+        type: "suggestion",
     },
     create(context) {
         if (!context.parserServices.isJSON) {
diff --git a/lib/rules/key-spacing.ts b/lib/rules/key-spacing.ts
@@ -8,6 +8,7 @@ export default createRule("key-spacing", {
                 "enforce consistent spacing between keys and values in object literal properties",
             recommended: null,
             extensionRule: true,
+            layout: true,
         },
         fixable: coreRule.meta?.fixable,
         schema: coreRule.meta!.schema!,
diff --git a/lib/rules/no-bigint-literals.ts b/lib/rules/no-bigint-literals.ts
@@ -7,6 +7,7 @@ export default createRule("no-bigint-literals", {
             description: "disallow BigInt literals",
             recommended: ["json", "jsonc", "json5"],
             extensionRule: false,
+            layout: false,
         },
         schema: [],
         messages: {
diff --git a/lib/rules/no-comments.ts b/lib/rules/no-comments.ts
@@ -7,6 +7,7 @@ export default createRule("no-comments", {
             description: "disallow comments",
             recommended: ["json"],
             extensionRule: false,
+            layout: false,
         },
         schema: [],
         messages: {
diff --git a/lib/rules/no-dupe-keys.ts b/lib/rules/no-dupe-keys.ts
@@ -7,6 +7,7 @@ export default createRule("no-dupe-keys", {
             description: "disallow duplicate keys in object literals",
             recommended: ["json", "jsonc", "json5"],
             extensionRule: true,
+            layout: false,
         },
         fixable: coreRule.meta?.fixable,
         schema: coreRule.meta!.schema!,
diff --git a/lib/rules/no-multi-str.ts b/lib/rules/no-multi-str.ts
@@ -7,6 +7,7 @@ export default createRule("no-multi-str", {
             description: "disallow multiline strings",
             recommended: ["json", "jsonc"],
             extensionRule: true,
+            layout: false,
         },
         fixable: coreRule.meta?.fixable,
         schema: coreRule.meta!.schema!,
diff --git a/lib/rules/no-number-props.ts b/lib/rules/no-number-props.ts
@@ -7,6 +7,7 @@ export default createRule("no-number-props", {
             description: "disallow number property keys",
             recommended: ["json", "jsonc", "json5"],
             extensionRule: false,
+            layout: false,
         },
         fixable: "code",
         schema: [],
diff --git a/lib/rules/no-numeric-separators.ts b/lib/rules/no-numeric-separators.ts
@@ -8,6 +8,7 @@ export default createRule("no-numeric-separators", {
             description: "disallow numeric separators",
             recommended: ["json", "jsonc", "json5"],
             extensionRule: false,
+            layout: false,
         },
         fixable: "code",
         schema: [],
diff --git a/lib/rules/no-octal-escape.ts b/lib/rules/no-octal-escape.ts
@@ -7,6 +7,7 @@ export default createRule("no-octal-escape", {
             description: "disallow octal escape sequences in string literals",
             recommended: null,
             extensionRule: true,
+            layout: false,
         },
         fixable: coreRule.meta?.fixable,
         schema: coreRule.meta!.schema!,
diff --git a/lib/rules/no-regexp-literals.ts b/lib/rules/no-regexp-literals.ts
@@ -7,6 +7,7 @@ export default createRule("no-regexp-literals", {
             description: "disallow RegExp literals",
             recommended: ["json", "jsonc", "json5"],
             extensionRule: false,
+            layout: false,
         },
         schema: [],
         messages: {
diff --git a/lib/rules/no-sparse-arrays.ts b/lib/rules/no-sparse-arrays.ts
@@ -7,6 +7,7 @@ export default createRule("no-sparse-arrays", {
             description: "disallow sparse arrays",
             recommended: ["json", "jsonc", "json5"],
             extensionRule: true,
+            layout: false,
         },
         fixable: coreRule.meta!.fixable,
         schema: coreRule.meta!.schema!,
diff --git a/lib/rules/no-template-literals.ts b/lib/rules/no-template-literals.ts
@@ -7,6 +7,7 @@ export default createRule("no-template-literals", {
             description: "disallow template literals",
             recommended: ["json", "jsonc", "json5"],
             extensionRule: false,
+            layout: false,
         },
         fixable: "code",
         schema: [],
diff --git a/lib/rules/no-undefined-value.ts b/lib/rules/no-undefined-value.ts
@@ -8,6 +8,7 @@ export default createRule("no-undefined-value", {
             description: "disallow `undefined`",
             recommended: ["json", "jsonc", "json5"],
             extensionRule: false,
+            layout: false,
         },
         schema: [],
         messages: {
diff --git a/lib/rules/no-useless-escape.ts b/lib/rules/no-useless-escape.ts
@@ -7,6 +7,7 @@ export default createRule("no-useless-escape", {
             description: "disallow unnecessary escape usage",
             recommended: ["json", "jsonc", "json5"],
             extensionRule: true,
+            layout: false,
         },
         fixable: coreRule.meta?.fixable,
         schema: coreRule.meta!.schema!,
diff --git a/lib/rules/object-curly-newline.ts b/lib/rules/object-curly-newline.ts
@@ -7,6 +7,7 @@ export default createRule("object-curly-newline", {
             description: "enforce consistent line breaks inside braces",
             recommended: null,
             extensionRule: true,
+            layout: true,
         },
         fixable: coreRule.meta?.fixable,
         schema: coreRule.meta!.schema!,
diff --git a/lib/rules/object-curly-spacing.ts b/lib/rules/object-curly-spacing.ts
@@ -7,6 +7,7 @@ export default createRule("object-curly-spacing", {
             description: "enforce consistent spacing inside braces",
             recommended: null,
             extensionRule: true,
+            layout: true,
         },
         fixable: coreRule.meta?.fixable,
         schema: coreRule.meta!.schema!,
diff --git a/lib/rules/object-property-newline.ts b/lib/rules/object-property-newline.ts
@@ -7,6 +7,7 @@ export default createRule("object-property-newline", {
             description: "enforce placing object properties on separate lines",
             recommended: null,
             extensionRule: true,
+            layout: true,
         },
         fixable: coreRule.meta?.fixable,
         schema: coreRule.meta!.schema!,
diff --git a/lib/rules/quote-props.ts b/lib/rules/quote-props.ts
@@ -7,6 +7,7 @@ export default createRule("quote-props", {
             description: "require quotes around object literal property names",
             recommended: ["json", "jsonc"],
             extensionRule: true,
+            layout: true,
         },
         fixable: coreRule.meta?.fixable,
         schema: coreRule.meta!.schema!,
diff --git a/lib/rules/quotes.ts b/lib/rules/quotes.ts
@@ -7,6 +7,7 @@ export default createRule("quotes", {
             description: "enforce use of double or single quotes",
             recommended: ["json", "jsonc"],
             extensionRule: true,
+            layout: true,
         },
         fixable: coreRule.meta?.fixable,
         schema: coreRule.meta!.schema!,
diff --git a/lib/rules/sort-keys.ts b/lib/rules/sort-keys.ts
@@ -54,6 +54,7 @@ export default createRule("sort-keys", {
             description: "require object keys to be sorted",
             recommended: null,
             extensionRule: true,
+            layout: false,
         },
         fixable: "code",
         schema: [
diff --git a/lib/rules/space-unary-ops.ts b/lib/rules/space-unary-ops.ts
@@ -7,6 +7,7 @@ export default createRule("space-unary-ops", {
             description: "disallow spaces after unary operators",
             recommended: ["json", "jsonc", "json5"],
             extensionRule: true,
+            layout: true,
         },
         fixable: coreRule.meta!.fixable,
         schema: coreRule.meta!.schema!,
diff --git a/lib/rules/valid-json-number.ts b/lib/rules/valid-json-number.ts
@@ -22,6 +22,7 @@ export default createRule("valid-json-number", {
             description: "disallow invalid number for JSON",
             recommended: ["json", "jsonc"],
             extensionRule: false,
+            layout: false,
         },
         fixable: "code",
         schema: [],
diff --git a/lib/rules/vue-custom-block/no-parsing-error.ts b/lib/rules/vue-custom-block/no-parsing-error.ts
@@ -11,6 +11,7 @@ export default createRule("vue-custom-block/no-parsing-error", {
             description: "disallow parsing errors in Vue custom blocks",
             recommended: ["json", "json5", "jsonc"],
             extensionRule: false,
+            layout: false,
         },
         schema: [],
         messages: {},
diff --git a/lib/types.ts b/lib/types.ts
@@ -20,6 +20,7 @@ export interface RuleMetaData {
         replacedBy?: []
         default?: "error" | "warn"
         extensionRule: boolean
+        layout: boolean
     }
     messages: { [messageId: string]: string }
     fixable?: "code" | "whitespace"
@@ -43,6 +44,7 @@ export interface PartialRuleMetaData {
         replacedBy?: []
         default?: "error" | "warn"
         extensionRule: boolean
+        layout: boolean
     }
     messages: { [messageId: string]: string }
     fixable?: "code" | "whitespace"
diff --git a/package.json b/package.json
@@ -57,7 +57,7 @@
         "eslint": "^5.0.0 || >=6.0.0"
     },
     "devDependencies": {
-        "@ota-meshi/eslint-plugin": "^0.0.15",
+        "@ota-meshi/eslint-plugin": "^0.0.16",
         "@types/eslint": "^7.2.0",
         "@types/eslint-scope": "^3.7.0",
         "@types/eslint-visitor-keys": "^1.0.0",
diff --git a/tools/update-rulesets.ts b/tools/update-rulesets.ts
