feat: Replace stylistic rules with prettier

Author: evocateur

package-lock.json

@@ -62,11 +62,13 @@
     "eslint-plugin-import": "^2.10.0",
     "eslint-plugin-jest": "^21.15.0",
     "eslint-plugin-jsx-a11y": "^6.0.3",
+    "eslint-plugin-prettier": "^2.6.0",
     "eslint-plugin-react": "^7.7.0",
     "jest": "^22.4.3",
     "lerna": "^3.0.0-beta.14",
     "markdownlint-cli": "^0.8.1",
     "npm-run-all": "^4.1.2",
+    "prettier": "^1.11.1",
     "react": "^16.3.0"
   },
   "dependencies": {

package.json

@@ -5,3 +5,5 @@
     comma-dangle: off
     # ditto for indent
     indent: [error, 2]
+    # far too many disagreements to be useful
+    prettier/prettier: off

packages/eslint-config-zillow-base/.eslintrc.yaml

@@ -24,7 +24,15 @@ For example, in a JSON `.eslintrc`:
 
 ### `"extends": "zillow-base"`
 
-Our default export contains all of our ESLint rules, including ECMAScript 6+.
+Our default export contains all of our ESLint rules, including ECMAScript 6+ and Prettier.
+
+### `prettier` Editor Plugin Integration
+
+Unfortunately, super-useful editor plugins like `prettier-atom` and `prettier-vscode` do not load Prettier settings from ESLint config, which is where we load our Prettier options from. To workaround this, add a `.prettierrc.js` or `prettier.config.js` file to your repo root with the following content:
+
+```js
+module.exports = require('eslint-config-zillow-base/prettier.config');
+```
 
 ## Related
 

packages/eslint-config-zillow-base/README.md

@@ -7,6 +7,7 @@ module.exports = {
     './rules/variables',
     './rules/es6',
     './rules/imports',
+    './rules/prettier',
   ].map(require.resolve),
   parserOptions: {
     ecmaVersion: 2017,

packages/eslint-config-zillow-base/index.js

@@ -5,6 +5,7 @@
   "main": "index.js",
   "files": [
     "index.js",
+    "prettier.config.js",
     "rules"
   ],
   "scripts": {
@@ -30,7 +31,9 @@
   },
   "peerDependencies": {
     "eslint": "^4.18.1",
-    "eslint-plugin-import": "^2.9.0"
+    "eslint-plugin-import": "^2.9.0",
+    "eslint-plugin-prettier": "^2.6.0",
+    "prettier": "^1.11.1"
   },
   "dependencies": {
     "eslint-restricted-globals": "^0.1.1"

packages/eslint-config-zillow-base/package.json

@@ -0,0 +1,14 @@
+module.exports = {
+  // defaults
+  bracketSpacing: true,
+  jsxBracketSameLine: false,
+  parser: 'babylon',
+  semi: true,
+  useTabs: false,
+
+  // overrides
+  printWidth: 100,
+  singleQuote: true,
+  tabWidth: 4,
+  trailingComma: 'es5',
+};

packages/eslint-config-zillow-base/prettier.config.js

@@ -23,8 +23,8 @@ module.exports = {
     'consistent-return': 'error',
 
     // specify curly brace conventions for all control statements
-    // FIXME: prettier override
-    curly: ['error', 'multi-line'],
+    // https://github.com/prettier/eslint-config-prettier#curly
+    curly: ['error', 'all'],
 
     // require default case in switch statements
     'default-case': ['error', { commentPattern: '^no default$' }],
@@ -34,7 +34,7 @@ module.exports = {
 
     // enforces consistent newlines before or after dots
     // https://eslint.org/docs/rules/dot-location
-    'dot-location': ['error', 'property'],
+    'dot-location': ['off'/* prettier */, 'property'],
 
     // require the use of === and !==
     // https://eslint.org/docs/rules/eqeqeq
@@ -95,7 +95,7 @@ module.exports = {
     'no-fallthrough': 'error',
 
     // disallow the use of leading or trailing decimal points in numeric literals
-    'no-floating-decimal': 'error',
+    'no-floating-decimal': 'off'/* prettier */,
 
     // disallow reassignments of native objects or read-only globals
     // https://eslint.org/docs/rules/no-global-assign
@@ -144,7 +144,7 @@ module.exports = {
     }],
 
     // disallow use of multiple spaces
-    'no-multi-spaces': ['error', {
+    'no-multi-spaces': ['off'/* prettier */, {
       ignoreEOLComments: false,
     }],
 
@@ -311,7 +311,7 @@ module.exports = {
 
     // require immediate function invocation to be wrapped in parentheses
     // https://eslint.org/docs/rules/wrap-iife.html
-    'wrap-iife': ['error', 'outside', { functionPrototypeMethods: false }],
+    'wrap-iife': ['off'/* prettier */, 'outside', { functionPrototypeMethods: false }],
 
     // require or disallow Yoda conditions
     yoda: 'error'

packages/eslint-config-zillow-base/rules/best-practices.js

@@ -64,7 +64,7 @@ module.exports = {
     }],
 
     // disallow unnecessary semicolons
-    'no-extra-semi': 'error',
+    'no-extra-semi': 'off'/* prettier */,
 
     // disallow overwriting functions written as function declarations
     'no-func-assign': 'error',
@@ -97,7 +97,7 @@ module.exports = {
 
     // Avoid code that looks like two expressions but is actually one
     // https://eslint.org/docs/rules/no-unexpected-multiline
-    // FIXME: prettier override
+    // https://github.com/prettier/eslint-config-prettier#no-unexpected-multiline
     'no-unexpected-multiline': 'error',
 
     // disallow unreachable statements after a return, throw, continue, or break statement

packages/eslint-config-zillow-base/rules/errors.js

@@ -21,30 +21,30 @@ module.exports = {
 
     // require parens in arrow function arguments
     // https://eslint.org/docs/rules/arrow-parens
-    'arrow-parens': ['error', 'as-needed', {
+    'arrow-parens': ['off'/* prettier */, 'as-needed', {
       requireForBlockBody: true,
     }],
 
     // require space before/after arrow function's arrow
     // https://eslint.org/docs/rules/arrow-spacing
-    'arrow-spacing': ['error', { before: true, after: true }],
+    'arrow-spacing': ['off'/* prettier */, { before: true, after: true }],
 
     // verify super() callings in constructors
     'constructor-super': 'error',
 
     // enforce the spacing around the * in generator functions
     // https://eslint.org/docs/rules/generator-star-spacing
-    'generator-star-spacing': ['error', { before: false, after: true }],
+    'generator-star-spacing': ['off'/* prettier */, { before: false, after: true }],
 
     // disallow modifying variables of class declarations
     // https://eslint.org/docs/rules/no-class-assign
     'no-class-assign': 'error',
 
     // disallow arrow functions where they could be confused with comparisons
     // https://eslint.org/docs/rules/no-confusing-arrow
-    // FIXME: prettier override
+    // https://github.com/prettier/eslint-config-prettier#no-confusing-arrow
     'no-confusing-arrow': ['error', {
-      allowParens: true,
+      allowParens: false,
     }],
 
     // disallow modifying variables that are declared using const
@@ -153,7 +153,7 @@ module.exports = {
 
     // enforce spacing between object rest-spread
     // https://eslint.org/docs/rules/rest-spread-spacing
-    'rest-spread-spacing': ['error', 'never'],
+    'rest-spread-spacing': ['off'/* prettier */, 'never'],
 
     // import sorting
     // https://eslint.org/docs/rules/sort-imports
@@ -169,10 +169,10 @@ module.exports = {
 
     // enforce usage of spacing in template strings
     // https://eslint.org/docs/rules/template-curly-spacing
-    'template-curly-spacing': 'error',
+    'template-curly-spacing': 'off'/* prettier */,
 
     // enforce spacing around the * in yield* expressions
     // https://eslint.org/docs/rules/yield-star-spacing
-    'yield-star-spacing': ['error', 'after']
+    'yield-star-spacing': ['off'/* prettier */, 'after']
   }
 };

packages/eslint-config-zillow-base/rules/es6.js

@@ -0,0 +1,13 @@
+const config = require('../prettier.config');
+
+module.exports = {
+  plugins: [
+    'prettier'
+  ],
+
+  rules: {
+    'prettier/prettier': ['error', config, {
+      usePrettierrc: false
+    }]
+  }
+};