eslint-config-prettier 2.5.0 → 2.9.0

package/CHANGELOG.md

@@ -1,3 +1,24 @@
+### Version 2.9.0 (2017-11-26)
+
+- Added: The [implicit-arrow-linebreak] rule.
+
+### Version 2.8.0 (2017-11-19)
+
+- Added: The [react/jsx-one-expression-per-line] rule.
+
+### Version 2.7.0 (2017-11-01)
+
+- Added: The [lines-around-comment] rule (as a [special
+  rule][lines-around-comment-special]). Thanks to Maurice de Beijer
+  (@mauricedb)!
+- Added: The [no-unexpected-multiline] rule (as a [special
+  rule][no-unexpected-multiline-special]). Thanks to Suhas Karanth
+  (@sudo-suhas)!
+
+### Version 2.6.0 (2017-09-23)
+
+- Added: The [no-floating-decimal] rule.
+
 ### Version 2.5.0 (2017-09-16)
 
 - Added: Support for [eslint-plugin-standard]. Thanks to Christian Pekeler
@@ -116,24 +137,31 @@
 
 - Initial release.
 
-[ESLint 4.0.0]: http://eslint.org/blog/2017/06/eslint-v4.0.0-released
+[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]: http://eslint.org/docs/rules/array-bracket-newline
-[array-element-newline]: http://eslint.org/docs/rules/array-element-newline
+[array-bracket-newline]: https://eslint.org/docs/rules/array-bracket-newline
+[array-element-newline]: https://eslint.org/docs/rules/array-element-newline
 [curly]: https://eslint.org/docs/rules/curly
 [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
 [function-paren-newline]: https://eslint.org/docs/rules/function-paren-newline
-[indent-legacy]: http://eslint.org/docs/rules/indent-legacy
+[implicit-arrow-linebreak]: https://eslint.org/docs/rules/implicit-arrow-linebreak
+[indent-legacy]: https://eslint.org/docs/rules/indent-legacy
+[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
-[no-confusing-arrow]: http://eslint.org/docs/rules/no-confusing-arrow
+[no-confusing-arrow]: https://eslint.org/docs/rules/no-confusing-arrow
+[no-floating-decimal]: https://eslint.org/docs/rules/no-floating-decimal
 [no-tabs-special]: https://github.com/prettier/eslint-config-prettier/blob/dfa6e2b51f11a8001e9e7d38b78f03c7d75175ec/README.md#no-tabs
-[no-tabs]: http://eslint.org/docs/rules/no-tabs
-[nonblock-statement-body-position]: http://eslint.org/docs/rules/nonblock-statement-body-position
-[one-var-declaration-per-line]: http://eslint.org/docs/rules/one-var-declaration-per-line
+[no-tabs]: https://eslint.org/docs/rules/no-tabs
+[no-unexpected-multiline-special]: https://github.com/prettier/eslint-config-prettier/blob/5399175c37466747aae9d407021dffec2c169c8b/README.md#no-unexpected-multiline
+[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
 [prettier]: https://github.com/prettier
 [react/jsx-closing-tag-location]: https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/jsx-closing-tag-location.md
-[semi-style]: http://eslint.org/docs/rules/semi-style
-[switch-colon-spacing]: http://eslint.org/docs/rules/switch-colon-spacing
-[template-tag-spacing]: http://eslint.org/docs/rules/template-tag-spacing
+[react/jsx-one-expression-per-line]: https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/jsx-one-expression-per-line.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

@@ -146,10 +146,6 @@ if (cart.items && cart.items[0] && cart.items[0].quantity === 0)
   updateCart(cart);
 ```
 
-The [eslint-config-airbnb] config includes `curly` with the `"multi-line"`
-option turned on by default. Since that config is very popular, it makes sense
-for eslint-config-prettier to turn this rule off.
-
 If you like this rule, it can be used just fine with Prettier as long as you
 don’t use the `"multi-line"` or `"multi-or-nest"` option.
 
@@ -163,6 +159,65 @@ Example configuration:
 }
 ```
 
+### [lines-around-comment]
+
+**This rule can be used with certain options.**
+
+This rule requires empty lines before and/or after comments. Prettier preserves
+blank lines, with two exceptions:
+
+- Several blank lines in a row are collapsed into a single blank line. This is
+  fine.
+- Blank lines at the beginning and end of blocks, objects and arrays are always
+  removed. This may lead to conflicts.
+
+By default, ESLint requires a blank line above the comment is this case:
+
+```js
+if (result) {
+
+  /* comment */
+  return result;
+}
+```
+
+However, Prettier removes the blank line:
+
+```js
+if (result) {
+  /* comment */
+  return result;
+}
+```
+
+If you like this rule, it can be used just fine with Prettier as long as add
+extra configuration to allow comments at the start and end of blocks, objects
+and arrays.
+
+Example configuration:
+
+```json
+{
+  "rules": {
+    "lines-around-comment": [
+      "error",
+      {
+        "beforeBlockComment": true,
+        "afterBlockComment": true,
+        "beforeLineComment": true,
+        "afterLineComment": true,
+        "allowBlockStart": true,
+        "allowBlockEnd": true,
+        "allowObjectStart": true,
+        "allowObjectEnd": true,
+        "allowArrayStart": true,
+        "allowArrayEnd": true
+      }
+    ]
+  }
+}
+```
+
 ### [max-len]
 
 **This rule requires special attention when writing code.**
@@ -221,10 +276,6 @@ EnterpriseCalculator.prototype.calculateImportantNumbers = inputNumber =>
   1 ? 2 : 3;
 ```
 
-[eslint-config-airbnb] config includes `no-confusing-arrow` with the
-`allowParens` option turned on by default. Since that config is very popular, it
-makes sense for eslint-config-prettier to turn this rule off.
-
 If you like this rule, it can be used just fine with Prettier as long as the
 `allowParens` option is off.
 
@@ -288,6 +339,8 @@ Example configuration:
 
 ### [no-tabs]
 
+**This rule requires certain Prettier options.**
+
 This rule disallows the use of tab characters at all. It can be used just fine
 with Prettier as long as you don’t configure Prettier to indent using tabs.
 
@@ -301,6 +354,75 @@ Example configuration:
 }
 ```
 
+### [no-unexpected-multiline]
+
+**This rule requires special attention when writing code.**
+
+This rule disallows confusing multiline expressions where a newline looks like
+it is ending a statement, but is not.
+
+For example, the rule could warn about this:
+
+```js
+var hello = "world"
+[1, 2, 3].forEach(addNumber)
+```
+
+Prettier usually formats this in a way that makes it obvious that a semicolon
+was missing:
+
+```js
+var hello = "world"[(1, 2, 3)].forEach(addNumber);
+```
+
+However, there are cases where Prettier breaks things into several lines such
+that the `no-unexpected-multiline` conflicts.
+
+```js
+const value = text.trim().split("\n")[position].toLowerCase();
+```
+
+Prettier breaks it up into several lines, though, causing a conflict:
+
+```js
+const value = text
+  .trim()
+  .split("\n")
+  [position].toLowerCase();
+```
+
+If you like this rule, it can usually be used with Prettier without problems,
+but occasionally you might need to either temporarily disable the rule or
+refactor your code.
+
+```js
+const value = text
+  .trim()
+  .split("\n")
+  // eslint-disable-next-line no-unexpected-multiline
+  [position].toLowerCase();
+
+// Or:
+
+const lines = text.trim().split("\n");
+const value = lines[position].toLowerCase();
+```
+
+**Note:** If you _do_ enable this rule, you have to run ESLint and Prettier as
+two separate steps (and ESLint first) in order to get any value out of it.
+Otherwise Prettier might reformat your code in such a way that ESLint never gets
+a chance to report anything (as seen in the first example).
+
+Example configuration:
+
+```json
+{
+  "rules": {
+    "no-unexpected-multiline": "error"
+  }
+}
+```
+
 ### [quotes]
 
 **This rule requires certain options.**
@@ -319,14 +441,15 @@ Example configuration:
 }
 ```
 
+
 ## Contributing
 
 eslint-config-prettier has been tested with:
 
-- ESLint 4.7.0 (eslint-config-prettier 2.1.1 and older were tested with ESLint 3.x)
-- prettier 1.7.0
-- eslint-plugin-flowtype 2.35.1
-- eslint-plugin-react 7.3.0
+- ESLint 4.12.0 (eslint-config-prettier 2.1.1 and older were tested with ESLint 3.x)
+- prettier 1.8.2
+- eslint-plugin-flowtype 2.39.1
+- eslint-plugin-react 7.5.1
 - eslint-plugin-standard 3.0.1
 
 Have new rules been added since those versions? Have we missed any rules? Is
@@ -391,17 +514,18 @@ several other npm scripts:
 
 [MIT](LICENSE).
 
-[curly]: http://eslint.org/docs/rules/curly
-[eslint-config-airbnb]: https://www.npmjs.com/package/eslint-config-airbnb
+[Prettier]: https://github.com/prettier/prettier
+[curly]: https://eslint.org/docs/rules/curly
 [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
-[max-len]: http://eslint.org/docs/rules/max-len
-[no-confusing-arrow]: http://eslint.org/docs/rules/no-confusing-arrow
-[no-mixed-operators]: http://eslint.org/docs/rules/no-mixed-operators
-[no-tabs]: http://eslint.org/docs/rules/no-tabs
-[Prettier]: https://github.com/prettier/prettier
-[quotes]: http://eslint.org/docs/rules/quotes
+[lines-around-comment]: https://eslint.org/docs/rules/lines-around-comment
+[max-len]: https://eslint.org/docs/rules/max-len
+[no-confusing-arrow]: https://eslint.org/docs/rules/no-confusing-arrow
+[no-mixed-operators]: https://eslint.org/docs/rules/no-mixed-operators
+[no-tabs]: https://eslint.org/docs/rules/no-tabs
+[no-unexpected-multiline]: https://eslint.org/docs/rules/no-unexpected-multiline
+[quotes]: https://eslint.org/docs/rules/quotes
 [travis-badge]: https://travis-ci.org/prettier/eslint-config-prettier.svg?branch=master
 [travis]: https://travis-ci.org/prettier/eslint-config-prettier

package/bin/cli.js

@@ -68,7 +68,9 @@ function processString(string) {
     )
   ) {
     return {
-      stderr: `Expected a \`{"rules: {...}"}\` JSON object, but got:\n${string}`,
+      stderr: `Expected a \`{"rules: {...}"}\` JSON object, but got:\n${
+        string
+      }`,
       code: 1
     };
   }

