Skip to content
This repository was archived by the owner on Sep 28, 2020. It is now read-only.

Add caching ability to the loader #93

Merged
merged 4 commits into from
Jul 28, 2016
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand Down
64 changes: 61 additions & 3 deletions index.js
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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()

Expand All @@ -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
Expand Down Expand Up @@ -108,6 +136,36 @@ 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 {
var cacheFileContent = fs.readFileSync(cachePath)
if (cacheFileContent) {
cache = JSON.parse(cacheFileContent)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

any reason you don't require() the file instead?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am not sure. Is it better?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Better I can't prove it, but definitely shorter :)

This should be enough:

try { 
  cache = require(thunk("data.json"))
}
catch (e) {
  cache = {}
}

}
}
catch (e) {
cache = {}
}
}
else {
cache = false
}
}

lint(input, config, this)
this.callback(null, input, map)
}
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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"
},
Expand Down