eslint-config-prettier 3.4.0 → 4.1.0

package/@typescript-eslint.js

@@ -0,0 +1,9 @@
+"use strict";
+
+module.exports = {
+  rules: {
+    "@typescript-eslint/indent": "off",
+    "@typescript-eslint/member-delimiter-style": "off",
+    "@typescript-eslint/type-annotation-spacing": "off"
+  }
+};

package/CHANGELOG.md

@@ -1,3 +1,36 @@
+### 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)!
+
+### Version 4.0.0 (2019-01-26)
+
+- Breaking change: Support for [eslint-plugin-typescript] has been removed and
+  replaced with support for its successor [@typescript-eslint/eslint-plugin].
+  Thanks to TANIGUCHI Masaya (@ta2gch) and everyone else who helped with this!
+- Changed: [arrow-body-style] and [prefer-arrow-callback] are now marked as
+  [special rules][arrow-special], since they might cause problems if using
+  [eslint-plugin-prettier] and `--fix`. They are turned off by default, and the
+  CLI helper tool will _warn_ about them (but not error if you do enable them).
+  This won’t break your linting checks, but do note that these rules will be
+  disabled unless you explicitly enable them again, and that you might see new
+  warnings when running the CLI helper tool.
+
+### Version 3.6.0 (2019-01-19)
+
+- Added: Support for [eslint-plugin-babel]. Thanks to Matija Marohnić
+  (@silvenon)!
+
+### Version 3.5.0 (2019-01-16)
+
+- Fixed: The eslint-plugin-vue change from 3.4.0 has been reverted. That change
+  requires eslint-plugin-vue@5, while many use eslint-plugin-vue@4. In other
+  words, it was an accidental breaking change. Also, after thinking about it
+  some more, it makes sense to have a Prettier-specific list of rules, rather
+  than using the `vue/no-layout-rules` list, since there can be layout rules
+  that don’t conflict with but rather complement Prettier.
+- Added: New eslint-plugin-vue rules coming in the next version after 5.1.0.
+
 ### Version 3.4.0 (2019-01-13)
 
 - Added: Support for [eslint-plugin-typescript]. Thanks to Jed Fox (@j-f1)!
@@ -179,12 +212,17 @@
 
 - Initial release.
 
