Deprecated rules should be added conditionally

prettier · Oct 18, 2019 · 75bee9c · 75bee9c
1 parent 8a2b5d9
commit 75bee9c
Show file tree

Hide file tree

Showing 6 changed files with 306 additions and 172 deletions.
diff --git a/.npmrc b/.npmrc
@@ -0,0 +1 @@
+save-exact = true
diff --git a/index.js b/index.js
@@ -1,93 +1,105 @@
 "use strict";
 
+const semver = require("semver");
+const findDependencyVersion = require("./lib/find-dependency-version");
+
+const eslintVersion = semver.minVersion(
+  findDependencyVersion("eslint") || "0.0.0"
+);
+
 module.exports = {
-  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.)
-    "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",
-    "indent-legacy": "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-spaced-func": "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"
-  }
+  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"
+    },
+    // Deprecated rules from specific versions, see:
+    // https://github.com/prettier/eslint-config-prettier/issues/112
+    semver.lt(eslintVersion, "4.0.0") && {
+      "indent-legacy": "off"
+    }
+  )
 };
diff --git a/lib/find-dependency-version.js b/lib/find-dependency-version.js
@@ -0,0 +1,31 @@
+"use strict";
+
+const readPkgUp = require("read-pkg-up");
+
+/**
+ * Find the version of a given dependency name from closest `package.json`,
+ * Relative to `process.cwd()`.
+ *
+ * @param {string} dependencyName
+ * @return {string|null} Semver version of the dependency or `null`
+ */
+module.exports = function findDependencyVersion(dependencyName) {
+  try {
+    const pkg = readPkgUp.sync({ normalize: false }).packageJson;
+
+    if (!pkg) {
+      return null;
+    }
+
+    return (
+      (pkg.dependencies && pkg.dependencies[dependencyName]) ||
+      (pkg.devDependencies && pkg.devDependencies[dependencyName]) ||
+      (pkg.peerDependencies && pkg.peerDependencies[dependencyName]) ||
+      (pkg.optionalDependencies && pkg.optionalDependencies[dependencyName]) ||
+      null
+    );
+  } catch (error) {
+    // Ignore the error if failed
+    return null;
+  }
+};