Handle deprecated rules (closes #112) (#121)

* Conditionally add deprecated rules based on environment variable * Added docs and tests * Improve test for deprecated rules * Update readme * Remove no longer needed mocking Co-authored-by: Simon Lydell <simon.lydell@gmail.com>
prettier · Oct 26, 2019 · 4fdaa04 · 4fdaa04
1 parent c8f1a2d
commit 4fdaa04
Show file tree

Hide file tree

Showing 9 changed files with 512 additions and 123 deletions.
diff --git a/.eslintrc.base.js b/.eslintrc.base.js
@@ -43,6 +43,7 @@ module.exports = {
     "react/jsx-no-bind": "off",
     // Force a conflict with Prettier in test-lint/standard.js.
     "standard/computed-property-even-spacing": ["error", "even"],
+    "unicorn/consistent-function-scoping": "off",
     "unicorn/filename-case": "off",
     "unicorn/no-nested-ternary": "off",
     "unicorn/prefer-flat-map": "off",

diff --git a/README.md b/README.md
@@ -15,6 +15,7 @@ it together with some other config.
 
 
 - [Installation](#installation)
+  - [Excluding deprecated rules](#excluding-deprecated-rules)
 - [CLI helper tool](#cli-helper-tool)
 - [Example configuration](#example-configuration)
 - [Special rules](#special-rules)
@@ -108,6 +109,18 @@ enables [eslint-plugin-react] rules, so `"prettier/react"` is needed:
 If you’re unsure which plugins are used, you can usually find them in your
 `package.json`.
 
+### Excluding deprecated rules
+
+Some of the rules that eslint-config-prettier turns off may be deprecated.
+**This is perfectly fine,** but if you really need to omit the
+deprecated rules, you can do so by setting the
+`ESLINT_CONFIG_PRETTIER_NO_DEPRECATED` environment variable to a non-empty
+value. For example:
+
+```
+env ESLINT_CONFIG_PRETTIER_NO_DEPRECATED=true npx eslint-find-rules --deprecated index.js
+```
+
 ## CLI helper tool
 
 eslint-config-prettier also ships with a little CLI tool to help you check if

diff --git a/index.js b/index.js
@@ -1,93 +1,103 @@
 "use strict";
 
+const includeDeprecated = !process.env.ESLINT_CONFIG_PRETTIER_NO_DEPRECATED;
+
 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"
+    },
+    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"
+    }
+  )
 };