eslint-config-prettier 3.2.0 → 3.3.0

package/CHANGELOG.md

@@ -1,3 +1,8 @@
+### 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].
@@ -201,3 +206,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/README.md

@@ -27,6 +27,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)
@@ -126,7 +127,8 @@ Exit codes:
     "prettier/flowtype",
     "prettier/react",
     "prettier/standard",
-    "prettier/unicorn"
+    "prettier/unicorn",
+    "prettier/vue"
   ],
   "plugins": [
     "flowtype",
@@ -407,6 +409,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.**
@@ -577,6 +592,44 @@ Prettier:
 }
 ```
 
+### [vue/html-self-closing]
+
+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
@@ -715,6 +768,7 @@ 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
 [curly]: https://eslint.org/docs/rules/curly
 [eslint-plugin-flowtype]: https://github.com/gajus/eslint-plugin-flowtype
@@ -739,3 +793,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/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,6 +1,6 @@
 {
   "name": "eslint-config-prettier",
-  "version": "3.2.0",
+  "version": "3.3.0",
   "license": "MIT",
   "author": "Simon Lydell",
   "description": "Turns off all rules that are unnecessary or might conflict with Prettier.",
@@ -23,7 +23,7 @@
     "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-rules": "eslint index.js --config test-config/.eslintrc.js --format json",

package/vue.js

@@ -2,6 +2,8 @@
 
 module.exports = {
   rules: {
+    "vue/html-self-closing": 0,
+
     "vue/html-closing-bracket-newline": "off",
     "vue/html-closing-bracket-spacing": "off",
     "vue/html-end-tags": "off",