eslint-config-prettier 4.3.0 → 6.1.0

package/CHANGELOG.md

@@ -1,3 +1,69 @@
+### Version 6.1.0 (2019-08-19)
+
+- Added: [function-call-argument-newline] \(new in ESLint 6.2.0). Thanks to
+  Masafumi Koba (@ybiquitous)!
+
+### Version 6.0.0 (2019-06-25)
+
+- Changed: The CLI helper tool now considers [no-confusing-arrow] to conflict
+  if you use the default value of its `allowParens` option. The default was
+  changed to `true` in ESLint 6, which conflicts with Prettier.
+
+  If the CLI helper tool gives you errors about this after upgrading, the
+  solution is to change this:
+
+  ```json
+  {
+    "rules": {
+      "no-confusing-arrow": ["error"]
+    }
+  }
+  ```
+
+  Into this:
+
+  ```json
+  {
+    "rules": {
+      "no-confusing-arrow": ["error", { "allowParens": false }]
+    }
+  }
+  ```
+
+  The latter works in both ESLint 6 as well as in ESLint 5 and older.
+
+- Improved: `eslint --print-config` usage instructions. The CLI tool help
+  text as well as the documentation has been updated to suggest commands that
+  work in ESLint 6.0 as well as in ESLint 5 and older. (Instead of `eslint
+  --print-config .`, use `eslint --print-config path/to/main.js`.)
+
+### Version 5.1.0 (2019-06-25)
+
+- Added: [react/jsx-curly-newline]. Thanks to Masafumi Koba (@ybiquitous)!
+
+### Version 5.0.0 (2019-06-15)
+
+- Removed: [react/self-closing-comp]. This rule was added in v4.1.0 not
+  because it _conflicted_ with Prettier but because it was _unnecessary_ when
+  using Prettier. However, in v1.18.0 [Prettier stopped converting empty
+  elements to self-closing elements][prettier-self-closing]. So the rule is
+  not unnecessary anymore.
+
+  If you use Prettier v1.17.1 or older you should be able to upgrade
+  eslint-config-prettier to v5.0.0 without having to do anything else.
+
+  If you use Prettier v1.18.0 or newer, you might get lint errors about for
+  example changing `<div></div>` into `<div />`. You have two options:
+
+  - Run `eslint --fix` if you prefer to enforce self-closing elements where
+    possible. This should fix all the errors.
+  - Add `"react/self-closing-comp": "off"` to your ESLint config if you use
+    autofix from your editor and you face the same [issue as Prettier
+    did][prettier-self-closing].
+
+- Changed: Node.js 6 is no longer officially supported, but v5.0.0 should
+  still work with it.
+
 ### Version 4.3.0 (2019-05-16)
 
 - Added: New [eslint-plugin-vue] rules: [vue/arrow-spacing],
@@ -13,7 +79,7 @@
 ### Version 4.1.0 (2019-02-26)
 
 - Added: [linebreak-style]. Use Prettier’s [end-of-line] option instead.
-- Added: [self-closing-comp]. Thanks to Gaurav Gupta (@gaurav5430)!
+- Added: [react/self-closing-comp]. Thanks to Gaurav Gupta (@gaurav5430)!
 
 ### Version 4.0.0 (2019-01-26)
 
@@ -228,14 +294,15 @@
 [@typescript-eslint/func-call-spacing]: https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/func-call-spacing.md
 [@typescript-eslint/no-extra-parens]: https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/no-extra-parens.md
 [@typescript-eslint/semi]: https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/semi.md
-[ESLint 4.0.0]: https://eslint.org/blog/2017/06/eslint-v4.0.0-released
-[ESLint 4.6.0]: https://eslint.org/blog/2017/09/eslint-v4.6.0-released
 [array-bracket-newline]: https://eslint.org/docs/rules/array-bracket-newline
 [array-element-newline]: https://eslint.org/docs/rules/array-element-newline
 [arrow-body-style]: https://eslint.org/docs/rules/arrow-body-style
 [arrow-special]: https://github.com/prettier/eslint-config-prettier/blob/2c842675e55b91aecaef6f997d234ebf2d220ffb/README.md#arrow-body-style-and-prefer-arrow-callback
 [curly]: https://eslint.org/docs/rules/curly
 [end-of-line]: https://prettier.io/docs/en/options.html#end-of-line
