eslint-config-prettier 6.15.0 → 8.0.0

package/bin/cli.js

@@ -2,40 +2,40 @@
 
 "use strict";
 
-const fs = require("fs");
-const path = require("path");
-const getStdin = require("get-stdin");
 const validators = require("./validators");
+const config = require("..");
+const prettier = require("../prettier");
+
+// Require locally installed eslint, for `npx eslint-config-prettier` support
+// with no local eslint-config-prettier installation.
+const { ESLint } = require(require.resolve("eslint", {
+  paths: [process.cwd(), ...require.resolve.paths("eslint")],
+}));
 
 const SPECIAL_RULES_URL =
   "https://github.com/prettier/eslint-config-prettier#special-rules";
 
+const PRETTIER_RULES_URL =
+  "https://github.com/prettier/eslint-config-prettier#arrow-body-style-and-prefer-arrow-callback";
+
 if (module === require.main) {
-  if (process.argv.length > 2 || process.stdin.isTTY) {
-    console.error(
-      [
-        "This tool checks whether an ESLint configuration contains rules that are",
-        "unnecessary or conflict with Prettier. It’s supposed to be run like this:",
-        "",
-        "  npx eslint --print-config path/to/main.js | npx eslint-config-prettier-check",
-        "  npx eslint --print-config test/index.js | npx eslint-config-prettier-check",
-        "",
-        "Exit codes:",
-        "",
-        "0: No automatically detectable problems found.",
-        "1: Unexpected error.",
-        "2: Conflicting rules found.",
-        "",
-        "For more information, see:",
-        "https://github.com/prettier/eslint-config-prettier#cli-helper-tool",
-      ].join("\n")
-    );
+  const args = process.argv.slice(2);
+
+  if (args.length === 0) {
+    console.error(help());
     process.exit(1);
   }
 
-  getStdin()
-    .then((string) => {
-      const result = processString(string);
+  const eslint = new ESLint();
+
+  Promise.all(args.map((file) => eslint.calculateConfigForFile(file)))
+    .then((configs) => {
+      const rules = [].concat(
+        ...configs.map(({ rules }, index) =>
+          Object.entries(rules).map((entry) => [...entry, args[index]])
+        )
+      );
+      const result = processRules(rules);
       if (result.stderr) {
         console.error(result.stderr);
       }
@@ -45,107 +45,77 @@ if (module === require.main) {
       process.exit(result.code);
     })
     .catch((error) => {
-      console.error("Unexpected error", error);
+      console.error(error.message);
       process.exit(1);
     });
 }
 
-function processString(string) {
-  let config;
-  try {
-    config = JSON.parse(string);
-  } catch (error) {
-    return {
-      stderr: `Failed to parse JSON:\n${error.message}`,
-      code: 1,
-    };
-  }
+function help() {
+  return `
+Usage: npx eslint-config-prettier FILE...
 
-  if (
-    !(
-      Object.prototype.toString.call(config) === "[object Object]" &&
-      Object.prototype.toString.call(config.rules) === "[object Object]"
-    )
-  ) {
-    return {
-      stderr: `Expected a \`{"rules: {...}"}\` JSON object, but got:\n${string}`,
-      code: 1,
-    };
-  }
+Resolves an ESLint configuration for every given FILE and checks if they
+contain rules that are unnecessary or conflict with Prettier. Example:
 
-  // This used to look at "files" in package.json, but that is not reliable due
-  // to an npm bug. See:
-  // https://github.com/prettier/eslint-config-prettier/issues/57
-  const allRules = Object.assign(
-    Object.create(null),
-    ...fs
-      .readdirSync(path.join(__dirname, ".."))
-      .filter((name) => !name.startsWith(".") && name.endsWith(".js"))
-      .map((ruleFileName) => require(`../${ruleFileName}`).rules)
-  );
+  npx eslint-config-prettier index.js test/index.js other/file/to/check.js
 
-  const regularRules = filterRules(
-    allRules,
-    (ruleName, value) => value === "off"
-  );
+Exit codes:
+
+0: No automatically detectable problems found.
+1: General error.
+2: Conflicting rules found.
+
+For more information, see:
+https://github.com/prettier/eslint-config-prettier#cli-helper-tool
+  `.trim();
+}
+
+function processRules(configRules) {
+  const regularRules = filterRules(config.rules, (_, value) => value === "off");
   const optionsRules = filterRules(
-    allRules,
+    config.rules,
     (ruleName, value) => value === 0 && ruleName in validators
   );
   const specialRules = filterRules(
-    allRules,
+    config.rules,
     (ruleName, value) => value === 0 && !(ruleName in validators)
   );
 
-  const flaggedRules = Object.keys(config.rules)
-    .map((ruleName) => {
-      const value = config.rules[ruleName];
+  const enabledRules = configRules
+    .map(([ruleName, value, source]) => {
       const arrayValue = Array.isArray(value) ? value : [value];
-      const level = arrayValue[0];
-      const options = arrayValue.slice(1);
+      const [level, ...options] = arrayValue;
       const isOff = level === "off" || level === 0;
-      return !isOff && ruleName in allRules ? { ruleName, options } : null;
+      return isOff ? null : { ruleName, options, source };
     })
     .filter(Boolean);
 
+  const flaggedRules = enabledRules.filter(
+    ({ ruleName }) => ruleName in config.rules
+  );
+
   const regularFlaggedRuleNames = filterRuleNames(
     flaggedRules,
-    (ruleName) => ruleName in regularRules
+    ({ ruleName }) => ruleName in regularRules
   );
   const optionsFlaggedRuleNames = filterRuleNames(
     flaggedRules,
-    (ruleName, options) =>
-      ruleName in optionsRules && !validators[ruleName](options)
+    ({ ruleName, ...rule }) =>
+      ruleName in optionsRules && !validators[ruleName](rule)
   );
   const specialFlaggedRuleNames = filterRuleNames(
     flaggedRules,
-    (ruleName) => ruleName in specialRules
+    ({ ruleName }) => ruleName in specialRules
+  );
+  const prettierFlaggedRuleNames = filterRuleNames(
+    enabledRules,
+    ({ ruleName, source }) =>
+      ruleName in prettier.rules &&
+      enabledRules.some(
+        (rule) =>
+          rule.ruleName === "prettier/prettier" && rule.source === source
+      )
   );
-
-  if (
-    regularFlaggedRuleNames.length === 0 &&
-    optionsFlaggedRuleNames.length === 0
-  ) {
-    const baseMessage =
-      "No rules that are unnecessary or conflict with Prettier were found.";
-
-    const message =
-      specialFlaggedRuleNames.length === 0
-        ? baseMessage
-        : [
-            baseMessage,
-            "",
-            "However, the following rules are enabled but cannot be automatically checked. See:",
-            SPECIAL_RULES_URL,
-            "",
-            printRuleNames(specialFlaggedRuleNames),
-          ].join("\n");
-
-    return {
-      stdout: message,
-      code: 0,
-    };
-  }
 
   const regularMessage = [
     "The following rules are unnecessary or might conflict with Prettier:",
@@ -154,7 +124,7 @@ function processString(string) {
   ].join("\n");
 
   const optionsMessage = [
-    "The following rules are enabled with options that might conflict with Prettier. See:",
+    "The following rules are enabled with config that might conflict with Prettier. See:",
     SPECIAL_RULES_URL,
     "",
     printRuleNames(optionsFlaggedRuleNames),
@@ -167,10 +137,41 @@ function processString(string) {
     printRuleNames(specialFlaggedRuleNames),
   ].join("\n");
 
+  const prettierMessage = [
+    "The following rules can cause issues when using eslint-plugin-prettier at the same time.",
+    "Only enable them if you know what you are doing! See:",
+    PRETTIER_RULES_URL,
+    "",
+    printRuleNames(prettierFlaggedRuleNames),
+  ].join("\n");
+
+  if (
+    regularFlaggedRuleNames.length === 0 &&
+    optionsFlaggedRuleNames.length === 0
+  ) {
+    const message =
+      specialFlaggedRuleNames.length === 0 &&
+      prettierFlaggedRuleNames.length === 0
+        ? "No rules that are unnecessary or conflict with Prettier were found."
+        : [
+            specialFlaggedRuleNames.length === 0 ? null : specialMessage,
+            prettierFlaggedRuleNames.length === 0 ? null : prettierMessage,
+            "Other than that, no rules that are unnecessary or conflict with Prettier were found.",
+          ]
+            .filter(Boolean)
+            .join("\n\n");
+
+    return {
+      stdout: message,
+      code: 0,
+    };
+  }
+
   const message = [
     regularFlaggedRuleNames.length === 0 ? null : regularMessage,
     optionsFlaggedRuleNames.length === 0 ? null : optionsMessage,
     specialFlaggedRuleNames.length === 0 ? null : specialMessage,
+    prettierFlaggedRuleNames.length === 0 ? null : prettierMessage,
   ]
     .filter(Boolean)
     .join("\n\n");
@@ -182,18 +183,18 @@ function processString(string) {
 }
 
 function filterRules(rules, fn) {
-  return Object.keys(rules)
-    .filter((ruleName) => fn(ruleName, rules[ruleName]))
-    .reduce((obj, ruleName) => {
+  return Object.entries(rules)
+    .filter(([ruleName, value]) => fn(ruleName, value))
+    .reduce((obj, [ruleName]) => {
       obj[ruleName] = true;
       return obj;
     }, Object.create(null));
 }
 
 function filterRuleNames(rules, fn) {
-  return rules
-    .filter((rule) => fn(rule.ruleName, rule.options))
-    .map((rule) => rule.ruleName);
+  return [
+    ...new Set(rules.filter((rule) => fn(rule)).map((rule) => rule.ruleName)),
+  ];
 }
 
 function printRuleNames(ruleNames) {
@@ -204,4 +205,4 @@ function printRuleNames(ruleNames) {
     .join("\n");
 }
 
-exports.processString = processString;
+exports.processRules = processRules;

package/bin/validators.js

@@ -4,7 +4,7 @@
 // `false` if the options DO conflict with Prettier, and `true` if they don’t.
 
 module.exports = {
-  curly(options) {
+  "curly"({ options }) {
     if (options.length === 0) {
       return true;
     }
@@ -13,7 +13,7 @@ module.exports = {
     return firstOption !== "multi-line" && firstOption !== "multi-or-nest";
   },
 
-  "lines-around-comment"(options) {
+  "lines-around-comment"({ options }) {
     if (options.length === 0) {
       return false;
     }
@@ -30,7 +30,7 @@ module.exports = {
     );
   },
 
-  "no-confusing-arrow"(options) {
+  "no-confusing-arrow"({ options }) {
     if (options.length === 0) {
       return false;
     }
@@ -39,7 +39,16 @@ module.exports = {
     return firstOption ? firstOption.allowParens === false : false;
   },
 
-  "vue/html-self-closing"(options) {
+  "no-tabs"({ options }) {
+    if (options.length === 0) {
+      return false;
+    }
+
+    const firstOption = options[0];
+    return Boolean(firstOption && firstOption.allowIndentationTabs);
+  },
+
+  "vue/html-self-closing"({ options }) {
     if (options.length === 0) {
       return false;
     }

package/index.js

@@ -3,101 +3,186 @@
 const includeDeprecated = !process.env.ESLINT_CONFIG_PRETTIER_NO_DEPRECATED;
 
 module.exports = {
-  rules: Object.assign(
-    {
-      // The following rules can be used in some cases. See the README for more
-      // information. (These are marked with `0` instead of `"off"` so that a
-      // script can distinguish them.)
-      "arrow-body-style": 0,
-      curly: 0,
-      "lines-around-comment": 0,
-      "max-len": 0,
-      "no-confusing-arrow": 0,
-      "no-mixed-operators": 0,
-      "no-tabs": 0,
-      "no-unexpected-multiline": 0,
-      "prefer-arrow-callback": 0,
-      quotes: 0,
-      // The rest are rules that you never need to enable when using Prettier.
-      "array-bracket-newline": "off",
-      "array-bracket-spacing": "off",
-      "array-element-newline": "off",
-      "arrow-parens": "off",
-      "arrow-spacing": "off",
-      "block-spacing": "off",
-      "brace-style": "off",
-      "comma-dangle": "off",
-      "comma-spacing": "off",
-      "comma-style": "off",
-      "computed-property-spacing": "off",
-      "dot-location": "off",
-      "eol-last": "off",
-      "func-call-spacing": "off",
-      "function-call-argument-newline": "off",
-      "function-paren-newline": "off",
-      "generator-star": "off",
-      "generator-star-spacing": "off",
-      "implicit-arrow-linebreak": "off",
-      indent: "off",
-      "jsx-quotes": "off",
-      "key-spacing": "off",
-      "keyword-spacing": "off",
-      "linebreak-style": "off",
-      "multiline-ternary": "off",
-      "newline-per-chained-call": "off",
-      "new-parens": "off",
-      "no-arrow-condition": "off",
-      "no-comma-dangle": "off",
-      "no-extra-parens": "off",
-      "no-extra-semi": "off",
-      "no-floating-decimal": "off",
-      "no-mixed-spaces-and-tabs": "off",
-      "no-multi-spaces": "off",
-      "no-multiple-empty-lines": "off",
-      "no-reserved-keys": "off",
-      "no-space-before-semi": "off",
-      "no-trailing-spaces": "off",
-      "no-whitespace-before-property": "off",
-      "no-wrap-func": "off",
-      "nonblock-statement-body-position": "off",
-      "object-curly-newline": "off",
-      "object-curly-spacing": "off",
-      "object-property-newline": "off",
-      "one-var-declaration-per-line": "off",
-      "operator-linebreak": "off",
-      "padded-blocks": "off",
-      "quote-props": "off",
-      "rest-spread-spacing": "off",
-      semi: "off",
-      "semi-spacing": "off",
-      "semi-style": "off",
-      "space-after-function-name": "off",
-      "space-after-keywords": "off",
-      "space-before-blocks": "off",
-      "space-before-function-paren": "off",
-      "space-before-function-parentheses": "off",
-      "space-before-keywords": "off",
-      "space-in-brackets": "off",
-      "space-in-parens": "off",
-      "space-infix-ops": "off",
-      "space-return-throw-case": "off",
-      "space-unary-ops": "off",
-      "space-unary-word-ops": "off",
-      "switch-colon-spacing": "off",
-      "template-curly-spacing": "off",
-      "template-tag-spacing": "off",
-      "unicode-bom": "off",
-      "wrap-iife": "off",
-      "wrap-regex": "off",
-      "yield-star-spacing": "off",
-    },
-    includeDeprecated && {
+  rules: {
+    // The following rules can be used in some cases. See the README for more
+    // information. (These are marked with `0` instead of `"off"` so that a
+    // script can distinguish them.)
+    "curly": 0,
+    "lines-around-comment": 0,
+    "max-len": 0,
+    "no-confusing-arrow": 0,
+    "no-mixed-operators": 0,
+    "no-tabs": 0,
+    "no-unexpected-multiline": 0,
+    "quotes": 0,
+    "@typescript-eslint/quotes": 0,
+    "babel/quotes": 0,
+    "vue/html-self-closing": 0,
+    "vue/max-len": 0,
+
+    // The rest are rules that you never need to enable when using Prettier.
+    "array-bracket-newline": "off",
+    "array-bracket-spacing": "off",
+    "array-element-newline": "off",
+    "arrow-parens": "off",
+    "arrow-spacing": "off",
+    "block-spacing": "off",
+    "brace-style": "off",
+    "comma-dangle": "off",
+    "comma-spacing": "off",
+    "comma-style": "off",
+    "computed-property-spacing": "off",
+    "dot-location": "off",
+    "eol-last": "off",
+    "func-call-spacing": "off",
+    "function-call-argument-newline": "off",
+    "function-paren-newline": "off",
+    "generator-star": "off",
+    "generator-star-spacing": "off",
+    "implicit-arrow-linebreak": "off",
+    "indent": "off",
+    "jsx-quotes": "off",
+    "key-spacing": "off",
+    "keyword-spacing": "off",
+    "linebreak-style": "off",
+    "multiline-ternary": "off",
+    "newline-per-chained-call": "off",
+    "new-parens": "off",
+    "no-arrow-condition": "off",
+    "no-comma-dangle": "off",
+    "no-extra-parens": "off",
+    "no-extra-semi": "off",
+    "no-floating-decimal": "off",
+    "no-mixed-spaces-and-tabs": "off",
+    "no-multi-spaces": "off",
+    "no-multiple-empty-lines": "off",
+    "no-reserved-keys": "off",
+    "no-space-before-semi": "off",
+    "no-trailing-spaces": "off",
+    "no-whitespace-before-property": "off",
+    "no-wrap-func": "off",
+    "nonblock-statement-body-position": "off",
+    "object-curly-newline": "off",
+    "object-curly-spacing": "off",
+    "object-property-newline": "off",
+    "one-var-declaration-per-line": "off",
+    "operator-linebreak": "off",
+    "padded-blocks": "off",
+    "quote-props": "off",
+    "rest-spread-spacing": "off",
+    "semi": "off",
+    "semi-spacing": "off",
+    "semi-style": "off",
+    "space-after-function-name": "off",
+    "space-after-keywords": "off",
+    "space-before-blocks": "off",
+    "space-before-function-paren": "off",
+    "space-before-function-parentheses": "off",
+    "space-before-keywords": "off",
+    "space-in-brackets": "off",
+    "space-in-parens": "off",
+    "space-infix-ops": "off",
+    "space-return-throw-case": "off",
+    "space-unary-ops": "off",
+    "space-unary-word-ops": "off",
+    "switch-colon-spacing": "off",
+    "template-curly-spacing": "off",
+    "template-tag-spacing": "off",
+    "unicode-bom": "off",
+    "wrap-iife": "off",
+    "wrap-regex": "off",
+    "yield-star-spacing": "off",
+    "@typescript-eslint/brace-style": "off",
+    "@typescript-eslint/comma-dangle": "off",
+    "@typescript-eslint/comma-spacing": "off",
+    "@typescript-eslint/func-call-spacing": "off",
+    "@typescript-eslint/indent": "off",
+    "@typescript-eslint/keyword-spacing": "off",
+    "@typescript-eslint/member-delimiter-style": "off",
+    "@typescript-eslint/no-extra-parens": "off",
+    "@typescript-eslint/no-extra-semi": "off",
+    "@typescript-eslint/object-curly-spacing": "off",
+    "@typescript-eslint/semi": "off",
+    "@typescript-eslint/space-before-function-paren": "off",
+    "@typescript-eslint/space-infix-ops": "off",
+    "@typescript-eslint/type-annotation-spacing": "off",
+    "babel/object-curly-spacing": "off",
+    "babel/semi": "off",
+    "flowtype/boolean-style": "off",
+    "flowtype/delimiter-dangle": "off",
+    "flowtype/generic-spacing": "off",
+    "flowtype/object-type-delimiter": "off",
+    "flowtype/semi": "off",
+    "flowtype/space-after-type-colon": "off",
+    "flowtype/space-before-generic-bracket": "off",
+    "flowtype/space-before-type-colon": "off",
+    "flowtype/union-intersection-spacing": "off",
+    "react/jsx-child-element-spacing": "off",
+    "react/jsx-closing-bracket-location": "off",
+    "react/jsx-closing-tag-location": "off",
+    "react/jsx-curly-newline": "off",
+    "react/jsx-curly-spacing": "off",
+    "react/jsx-equals-spacing": "off",
+    "react/jsx-first-prop-new-line": "off",
+    "react/jsx-indent": "off",
+    "react/jsx-indent-props": "off",
+    "react/jsx-max-props-per-line": "off",
+    "react/jsx-newline": "off",
+    "react/jsx-one-expression-per-line": "off",
+    "react/jsx-props-no-multi-spaces": "off",
+    "react/jsx-tag-spacing": "off",
+    "react/jsx-wrap-multilines": "off",
+    "standard/array-bracket-even-spacing": "off",
+    "standard/computed-property-even-spacing": "off",
+    "standard/object-curly-even-spacing": "off",
+    "unicorn/empty-brace-spaces": "off",
+    "unicorn/no-nested-ternary": "off",
+    "unicorn/number-literal-case": "off",
+    "vue/array-bracket-newline": "off",
+    "vue/array-bracket-spacing": "off",
+    "vue/arrow-spacing": "off",
+    "vue/block-spacing": "off",
+    "vue/block-tag-newline": "off",
+    "vue/brace-style": "off",
+    "vue/comma-dangle": "off",
+    "vue/comma-spacing": "off",
+    "vue/comma-style": "off",
+    "vue/dot-location": "off",
+    "vue/func-call-spacing": "off",
+    "vue/html-closing-bracket-newline": "off",
+    "vue/html-closing-bracket-spacing": "off",
+    "vue/html-end-tags": "off",
+    "vue/html-indent": "off",
+    "vue/html-quotes": "off",
+    "vue/key-spacing": "off",
+    "vue/keyword-spacing": "off",
+    "vue/max-attributes-per-line": "off",
+    "vue/multiline-html-element-content-newline": "off",
+    "vue/mustache-interpolation-spacing": "off",
+    "vue/no-extra-parens": "off",
+    "vue/no-multi-spaces": "off",
+    "vue/no-spaces-around-equal-signs-in-attribute": "off",
+    "vue/object-curly-newline": "off",
+    "vue/object-curly-spacing": "off",
+    "vue/object-property-newline": "off",
+    "vue/operator-linebreak": "off",
+    "vue/script-indent": "off",
+    "vue/singleline-html-element-content-newline": "off",
+    "vue/space-in-parens": "off",
+    "vue/space-infix-ops": "off",
+    "vue/space-unary-ops": "off",
+    "vue/template-curly-spacing": "off",
+
+    ...(includeDeprecated && {
       // Deprecated since version 4.0.0.
       // https://github.com/eslint/eslint/pull/8286
       "indent-legacy": "off",
       // Deprecated since version 3.3.0.
       // https://eslint.org/docs/rules/no-spaced-func
       "no-spaced-func": "off",
-    }
-  ),
+      // Deprecated since version 7.0.0.
+      // https://github.com/yannickcr/eslint-plugin-react/blob/master/CHANGELOG.md#700---2017-05-06
+      "react/jsx-space-before-closing": "off",
+    }),
+  },
 };