+[@typescript-eslint/eslint-plugin]: https://github.com/typescript-eslint/typescript-eslint
 [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-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
 [eslint-plugin-standard]: https://github.com/xjamundx/eslint-plugin-standard
 [eslint-plugin-typescript]: https://github.com/bradzacher/eslint-plugin-typescript
@@ -194,6 +232,7 @@
 [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
+[linebreak-style]: https://eslint.org/docs/rules/linebreak-style
 [lines-around-comment-special]: https://github.com/prettier/eslint-config-prettier/blob/5399175c37466747aae9d407021dffec2c169c8b/README.md#lines-around-comment
 [lines-around-comment]: https://eslint.org/docs/rules/lines-around-comment
 [no-confusing-arrow-special]: https://github.com/prettier/eslint-config-prettier/blob/08ac5bcc25c9cdc71864b4a1e4191e7d28dd2bc2/README.md#no-confusing-arrow
@@ -205,15 +244,17 @@
 [no-unexpected-multiline]: https://eslint.org/docs/rules/no-unexpected-multiline
 [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]: https://github.com/prettier
-[quotes]: https://eslint.org/docs/rules/quotes
 [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-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
 [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
-[vue/html-self-closing]: https://github.com/vuejs/eslint-plugin-vue/blob/master/docs/rules/html-self-closing.md
 [vue/html-self-closing-special]: https://github.com/prettier/eslint-config-prettier/blob/d5e7af986221df5faedc12893d8dc3150a808693/README.md#vuehtml-self-closing
+[vue/html-self-closing]: https://github.com/vuejs/eslint-plugin-vue/blob/master/docs/rules/html-self-closing.md

package/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2017 Simon Lydell
+Copyright (c) 2017, 2018, 2019 Simon Lydell and contributors
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -5,6 +5,9 @@ Turns off all rules that are unnecessary or might conflict with [Prettier].
 This lets you use you 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
+it together with some other config.
+
 ## Contents
 
 <!-- START doctoc generated TOC please keep comment here to allow auto update -->
@@ -15,6 +18,7 @@ choices get in the way when using Prettier.
 - [CLI helper tool](#cli-helper-tool)
 - [Example configuration](#example-configuration)
 - [Special rules](#special-rules)
+  - [arrow-body-style and prefer-arrow-callback](#arrow-body-style-and-prefer-arrow-callback)
   - [curly](#curly)
   - [lines-around-comment](#lines-around-comment)
   - [max-len](#max-len)
@@ -43,7 +47,7 @@ Follow the instructions over there. This is optional, though.
 Install eslint-config-prettier:
 
 ```
-$ npm install --save-dev eslint-config-prettier
+npm install --save-dev eslint-config-prettier
 ```
 
 Then, add eslint-config-prettier to the "extends" array in your `.eslintrc.*`
@@ -53,6 +57,7 @@ configs.
 ```json
 {
   "extends": [
+    "some-other-config-you-use",
     "prettier"
   ]
 }
@@ -60,10 +65,11 @@ configs.
 
 A few ESLint plugins are supported as well:
 
+- [@typescript-eslint/eslint-plugin]
+- [eslint-plugin-babel]
 - [eslint-plugin-flowtype]
 - [eslint-plugin-react]
 - [eslint-plugin-standard]
-- [eslint-plugin-typescript]
 - [eslint-plugin-unicorn]
 - [eslint-plugin-vue]
 
@@ -72,17 +78,36 @@ Add extra exclusions for the plugins you use like so:
 ```json
 {
   "extends": [
+    "some-other-config-you-use",
     "prettier",
+    "prettier/@typescript-eslint",
+    "prettier/babel",
     "prettier/flowtype",
     "prettier/react",
     "prettier/standard",
-    "prettier/typescript",
     "prettier/unicorn",
     "prettier/vue"
   ]
 }
 ```
 
+If you extend a config which uses a plugin, it is recommended to add
+`"prettier/that-plugin"` (if available). For example, [eslint-config-airbnb]
+enables [eslint-plugin-react] rules, so `"prettier/react"` is needed:
+
+```json
+{
+  "extends": [
+    "airbnb",
+    "prettier",
+    "prettier/react"
+  ]
+}
+```
+
+If you’re unsure which plugins are used, you can usually find them in your
+`package.json`.
+
 ## CLI helper tool
 
 eslint-config-prettier also ships with a little CLI tool to help you check if
@@ -121,25 +146,27 @@ Exit codes:
 {
   "extends": [
     "standard",
+    "plugin:@typescript-eslint/recommended",
     "plugin:flowtype/recommended",
     "plugin:react/recommended",
-    "plugin:typescript/recommended",
     "plugin:unicorn/recommended",
     "plugin:vue/recommended",
     "prettier",
+    "prettier/@typescript-eslint",
+    "prettier/babel",
     "prettier/flowtype",
     "prettier/react",
     "prettier/standard",
-    "prettier/typescript",
     "prettier/unicorn",
     "prettier/vue"
   ],
   "plugins": [
+    "@typescript-eslint",
+    "babel",
     "flowtype",
-    "react",
     "prettier",
+    "react",
     "standard",
-    "typescript",
     "unicorn",
     "vue"
   ],
@@ -168,10 +195,44 @@ enabled in some cases.
 - Some require special attention when writing code. The CLI helper tool warns
   you if any of those rules are enabled, but can’t tell if anything is
   problematic.
+- Some can cause problems if using [eslint-plugin-prettier] and `--fix`.
 
 For maximum ease of use, the special rules are disabled by default. If you want
 them, you need to explicitly specify them in your ESLint config.
 
+### [arrow-body-style] and [prefer-arrow-callback]
+
+**These rules might cause problems if using [eslint-plugin-prettier] and `--fix`.**
+
+If you use any of these rules together with the `prettier/prettier` rule from
+[eslint-plugin-prettier], you can in some cases end up with invalid code due to
+a bug in ESLint’s autofix.
+
+These rules are safe to use if:
+
+- You don’t use [eslint-plugin-prettier]. In other words, you run `eslint --fix`
+  and `prettier --write` as separate steps.
+- You _do_ use [eslint-plugin-prettier], but don’t use `--fix`. (But then,
+  what’s the point?)
+
+You _can_ still use these rules together with [eslint-plugin-prettier] if you
+want, because the bug does not occur _all the time._ But if you do, you need to
+keep in mind that you might end up with invalid code, where you manually have to
+insert a missing closing parenthesis to get going again.
+
+If you’re fixing large of amounts of previously unformatted code, consider
+temporarily disabling the `prettier/prettier` rule and running `eslint --fix`
+and `prettier --write` separately.
+
+See these issues for more information:
+
+- [eslint-config-prettier#31]
+- [eslint-config-prettier#71]
+- [eslint-plugin-prettier#65]
+
+When the autofix bug in ESLint has been fixed, the special case for these rules
+can be removed.
+
 ### [curly]
 
 **This rule requires certain options.**
@@ -498,6 +559,8 @@ Example configuration:
 
 ### [quotes]
 
+(The following applies to [babel/quotes] as well.)
+
 **This rule requires certain options and certain Prettier options.**
 
 Usually, you don’t need this rule at all. But there are two cases where it could
@@ -701,15 +764,16 @@ You can also supply a custom message if you want:
 
 eslint-config-prettier has been tested with:
 
-- ESLint 5.12.0
+- ESLint 5.14.1
   - 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.15.3
-- eslint-plugin-flowtype 3.2.1
-- eslint-plugin-react 7.12.3
+- prettier 1.16.4
+- @typescript-eslint/eslint-plugin 1.4.2
+- eslint-plugin-babel 5.3.0
+- eslint-plugin-flowtype 3.4.2
+- eslint-plugin-react 7.12.4
 - eslint-plugin-standard 4.0.0
-- eslint-plugin-typescript 1.0.0-rc.1
-- eslint-plugin-unicorn 6.0.1
+- eslint-plugin-unicorn 7.1.0
 - eslint-plugin-vue 5.1.0
 
 Have new rules been added since those versions? Have we missed any rules? Is
@@ -738,7 +802,7 @@ Then, create `test-lint/foobar.js`:
 "use strict";
 
 // Prettier does not want spaces before the parentheses, but
-// some-foobar-config wants one.
+// `plugin:foobar/recommended` wants one.
 console.log();
 ```
 
@@ -776,14 +840,21 @@ several other npm scripts:
 
 [MIT](LICENSE).
 
+[@typescript-eslint/eslint-plugin]: https://github.com/typescript-eslint/typescript-eslint
 [ESlint 5.7.0]: https://eslint.org/blog/2018/10/eslint-v5.7.0-released
 [Prettier]: https://github.com/prettier/prettier
+[arrow-body-style]: https://eslint.org/docs/rules/arrow-body-style
+[babel/quotes]: https://github.com/babel/eslint-plugin-babel#rules
 [curly]: https://eslint.org/docs/rules/curly
+[eslint-config-airbnb]: https://www.npmjs.com/package/eslint-config-airbnb
+[eslint-config-prettier#31]: https://github.com/prettier/eslint-config-prettier/issues/31
+[eslint-config-prettier#71]: https://github.com/prettier/eslint-config-prettier/issues/71
+[eslint-plugin-babel]: https://github.com/babel/eslint-plugin-babel
 [eslint-plugin-flowtype]: https://github.com/gajus/eslint-plugin-flowtype
+[eslint-plugin-prettier#65]: https://github.com/prettier/eslint-plugin-prettier/issues/65
 [eslint-plugin-prettier]: https://github.com/prettier/eslint-plugin-prettier
 [eslint-plugin-react]: https://github.com/yannickcr/eslint-plugin-react
 [eslint-plugin-standard]: https://github.com/xjamundx/eslint-plugin-standard
-[eslint-plugin-typescript]: https://github.com/bradzacher/eslint-plugin-typescript
 [eslint-plugin-unicorn]: https://github.com/sindresorhus/eslint-plugin-unicorn
 [eslint-plugin-vue]: https://github.com/vuejs/eslint-plugin-vue
 [lines-around-comment]: https://eslint.org/docs/rules/lines-around-comment
@@ -797,6 +868,7 @@ several other npm scripts:
 [no-tabs]: https://eslint.org/docs/rules/no-tabs
 [no-unexpected-multiline]: https://eslint.org/docs/rules/no-unexpected-multiline
 [overrides]: https://eslint.org/docs/user-guide/configuring#configuration-based-on-glob-patterns
+[prefer-arrow-callback]: https://eslint.org/docs/rules/prefer-arrow-callback
 [quotes]: https://eslint.org/docs/rules/quotes
 [singleQuote]: https://prettier.io/docs/en/options.html#quotes
 [string formatting rules]: https://prettier.io/docs/en/rationale.html#strings

package/babel.js

@@ -0,0 +1,10 @@
+"use strict";
+
+module.exports = {
+  rules: {
+    "babel/quotes": 0,
+
+    "babel/object-curly-spacing": "off",
+    "babel/semi": "off"
+  }
+};

package/index.js

@@ -5,6 +5,7 @@ module.exports = {
     // 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,
@@ -12,6 +13,7 @@ module.exports = {
     "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",
@@ -37,6 +39,7 @@ module.exports = {
     "jsx-quotes": "off",
     "key-spacing": "off",
     "keyword-spacing": "off",
+    "linebreak-style": "off",
     "multiline-ternary": "off",
     "newline-per-chained-call": "off",
     "new-parens": "off",

package/package.json

@@ -1,17 +1,18 @@
 {
   "name": "eslint-config-prettier",
-  "version": "3.4.0",
+  "version": "4.1.0",
   "license": "MIT",
   "author": "Simon Lydell",
   "description": "Turns off all rules that are unnecessary or might conflict with Prettier.",
   "repository": "prettier/eslint-config-prettier",
   "files": [
     "bin/",
+    "@typescript-eslint.js",
+    "babel.js",
     "flowtype.js",
     "index.js",
     "react.js",
     "standard.js",
-    "typescript.js",
     "unicorn.js",
     "vue.js"
   ],
@@ -24,7 +25,7 @@
     "prettier"
   ],
   "scripts": {
-    "doctoc": "doctoc README.md && replace \"\\[(\\[[\\w/-]+\\])\\]\" \"\\$1\" README.md",
+    "doctoc": "doctoc README.md && replace \"\\[\\[([\\w/-]+)\\](?:([^\\[\\]]+)\\[([\\w/-]+)\\])?\\]\" \"[\\$1\\$2\\$3]\" README.md",
     "test:lint": "eslint .",
     "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",
@@ -37,23 +38,25 @@
     "get-stdin": "^6.0.0"
   },
   "devDependencies": {
+    "@typescript-eslint/eslint-plugin": "1.4.2",
+    "@typescript-eslint/parser": "1.4.2",
     "babel-eslint": "10.0.1",
     "cross-spawn": "6.0.5",
     "doctoc": "1.4.0",
-    "eslint": "5.12.0",
-    "eslint-config-google": "0.11.0",
-    "eslint-plugin-flowtype": "3.2.1",
+    "eslint": "5.14.1",
+    "eslint-config-google": "0.12.0",
+    "eslint-plugin-babel": "5.3.0",
+    "eslint-plugin-flowtype": "3.4.2",
     "eslint-plugin-prettier": "3.0.1",
-    "eslint-plugin-react": "7.12.3",
+    "eslint-plugin-react": "7.12.4",
     "eslint-plugin-standard": "4.0.0",
-    "eslint-plugin-typescript": "1.0.0-rc.1",
-    "eslint-plugin-unicorn": "6.0.1",
-    "eslint-plugin-vue": "5.1.0",
-    "jest": "23.6.0",
-    "prettier": "1.15.3",
+    "eslint-plugin-unicorn": "7.1.0",
+    "eslint-plugin-vue": "github:vuejs/eslint-plugin-vue#9c49dcc8ff792ec6798037bd6b7f4ac3d26fdf68",
+    "jest": "24.1.0",
+    "prettier": "1.16.4",
     "replace": "1.0.1",
     "rimraf": "2.6.3",
-    "typescript": "^3.2.2"
+    "typescript": "3.3.3333"
   },
   "peerDependencies": {
     "eslint": ">=3.14.1"

package/react.js

@@ -15,6 +15,7 @@ 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/jsx-wrap-multilines": "off",
+    "react/self-closing-comp": "off"
   }
 };

package/vue.js

@@ -1,8 +1,25 @@
 "use strict";
 
 module.exports = {
-  extends: "plugin:vue/no-layout-rules",
   rules: {
-    "vue/html-self-closing": 0
+    "vue/html-self-closing": 0,
+
+    "vue/array-bracket-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/max-attributes-per-line": "off",
+    "vue/multiline-html-element-content-newline": "off",
+    "vue/mustache-interpolation-spacing": "off",
+    "vue/no-multi-spaces": "off",
+    "vue/no-spaces-around-equal-signs-in-attribute": "off",
+    "vue/object-curly-spacing": "off",
+    "vue/script-indent": "off",
+    "vue/singleline-html-element-content-newline": "off",
+    "vue/space-infix-ops": "off",
+    "vue/space-unary-ops": "off"
   }
 };

package/typescript.js

@@ -1,9 +0,0 @@
-"use strict";
-
-module.exports = {
-  rules: {
-    "typescript/indent": "off",
-    "typescript/member-delimiter-style": "off",
-    "typescript/type-annotation-spacing": "off"
-  }
-};