style: Add prettier, fix eslint configuration and prettify all files (lint-staged#231)

* chore(eslint): list `coverage` dir in `.eslintignore`
The files in this directory shouldn't be checked by ESLint

* chore(eslint): fix inconcistencies

The problem are mainly caused by `tabWidth`:
* The default is '2', not overridden by eslint-config-okonet
* In this project's eslintrc we override it in `indent` rule
  which of course will fight with `prettier` default.
* Also deleted some unnecessary overrides in `prettier` field
  because they're already the default out of the box

* chore(eslint): rename `.eslintrc` to be `.eslintrc.json`

This will make IDE applies proper syntax highlighting

* style: run `lint:fix` script

* chore: run `lint` script before `test`

* Revert "chore(eslint): fix inconcistencies"

This reverts commit 1fb420c.

* chore(eslint): remove `indent` rule

* style: run `lint:fix` script

* chore(editorconfig): update `indent_size`

* ci: run installation with npm v3 and above

* chore: install `prettier`

pin to v1.5.3

Author: luftywiranda13

.editorconfig

@@ -3,7 +3,7 @@ root = true
 
 [*]
 indent_style = space
-indent_size = 4
+indent_size = 2
 end_of_line = lf
 charset = utf-8
 trim_trailing_whitespace = true

.eslintignore

@@ -0,0 +1 @@
+coverage

.eslintrc .eslintrc.json

@@ -9,7 +9,6 @@
     "es6": true
   },
   "rules": {
-    "indent": [2, 4],
     "strict": 0,
     "import/no-extraneous-dependencies": [2, {
       "devDependencies": ["**/*.spec.js"]

.travis.yml

@@ -6,6 +6,7 @@ node_js:
   - '8'
   - '6'
   - '4'
+before_install: if [[ `npm -v` < 3* ]]; then npm i -g npm@^3; fi
 before_script:
   - npm prune
 after_success:

package.json

@@ -12,6 +12,7 @@
     "lint": "eslint .",
     "lint:fix": "npm run lint -- --fix",
     "pre-commit": "remove-lockfiles && node index.js",
+    "pretest": "npm run lint",
     "test": "jest --coverage",
     "deps": "npm-check -s",
     "deps:update": "npm-check -u"
@@ -76,6 +77,7 @@
     "jsonlint-cli": "^1.0.1",
     "npm-check": "^5.2.2",
     "pre-commit": "^1.1.3",
+    "prettier": "1.5.3",
     "remove-lockfiles": "^0.2.1"
   },
   "config": {

src/calcChunkSize.js

@@ -26,17 +26,17 @@
  * @returns {number} The chunk size
  */
 module.exports = function calcChunkSize(paths, idealChunkSize) {
-    /* What is the longest file path? */
-    const maxPathLen = paths.reduce(
-        (maxLen, filePath) => Math.max(maxLen, filePath.length),
-        20 // safe initial value
-    )
+  /* What is the longest file path? */
+  const maxPathLen = paths.reduce(
+    (maxLen, filePath) => Math.max(maxLen, filePath.length),
+    20 // safe initial value
+  )
 
-    /* In the worst case scenario, */
-    /* how many files can we process in a single command? */
-    /* For windows systems, command length is limited to 8192 */
-    const maxAllowedChunkSize = Math.floor(8000 / maxPathLen)
+  /* In the worst case scenario, */
+  /* how many files can we process in a single command? */
+  /* For windows systems, command length is limited to 8192 */
+  const maxAllowedChunkSize = Math.floor(8000 / maxPathLen)
 
-    /* Configured chunk size / default - idealChunkSize */
-    return Math.min(paths.length, maxAllowedChunkSize, idealChunkSize)
+  /* Configured chunk size / default - idealChunkSize */
+  return Math.min(paths.length, maxAllowedChunkSize, idealChunkSize)
 }

src/findBin.js

@@ -3,22 +3,18 @@
 const npmWhich = require('npm-which')(process.cwd())
 
 module.exports = function findBin(cmd, packageJson, options) {
-    /*
+  /*
     * If package.json has script with cmd defined
     * we want it to be executed first
     */
-    if (packageJson.scripts && packageJson.scripts[cmd] !== undefined) {
-        // Support for scripts from package.json
-        const args = [
-            'run',
-            options && options.verbose ? undefined : '--silent',
-            cmd
-        ].filter(Boolean)
+  if (packageJson.scripts && packageJson.scripts[cmd] !== undefined) {
+    // Support for scripts from package.json
+    const args = ['run', options && options.verbose ? undefined : '--silent', cmd].filter(Boolean)
 
-        return { bin: 'npm', args }
-    }
+    return { bin: 'npm', args }
+  }
 
-    /*
+  /*
     *  If cmd wasn't found in package.json scripts
     *  we'll try to locate the binary in node_modules/.bin
     *  and if this fails in $PATH.
@@ -36,17 +32,17 @@ module.exports = function findBin(cmd, packageJson, options) {
     *  }
     */
 
-    const parts = cmd.split(' ')
-    let bin = parts[0]
-    const args = parts.splice(1)
+  const parts = cmd.split(' ')
+  let bin = parts[0]
+  const args = parts.splice(1)
 
-    try {
-        /* npm-which tries to resolve the bin in local node_modules/.bin */
-        /* and if this fails it look in $PATH */
-        bin = npmWhich.sync(bin)
-    } catch (err) {
-        throw new Error(`${ bin } could not be found. Try \`npm install ${ bin }\`.`)
-    }
+  try {
+    /* npm-which tries to resolve the bin in local node_modules/.bin */
+    /* and if this fails it look in $PATH */
+    bin = npmWhich.sync(bin)
+  } catch (err) {
+    throw new Error(`${bin} could not be found. Try \`npm install ${bin}\`.`)
+  }
 
-    return { bin, args }
+  return { bin, args }
 }

src/generateTasks.js

@@ -5,21 +5,26 @@ const minimatch = require('minimatch')
 const readConfigOption = require('./readConfigOption')
 
 module.exports = function generateTasks(config, files) {
-    const linters = config.linters !== undefined ? config.linters : config
-    const resolve = file => files[file]
-    return Object.keys(linters)
-        .map((pattern) => {
-            const commands = linters[pattern]
-            const globOptions = readConfigOption(config, 'globOptions', {})
-            const filter = minimatch.filter(pattern, Object.assign({
-                matchBase: true,
-                dot: true
-            }, globOptions))
-            const fileList = Object.keys(files).filter(filter).map(resolve)
-            return {
-                pattern,
-                commands,
-                fileList
-            }
-        })
+  const linters = config.linters !== undefined ? config.linters : config
+  const resolve = file => files[file]
+  return Object.keys(linters).map(pattern => {
+    const commands = linters[pattern]
+    const globOptions = readConfigOption(config, 'globOptions', {})
+    const filter = minimatch.filter(
+      pattern,
+      Object.assign(
+        {
+          matchBase: true,
+          dot: true
+        },
+        globOptions
+      )
+    )
+    const fileList = Object.keys(files).filter(filter).map(resolve)
+    return {
+      pattern,
+      commands,
+      fileList
+    }
+  })
 }

src/index.js

@@ -9,99 +9,96 @@ const appRoot = require('app-root-path')
 const Listr = require('listr')
 const cosmiconfig = require('cosmiconfig')
 
-const packageJson = require(appRoot.resolve('package.json')) // eslint-disable-line
+const packageJson = require(appRoot.resolve('package.json')); // eslint-disable-line
 const runScript = require('./runScript')
 const generateTasks = require('./generateTasks')
 const readConfigOption = require('./readConfigOption')
 
 // Force colors for packages that depend on https://www.npmjs.com/package/supports-color
 // but do this only in TTY mode
 if (process.stdout.isTTY) {
-    process.env.FORCE_COLOR = true
+  process.env.FORCE_COLOR = true
 }
 
 cosmiconfig('lint-staged', {
-    rc: '.lintstagedrc',
-    rcExtensions: true
+  rc: '.lintstagedrc',
+  rcExtensions: true
 })
-    .then((result) => {
-        // result.config is the parsed configuration object
-        // result.filepath is the path to the config file that was found
-        const config = result.config
+  .then(result => {
+    // result.config is the parsed configuration object
+    // result.filepath is the path to the config file that was found
+    const config = result.config
 
-        const verbose = config.verbose
-        // Output config in verbose mode
-        if (verbose) console.log(config)
-        const concurrent = readConfigOption(config, 'concurrent', true)
-        const renderer = verbose ? 'verbose' : 'update'
-        const gitDir = config.gitDir ? path.resolve(config.gitDir) : process.cwd()
-        sgf.cwd = gitDir
+    const verbose = config.verbose
+    // Output config in verbose mode
+    if (verbose) console.log(config)
+    const concurrent = readConfigOption(config, 'concurrent', true)
+    const renderer = verbose ? 'verbose' : 'update'
+    const gitDir = config.gitDir ? path.resolve(config.gitDir) : process.cwd()
+    sgf.cwd = gitDir
 
-        sgf('ACM', (err, files) => {
-            if (err) {
-                console.error(err)
-                process.exit(1)
-            }
-
-            const resolvedFiles = {}
-            files.forEach((file) => {
-                const absolute = path.resolve(gitDir, file.filename)
-                const relative = path.relative(gitDir, absolute)
-                resolvedFiles[relative] = absolute
-            })
-
-            const tasks = generateTasks(config, resolvedFiles)
-                .map(task => ({
-                    title: `Running tasks for ${ task.pattern }`,
-                    task: () => (
-                        new Listr(
-                            runScript(
-                                task.commands,
-                                task.fileList,
-                                packageJson,
-                                { gitDir, verbose, config }
-                            ), {
-                                // In sub-tasks we don't want to run concurrently
-                                // and we want to abort on errors
-                                concurrent: false,
-                                exitOnError: true
-                            }
-                        )
-                    ),
-                    skip: () => {
-                        if (task.fileList.length === 0) {
-                            return `No staged files match ${ task.pattern }`
-                        }
-                        return false
-                    }
-                }))
+    sgf('ACM', (err, files) => {
+      if (err) {
+        console.error(err)
+        process.exit(1)
+      }
 
+      const resolvedFiles = {}
+      files.forEach(file => {
+        const absolute = path.resolve(gitDir, file.filename)
+        const relative = path.relative(gitDir, absolute)
+        resolvedFiles[relative] = absolute
+      })
 
-            if (tasks.length) {
-                new Listr(tasks, {
-                    concurrent,
-                    renderer,
-                    exitOnError: !concurrent // Wait for all errors when running concurrently
-                })
-                    .run()
-                    .catch((error) => {
-                        if (Array.isArray(error.errors)) {
-                            error.errors.forEach((lintError) => {
-                                console.error(lintError.message)
-                            })
-                        } else {
-                            console.log(error.message)
-                        }
-                        process.exit(1)
-                    })
+      const tasks = generateTasks(config, resolvedFiles).map(task => ({
+        title: `Running tasks for ${task.pattern}`,
+        task: () =>
+          new Listr(
+            runScript(task.commands, task.fileList, packageJson, {
+              gitDir,
+              verbose,
+              config
+            }),
+            {
+              // In sub-tasks we don't want to run concurrently
+              // and we want to abort on errors
+              concurrent: false,
+              exitOnError: true
             }
+          ),
+        skip: () => {
+          if (task.fileList.length === 0) {
+            return `No staged files match ${task.pattern}`
+          }
+          return false
+        }
+      }))
+
+      if (tasks.length) {
+        new Listr(tasks, {
+          concurrent,
+          renderer,
+          exitOnError: !concurrent // Wait for all errors when running concurrently
         })
+          .run()
+          .catch(error => {
+            if (Array.isArray(error.errors)) {
+              error.errors.forEach(lintError => {
+                console.error(lintError.message)
+              })
+            } else {
+              console.log(error.message)
+            }
+            process.exit(1)
+          })
+      }
     })
-    .catch((parsingError) => {
-        console.error(`Could not parse lint-staged config.
+  })
+  .catch(parsingError => {
+    console.error(`Could not parse lint-staged config.
 Make sure you have created it. See https://github.com/okonet/lint-staged#readme.
 
-${ parsingError }
+${parsingError}
 `)
-        process.exit(1)
-    })
+    process.exit(1)
+  })

src/readConfigOption.js

@@ -11,10 +11,9 @@
  * @returns {*}
  */
 module.exports = function readConfigOption(config, key, defaultValue) {
-    if (typeof config !== 'undefined' && typeof config[key] !== 'undefined') {
-        return config[key]
-    }
+  if (typeof config !== 'undefined' && typeof config[key] !== 'undefined') {
+    return config[key]
+  }
 
-    return defaultValue
+  return defaultValue
 }
-