package/bin/validators.js

@@ -10,6 +10,23 @@ module.exports = {
     return firstOption !== "multi-line" && firstOption !== "multi-or-nest";
   },
 
+  "lines-around-comment"(options) {
+    if (options.length < 1) {
+      return false;
+    }
+
+    const firstOption = options[0];
+    return Boolean(
+      firstOption &&
+        firstOption.allowBlockStart &&
+        firstOption.allowBlockEnd &&
+        firstOption.allowObjectStart &&
+        firstOption.allowObjectEnd &&
+        firstOption.allowArrayStart &&
+        firstOption.allowArrayEnd
+    );
+  },
+
   "no-confusing-arrow"(options) {
     if (options.length < 1) {
       return true;

package/index.js

@@ -6,10 +6,12 @@ module.exports = {
     // information. (These are marked with `0` instead of `"off"` so that a
     // script can distinguish them.)
     curly: 0,
+    "lines-around-comment": 0,
     "max-len": 0,
     "no-confusing-arrow": 0,
     "no-mixed-operators": 0,
     "no-tabs": 0,
+    "no-unexpected-multiline": 0,
     quotes: 0,
     // The rest are rules that you never need to enable when using Prettier.
     "array-bracket-newline": "off",
@@ -29,6 +31,7 @@ module.exports = {
     "function-paren-newline": "off",
     "generator-star": "off",
     "generator-star-spacing": "off",
+    "implicit-arrow-linebreak": "off",
     indent: "off",
     "indent-legacy": "off",
     "jsx-quotes": "off",
@@ -41,6 +44,7 @@ module.exports = {
     "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",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-config-prettier",
-  "version": "2.5.0",
+  "version": "2.9.0",
   "license": "MIT",
   "author": "Simon Lydell",
   "description": "Turns off all rules that are unnecessary or might conflict with Prettier.",
@@ -25,23 +25,24 @@
     "test:lint-verify-fail": "eslint test-lint/ --config .eslintrc.base.js --format json",
     "test:lint-rules": "eslint index.js --config test-config/.eslintrc.js --format json",
     "test:ava": "ava",
-    "test:cli-sanity": "eslint --print-config .eslintrc.js | ./bin/cli.js",
+    "test:cli-sanity": "eslint --print-config .eslintrc.js | node ./bin/cli.js",
     "test": "npm run test:lint && npm run test:ava && npm run test:cli-sanity"
   },
   "dependencies": {
     "get-stdin": "^5.0.1"
   },
   "devDependencies": {
-    "ava": "^0.22.0",
+    "ava": "^0.23.0",
     "babel-eslint": "^7.2.3",
+    "cross-spawn": "^5.1.0",
     "dedent": "^0.7.0",
-    "eslint": "^4.7.0",
+    "eslint": "^4.12.0",
     "eslint-config-google": "^0.9.1",
-    "eslint-plugin-flowtype": "^2.35.1",
-    "eslint-plugin-prettier": "^2.2.0",
-    "eslint-plugin-react": "^7.3.0",
+    "eslint-plugin-flowtype": "^2.39.1",
+    "eslint-plugin-prettier": "^2.3.1",
+    "eslint-plugin-react": "^7.5.1",
     "eslint-plugin-standard": "^3.0.1",
-    "prettier": "^1.7.0",
+    "prettier": "^1.8.2",
     "rimraf": "^2.6.2"
   },
   "peerDependencies": {

package/react.js

@@ -10,6 +10,7 @@ module.exports = {
     "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-space-before-closing": "off",
     "react/jsx-tag-spacing": "off",
     "react/jsx-wrap-multilines": "off"