+[ESLint 4.0.0]: https://eslint.org/blog/2017/06/eslint-v4.0.0-released
+[ESLint 4.6.0]: https://eslint.org/blog/2017/09/eslint-v4.6.0-released
+[eslint-plugin-babel]: https://github.com/babel/eslint-plugin-babel
 [eslint-plugin-flowtype]: https://github.com/gajus/eslint-plugin-flowtype
 [eslint-plugin-prettier]: https://github.com/prettier/eslint-plugin-prettier
 [eslint-plugin-react]: https://github.com/yannickcr/eslint-plugin-react
@@ -244,6 +311,7 @@
 [eslint-plugin-unicorn]: https://github.com/sindresorhus/eslint-plugin-unicorn
 [eslint-plugin-vue]: https://github.com/vuejs/eslint-plugin-vue
 [flowtype/boolean-style]: https://github.com/gajus/eslint-plugin-flowtype#eslint-plugin-flowtype-rules-boolean-style
+[function-call-argument-newline]: https://eslint.org/docs/rules/function-call-argument-newline
 [function-paren-newline]: https://eslint.org/docs/rules/function-paren-newline
 [implicit-arrow-linebreak]: https://eslint.org/docs/rules/implicit-arrow-linebreak
 [indent-legacy]: https://eslint.org/docs/rules/indent-legacy
@@ -260,14 +328,16 @@
 [nonblock-statement-body-position]: https://eslint.org/docs/rules/nonblock-statement-body-position
 [one-var-declaration-per-line]: https://eslint.org/docs/rules/one-var-declaration-per-line
 [prefer-arrow-callback]: https://eslint.org/docs/rules/prefer-arrow-callback
+[prettier-self-closing]: https://prettier.io/blog/2019/06/06/1.18.0.html#stop-converting-empty-jsx-elements-to-self-closing-elements-6127-by-duailibe
 [prettier]: https://github.com/prettier
 [quotes-special]: https://github.com/prettier/eslint-config-prettier/blob/8d264cd0a7f06c12e2e05415e0282a4f8f21ebc9/README.md#quotes
 [quotes]: https://eslint.org/docs/rules/quotes
 [react/jsx-child-element-spacing]: https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/jsx-child-element-spacing.md
 [react/jsx-closing-tag-location]: https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/jsx-closing-tag-location.md
+[react/jsx-curly-newline]: https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/jsx-curly-newline.md
 [react/jsx-one-expression-per-line]: https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/jsx-one-expression-per-line.md
 [react/jsx-props-no-multi-spaces]: https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/jsx-props-no-multi-spaces.md
-[self-closing-comp]: https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/self-closing-comp.md
+[react/self-closing-comp]: https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/self-closing-comp.md
 [semi-style]: https://eslint.org/docs/rules/semi-style
 [switch-colon-spacing]: https://eslint.org/docs/rules/switch-colon-spacing
 [template-tag-spacing]: https://eslint.org/docs/rules/template-tag-spacing

package/README.md

@@ -2,7 +2,7 @@
 
 Turns off all rules that are unnecessary or might conflict with [Prettier].
 
-This lets you use you favorite shareable config without letting its stylistic
+This lets you use your favorite shareable config without letting its stylistic
 choices get in the way when using Prettier.
 
 Note that this config _only_ turns rules _off,_ so it only makes sense using
@@ -119,19 +119,27 @@ First, add a script for it to package.json:
 ```json
 {
   "scripts": {
-    "eslint-check": "eslint --print-config . | eslint-config-prettier-check"
+    "eslint-check": "eslint --print-config path/to/main.js | eslint-config-prettier-check"
   }
 }
 ```
 
-Then run `npm run eslint-check`.
+Then run `npm run eslint-check`. (Change `path/to/main.js` to a file that
+exists in your project.)
 
