Added: cache options (#93)

* Add the ability to cache the results in a file and reuse them

* Use find-cache-dir, Style fixes

* Add cache option description in the Readme

* Use require to read the cache file

Author: genintho

README.md

@@ -94,6 +94,14 @@ This option will enable
 **Be careful, this option might cause webpack to enter an infinite build loop if
 some issues cannot be fixed properly.**
 
+#### `cache` (default: false)
+
+This option will enable caching of the linting results into a file.
+This is particullarly usefull to reduce linting time when doing full build.
+
+The cache is writting inside the `./node_modules/.cache` directory, thanks to the usage
+of the [find-cache-dir](https://www.npmjs.com/package/find-cache-dir) module.
+
 #### `formatter` (default: eslint stylish formatter)
 
 Loader accepts a function that will have one argument: an array of eslint messages (object).

index.js

@@ -1,6 +1,13 @@
 var eslint = require("eslint")
 var assign = require("object-assign")
 var loaderUtils = require("loader-utils")
+var crypto = require("crypto")
+var fs = require("fs")
+var findCacheDir = require("find-cache-dir")
+
+var engine = null
+var cache = null
+var cachePath = null
 
 /**
  * linter
@@ -11,8 +18,6 @@ var loaderUtils = require("loader-utils")
  * @return {void}
  */
 function lint(input, config, webpack) {
-  var engine = new eslint.CLIEngine(config)
-
   var resourcePath = webpack.resourcePath
   var cwd = process.cwd()
 
@@ -22,7 +27,30 @@ function lint(input, config, webpack) {
     resourcePath = resourcePath.substr(cwd.length + 1)
   }
 
-  var res = engine.executeOnText(input, resourcePath, true)
+  var res
+  // If cache is enable and the data are the same as in the cache, just
+  // use them
+  if (config.cache) {
+    var inputMD5 = crypto.createHash("md5").update(input).digest("hex")
+    if (cache[resourcePath] && cache[resourcePath].hash === inputMD5) {
+      res = cache[resourcePath].res
+    }
+  }
+
+  // Re-lint the text if the cache off or miss
+  if (!res) {
+    res = engine.executeOnText(input, resourcePath, true)
+
+    // Save new results in the cache
+    if (config.cache) {
+      cache[resourcePath] = {
+        hash: inputMD5,
+        res: res,
+      }
+      fs.writeFileSync(cachePath, JSON.stringify(cache))
+    }
+  }
+
   // executeOnText ensure we will have res.results[0] only
 
   // skip ignored file warning
@@ -108,6 +136,33 @@ module.exports = function(input, map) {
     loaderUtils.parseQuery(this.query)
   )
   this.cacheable()
+
+  // Create the engine only once
+  if (engine === null) {
+    engine = new eslint.CLIEngine(config)
+  }
+
+  // Read the cached information only once and if enable
+  if (cache === null) {
+    if (config.cache) {
+      var thunk = findCacheDir({
+        name: "eslint-loader",
+        thunk: true,
+        create: true,
+      })
+      cachePath = thunk("data.json")
+      try {
+        cache = require(cachePath)
+      }
+      catch (e) {
+        cache = {}
+      }
+    }
+    else {
+      cache = false
+    }
+  }
+
   lint(input, config, this)
   this.callback(null, input, map)
 }

package.json

@@ -19,6 +19,7 @@
     "eslint": ">=1.6.0 <4.0.0"
   },
   "dependencies": {
+    "find-cache-dir": "^0.1.1",
     "loader-utils": "^0.2.7",
     "object-assign": "^4.0.1"
   },