eslint-config-prettier 3.2.0 → 3.6.0

package/CHANGELOG.md

@@ -1,3 +1,31 @@
+### 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)!
+- Improved: The eslint-plugin-vue integration is now using the
+  `vue/no-layout-rules` config behind the scenes, so it should automatically
+  stay up-to-date when new eslint-plugin-vue versions are released. Thanks to
+  Michał Sajnóg (@michalsnik)!
+
+### Version 3.3.0 (2018-11-11)
+
+- Added: The [vue/html-self-closing] rule (as a [special
+  rule][vue/html-self-closing-special]). Thanks to Yamagishi Kazutoshi (@ykzts)!
+
 ### Version 3.2.0 (2018-11-10)
 
 - Added: Support for [eslint-plugin-vue].
@@ -174,6 +202,7 @@
 [eslint-plugin-flowtype]: https://github.com/gajus/eslint-plugin-flowtype
 [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
 [flowtype/boolean-style]: https://github.com/gajus/eslint-plugin-flowtype#eslint-plugin-flowtype-rules-boolean-style
@@ -201,3 +230,5 @@
 [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

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 -->
@@ -27,6 +30,7 @@ choices get in the way when using Prettier.
     - [Forbid unnecessary backticks](#forbid-unnecessary-backticks)
       - [Example _double_ quote configuration](#example-_double_-quote-configuration)
       - [Example _single_ quote configuration](#example-_single_-quote-configuration)
+  - [vue/html-self-closing](#vuehtml-self-closing)
 - [Other rules worth mentioning](#other-rules-worth-mentioning)
   - [no-sequences](#no-sequences)
 - [Contributing](#contributing)
@@ -42,7 +46,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.*`
@@ -52,6 +56,7 @@ configs.
 ```json
 {
   "extends": [
+    "some-other-config-you-use",
     "prettier"
   ]
 }
@@ -59,9 +64,11 @@ configs.
 
 A few ESLint plugins are supported as well:
 
+- [eslint-plugin-babel]
 - [eslint-plugin-flowtype]
 - [eslint-plugin-react]
 - [eslint-plugin-standard]
+- [eslint-plugin-typescript]
 - [eslint-plugin-unicorn]
 - [eslint-plugin-vue]
 
@@ -70,10 +77,13 @@ Add extra exclusions for the plugins you use like so:
 ```json
 {
   "extends": [
+    "some-other-config-you-use",
     "prettier",
+    "prettier/babel",
     "prettier/flowtype",
     "prettier/react",
     "prettier/standard",
+    "prettier/typescript",
     "prettier/unicorn",
     "prettier/vue"
   ]
@@ -120,19 +130,25 @@ Exit codes:
     "standard",
     "plugin:flowtype/recommended",
     "plugin:react/recommended",
+    "plugin:typescript/recommended",
     "plugin:unicorn/recommended",
     "plugin:vue/recommended",
     "prettier",
+    "prettier/babel",
     "prettier/flowtype",
     "prettier/react",
     "prettier/standard",
-    "prettier/unicorn"
+    "prettier/typescript",
+    "prettier/unicorn",
+    "prettier/vue"
   ],
   "plugins": [
+    "babel",
     "flowtype",
     "react",
     "prettier",
     "standard",
+    "typescript",
     "unicorn",
     "vue"
   ],
@@ -407,6 +423,19 @@ required):
 }
 ```
 
+**Note:** Since [ESlint 5.7.0] this rule can be configured to work regardless of
+your Prettier configuration:
+
+```json
+{
+  "rules": {
+    "no-tabs": ["error", {"allowIndentationTabs": true}]
+  }
+}
+```
+
+A future version of eslint-config-prettier might check for that automatically.
+
 ### [no-unexpected-multiline]
 
 **This rule requires special attention when writing code.**
@@ -478,6 +507,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
@@ -577,6 +608,46 @@ Prettier:
 }
 ```
 
+### [vue/html-self-closing]
+
+**This rule requires certain options.**
+
+This rule enforces whether elements should be self-closing or not.
+
+Prettier generally preserves the way you wrote your elements:
+
+```vue
+<div />
+<div></div>
+<MyComponent />
+<MyComponent></MyComponent>
+<svg><path d="" /></svg>
+<svg><path d=""></path></svg>
+```
+
+But for known _void_ HTML elements, Prettier always uses the self-closing style.
+For example, `<img>` is turned into `<img />`.
+
+If you like this rule, it can be used just fine with Prettier as long as you
+set `html.void` to `"any"`.
+
+Example ESLint configuration:
+
+```json
+{
+  "rules": {
+    "vue/html-self-closing": [
+      "error",
+      {
+        "html": {
+          "void": "any"
+        }
+      }
+    ]
+  }
+}
+```
+
 ## Other rules worth mentioning
 
 These rules don’t conflict with Prettier, but have some gotchas when used with
@@ -641,15 +712,17 @@ You can also supply a custom message if you want:
 
 eslint-config-prettier has been tested with:
 
-- ESLint 5.9.0
+- ESLint 5.12.0
   - 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.2
-- eslint-plugin-flowtype 3.2.0
-- eslint-plugin-react 7.11.1
+- prettier 1.15.3
+- eslint-plugin-babel 5.3.0
+- eslint-plugin-flowtype 3.2.1
+- eslint-plugin-react 7.12.4
 - eslint-plugin-standard 4.0.0
-- eslint-plugin-unicorn 6.0.1
-- eslint-plugin-vue 5.0.0-beta.3
+- eslint-plugin-typescript 1.0.0-rc.1
+- eslint-plugin-unicorn 7.0.0
+- eslint-plugin-vue 5.1.0
 
 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
@@ -677,7 +750,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();
 ```
 
@@ -715,12 +788,16 @@ several other npm scripts:
 
 [MIT](LICENSE).
 
+[ESlint 5.7.0]: https://eslint.org/blog/2018/10/eslint-v5.7.0-released
 [Prettier]: https://github.com/prettier/prettier
+[babel/quotes]: https://github.com/babel/eslint-plugin-babel#rules
 [curly]: https://eslint.org/docs/rules/curly
+[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
 [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
@@ -739,3 +816,4 @@ several other npm scripts:
 [string formatting rules]: https://prettier.io/docs/en/rationale.html#strings
 [travis-badge]: https://travis-ci.org/prettier/eslint-config-prettier.svg?branch=master
 [travis]: https://travis-ci.org/prettier/eslint-config-prettier
+[vue/html-self-closing]: https://github.com/vuejs/eslint-plugin-vue/blob/master/docs/rules/html-self-closing.md

package/babel.js

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

package/bin/validators.js

@@ -1,5 +1,8 @@
 "use strict";
 
+// These validator functions answer the question “Is the config valid?” – return
+// `false` if the options DO conflict with Prettier, and `true` if they don’t.
+
 module.exports = {
   curly(options) {
     if (options.length === 0) {
@@ -34,5 +37,18 @@ module.exports = {
 
     const firstOption = options[0];
     return !(firstOption && firstOption.allowParens);
+  },
+
+  "vue/html-self-closing"(options) {
+    if (options.length === 0) {
+      return false;
+    }
+
+    const firstOption = options[0];
+    return Boolean(
+      firstOption && (firstOption.html && firstOption.html.void === "any")
+      // Enable when Prettier supports SVG: https://github.com/prettier/prettier/issues/5322
+      // && firstOption.svg === "any"
+    );
   }
 };

package/package.json

@@ -1,16 +1,18 @@
 {
   "name": "eslint-config-prettier",
-  "version": "3.2.0",
+  "version": "3.6.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/",
+    "babel.js",
     "flowtype.js",
     "index.js",
     "react.js",
     "standard.js",
+    "typescript.js",
     "unicorn.js",
     "vue.js"
   ],
@@ -23,9 +25,9 @@
     "prettier"
   ],
   "scripts": {
-    "doctoc": "doctoc README.md && replace \"\\[(\\[[\\w-]+\\])\\]\" \"\\$1\" README.md",
+    "doctoc": "doctoc README.md && replace \"\\[(\\[[\\w/-]+\\])\\]\" \"\\$1\" README.md",
     "test:lint": "eslint .",
-    "test:lint-verify-fail": "eslint \"test-lint/*.{js,vue}\" --config .eslintrc.base.js --format json",
+    "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",
@@ -38,19 +40,22 @@
   "devDependencies": {
     "babel-eslint": "10.0.1",
     "cross-spawn": "6.0.5",
-    "doctoc": "1.3.1",
-    "eslint": "5.9.0",
+    "doctoc": "1.4.0",
+    "eslint": "5.12.0",
     "eslint-config-google": "0.11.0",
-    "eslint-plugin-flowtype": "3.2.0",
-    "eslint-plugin-prettier": "3.0.0",
-    "eslint-plugin-react": "7.11.1",
+    "eslint-plugin-babel": "5.3.0",
+    "eslint-plugin-flowtype": "3.2.1",
+    "eslint-plugin-prettier": "3.0.1",
+    "eslint-plugin-react": "7.12.4",
     "eslint-plugin-standard": "4.0.0",
-    "eslint-plugin-unicorn": "6.0.1",
-    "eslint-plugin-vue": "5.0.0-beta.3",
+    "eslint-plugin-typescript": "1.0.0-rc.1",
+    "eslint-plugin-unicorn": "7.0.0",
+    "eslint-plugin-vue": "github:vuejs/eslint-plugin-vue#9c49dcc8ff792ec6798037bd6b7f4ac3d26fdf68",
     "jest": "23.6.0",
-    "prettier": "1.15.2",
-    "replace": "1.0.0",
-    "rimraf": "2.6.2"
+    "prettier": "1.15.3",
+    "replace": "1.0.1",
+    "rimraf": "2.6.3",
+    "typescript": "3.2.4"
   },
   "peerDependencies": {
     "eslint": ">=3.14.1"

package/typescript.js

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

package/vue.js

@@ -2,17 +2,24 @@
 
 module.exports = {
   rules: {
+    "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/singleline-html-element-content-newline": "off",
+    "vue/space-infix-ops": "off",
+    "vue/space-unary-ops": "off"
   }
 };