-If you use [multiple configuration files] or [overrides], you may need to run
-the above script several times with different `--print-config` arguments, such
-as:
+In theory you need to run `eslint --print-config file.js |
+eslint-config-prettier-check` for every single file in your project to be
+100% sure that there are no conflicting rules, because ESLint supports having
+different rules for different files. But usually you’ll have about the same
+rules for all files, so it is enough to run the command on one file (pick one
+that you won’t be moving). If you use [multiple configuration files] or
+[overrides], you can (but you probably don’t need to!) run the above script
+several times with different `--print-config` arguments, such as:
 
 ```
+eslint --print-config index.js | eslint-config-prettier-check
 eslint --print-config test/index.js | eslint-config-prettier-check
+eslint --print-config legacy/main.js | eslint-config-prettier-check
 ```
 
 Exit codes:
@@ -365,22 +373,14 @@ For example, the rule could warn about this line:
 var x = a => 1 ? 2 : 3;
 ```
 
-By default, ESLint suggests switching to an explicit return:
-
-```js
-var x = a => { return 1 ? 2 : 3; };
-```
-
-That causes no problems with Prettier.
-
-With `{allowParens: true}`, adding parentheses is also considered a valid way to
-avoid the arrow confusion:
+With `{allowParens: true}` (the default since ESLint 6.0.0), adding
+parentheses is considered a valid way to avoid the arrow confusion:
 
 ```js
 var x = a => (1 ? 2 : 3);
 ```
 
-While Prettier keeps thoses parentheses, it removes them if the line is long
+While Prettier keeps those parentheses, it removes them if the line is long
 enough to introduce a line break:
 
 ```js
