eslint-config-prettier - npm Package Compare versions

Comparing version 6.4.0 to 6.5.0

CHANGELOG.md

@@ -0,1 +1,6 @@
+### Version 6.5.0 (2019-10-26)
+
+- Added: Support for [excluding deprecated rules]. Thanks to Alex Ilyaev
+  (@alexilyaev)!
+
 ### Version 6.4.0 (2019-10-05)
@@ -332,2 +337,3 @@
 [eslint-plugin-vue]: https://github.com/vuejs/eslint-plugin-vue
+[excluding deprecated rules]: https://github.com/prettier/eslint-config-prettier/tree/9f6b59486ad742dc12ad3be157ddff5f8454ef7a#excluding-deprecated-rules
 [flowtype/boolean-style]: https://github.com/gajus/eslint-plugin-flowtype#eslint-plugin-flowtype-rules-boolean-style
@@ -334,0 +340,0 @@ [function-call-argument-newline]: https://eslint.org/docs/rules/function-call-argument-newline

index.js

 "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"
+    }
+  )
 };

package.json

 {
   "name": "eslint-config-prettier",
-  "version": "6.4.0",
+  "version": "6.5.0",
   "license": "MIT",
@@ -32,2 +32,3 @@ "author": "Simon Lydell",
     "test:lint-rules": "eslint index.js --config test-config/.eslintrc.js --format json",
+    "test:deprecated": "eslint-find-rules --deprecated index.js",
     "test:jest": "jest",
@@ -42,9 +43,10 @@ "test:cli-sanity": "eslint --print-config index.js | node ./bin/cli.js",
   "devDependencies": {
-    "@typescript-eslint/eslint-plugin": "2.3.2",
-    "@typescript-eslint/parser": "2.3.2",
+    "@typescript-eslint/eslint-plugin": "2.5.0",
+    "@typescript-eslint/parser": "2.5.0",
     "babel-eslint": "10.0.3",
     "cross-spawn": "6.0.5",
     "doctoc": "1.4.0",
-    "eslint": "6.5.1",
+    "eslint": "6.6.0",
     "eslint-config-google": "0.14.0",
+    "eslint-find-rules": "3.4.0",
     "eslint-plugin-babel": "5.3.0",
@@ -55,3 +57,3 @@ "eslint-plugin-flowtype": "4.3.0",
     "eslint-plugin-standard": "4.0.1",
-    "eslint-plugin-unicorn": "12.0.2",
+    "eslint-plugin-unicorn": "12.1.0",
     "eslint-plugin-vue": "5.2.3",
@@ -62,3 +64,3 @@ "jest": "24.9.0",
     "rimraf": "3.0.0",
-    "typescript": "3.6.3"
+    "typescript": "3.6.4"
   },
@@ -65,0 +67,0 @@ "peerDependencies": {

react.js

 "use strict";
 
+const includeDeprecated = !process.env.ESLINT_CONFIG_PRETTIER_NO_DEPRECATED;
+
 module.exports = {
-  rules: {
-    "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-one-expression-per-line": "off",
-    "react/jsx-props-no-multi-spaces": "off",
-    "react/jsx-space-before-closing": "off",
-    "react/jsx-tag-spacing": "off",
-    "react/jsx-wrap-multilines": "off"
-  }
+  rules: Object.assign(
+    {
+      "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-one-expression-per-line": "off",
+      "react/jsx-props-no-multi-spaces": "off",
+      "react/jsx-tag-spacing": "off",
+      "react/jsx-wrap-multilines": "off"
+    },
+    includeDeprecated && {
+      // 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"
+    }
+  )
 };

README.md

@@ -18,2 +18,3 @@ # eslint-config-prettier [![Build Status][travis-badge]][travis]
 - [Installation](#installation)
+  - [Excluding deprecated rules](#excluding-deprecated-rules)
 - [CLI helper tool](#cli-helper-tool)
@@ -112,2 +113,14 @@ - [Example configuration](#example-configuration)
 
+### 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
@@ -785,3 +798,3 @@
 
-- ESLint 6.5.1
+- ESLint 6.6.0
   - eslint-config-prettier 5.1.0 and older were tested with ESLint 5.x
@@ -791,3 +804,3 @@ - eslint-config-prettier 2.10.0 and older were tested with ESLint 4.x
 - prettier 1.18.2
-- @typescript-eslint/eslint-plugin 2.3.2
+- @typescript-eslint/eslint-plugin 2.5.0
 - eslint-plugin-babel 5.3.0
@@ -797,3 +810,3 @@ - eslint-plugin-flowtype 4.3.0
 - eslint-plugin-standard 4.0.1
-- eslint-plugin-unicorn 12.0.2
+- eslint-plugin-unicorn 12.1.0
 - eslint-plugin-vue 5.2.3
@@ -800,0 +813,0 @@

No alert changes

Improved metrics

Total package byte prevSize

58570

increased by2.91%

Lines of code

434

increased by3.83%

Number of lines in readme file

909

increased by1.45%

Worsened metrics

Dev dependency count

20

increased by5.26%

No dependency changes