@@ -388,6 +388,15 @@ EnterpriseCalculator.prototype.calculateImportantNumbers = inputNumber =>
   1 ? 2 : 3;
 ```
 
+With `{allowParens: false}`, ESLint instead suggests switching to an explicit
+return:
+
+```js
+var x = a => { return 1 ? 2 : 3; };
+```
+
+That causes no problems with Prettier.
+
 If you like this rule, it can be used just fine with Prettier as long as the
 `allowParens` option is off.
 
@@ -396,11 +405,18 @@ Example ESLint configuration:
 ```json
 {
   "rules": {
-    "no-confusing-arrow": "error"
+    "no-confusing-arrow": ["error", { "allowParens": false }]
   }
 }
 ```
 
+(Note: The CLI helper tool considers `{allowParens: true}` to be the default,
+which is the case since ESLint 6.0.0. The tool will produce a warning if you
+use the default even if you use an older version of ESLint. It doesn’t hurt
+to explicitly set `{allowParens: false}` even though it is technically
+redundant. This way you are prepared for a future ESLint upgrade and the CLI
+tool can be kept simple.)
+
 ### [no-mixed-operators]
 
 **This rule requires special attention when writing code.**
@@ -764,17 +780,18 @@ You can also supply a custom message if you want:
 
 eslint-config-prettier has been tested with:
 
-- ESLint 5.16.0
+- ESLint 6.2.0
+  - eslint-config-prettier 5.1.0 and older were tested with ESLint 5.x
   - eslint-config-prettier 2.10.0 and older were tested with ESLint 4.x
   - eslint-config-prettier 2.1.1 and older were tested with ESLint 3.x
-- prettier 1.17.1
-- @typescript-eslint/eslint-plugin 1.9.0
+- prettier 1.18.2
+- @typescript-eslint/eslint-plugin 2.0.0
 - eslint-plugin-babel 5.3.0
-- eslint-plugin-flowtype 3.9.0
-- eslint-plugin-react 7.13.0
+- eslint-plugin-flowtype 4.2.0
+- eslint-plugin-react 7.14.3
 - eslint-plugin-standard 4.0.0
-- eslint-plugin-unicorn 8.0.2
-- eslint-plugin-vue 5.2.2
+- eslint-plugin-unicorn 10.0.0
+- eslint-plugin-vue 5.2.3
 
 Have new rules been added since those versions? Have we missed any rules? Is
 there a plugin you would like to see exclusions for? Open an issue or a pull

package/bin/cli.js

@@ -17,7 +17,7 @@ if (module === require.main) {
         "This tool checks whether an ESLint configuration contains rules that are",
         "unnecessary or conflict with Prettier. It’s supposed to be run like this:",
         "",
-        "  eslint --print-config . | eslint-config-prettier-check",
+        "  eslint --print-config path/to/main.js | eslint-config-prettier-check",
         "  eslint --print-config test/index.js | eslint-config-prettier-check",
         "",
         "Exit codes:",

package/bin/validators.js

@@ -32,11 +32,11 @@ module.exports = {
 
   "no-confusing-arrow"(options) {
     if (options.length === 0) {
-      return true;
+      return false;
     }
 
     const firstOption = options[0];
-    return !(firstOption && firstOption.allowParens);
+    return firstOption ? firstOption.allowParens === false : false;
   },
 
   "vue/html-self-closing"(options) {

package/index.js

@@ -30,6 +30,7 @@ module.exports = {
     "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",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-config-prettier",
-  "version": "4.3.0",
+  "version": "6.1.0",
   "license": "MIT",
   "author": "Simon Lydell",
   "description": "Turns off all rules that are unnecessary or might conflict with Prettier.",
@@ -30,7 +30,7 @@
     "test:lint-verify-fail": "eslint \"test-lint/*.{js,ts,vue}\" --config .eslintrc.base.js --format json",
     "test:lint-rules": "eslint index.js --config test-config/.eslintrc.js --format json",
     "test:jest": "jest",
-    "test:cli-sanity": "eslint --print-config . | node ./bin/cli.js",
+    "test:cli-sanity": "eslint --print-config index.js | node ./bin/cli.js",
     "test:cli-sanity-warning": "eslint --print-config ./bin/cli.js | node ./bin/cli.js",
     "test": "npm run test:lint && npm run test:jest && npm run test:cli-sanity && npm run test:cli-sanity-warning"
   },
@@ -38,25 +38,25 @@
     "get-stdin": "^6.0.0"
   },
   "devDependencies": {
-    "@typescript-eslint/eslint-plugin": "1.9.0",
-    "@typescript-eslint/parser": "1.9.0",
-    "babel-eslint": "10.0.1",
+    "@typescript-eslint/eslint-plugin": "2.0.0",
+    "@typescript-eslint/parser": "2.0.0",
+    "babel-eslint": "10.0.2",
     "cross-spawn": "6.0.5",
     "doctoc": "1.4.0",
-    "eslint": "5.16.0",
+    "eslint": "6.2.0",
     "eslint-config-google": "0.13.0",
     "eslint-plugin-babel": "5.3.0",
-    "eslint-plugin-flowtype": "3.9.0",
+    "eslint-plugin-flowtype": "4.2.0",
     "eslint-plugin-prettier": "3.1.0",
-    "eslint-plugin-react": "7.13.0",
+    "eslint-plugin-react": "7.14.3",
     "eslint-plugin-standard": "4.0.0",
-    "eslint-plugin-unicorn": "8.0.2",
-    "eslint-plugin-vue": "5.2.2",
-    "jest": "24.8.0",
-    "prettier": "1.17.1",
+    "eslint-plugin-unicorn": "10.0.0",
+    "eslint-plugin-vue": "5.2.3",
+    "jest": "24.9.0",
+    "prettier": "1.18.2",
     "replace": "1.1.0",
-    "rimraf": "2.6.3",
-    "typescript": "3.4.5"
+    "rimraf": "3.0.0",
+    "typescript": "3.5.3"
   },
   "peerDependencies": {
     "eslint": ">=3.14.1"

package/react.js

@@ -5,6 +5,7 @@ module.exports = {
     "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",
@@ -15,7 +16,6 @@ module.exports = {
     "react/jsx-props-no-multi-spaces": "off",
     "react/jsx-space-before-closing": "off",
     "react/jsx-tag-spacing": "off",
-    "react/jsx-wrap-multilines": "off",
-    "react/self-closing-comp": "off"
+    "react/jsx-wrap-multilines": "off"
   }
 };