Skip to content

Commit

Permalink
Document automatic cache flushing
Browse files Browse the repository at this point in the history
  • Loading branch information
mantoni committed Aug 24, 2018
1 parent 0176ec5 commit 39c56bc
Showing 1 changed file with 8 additions and 4 deletions.
12 changes: 8 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,13 +46,17 @@ current working directories `node_modules` folder, then this version of eslint
is going to be used. Otherwise, the version of eslint that ships with
`eslint_d` is used as a fallback.

Note that the performance gain comes at a small price: Some changes are only
picked up after a server restart, so you will have to remember to run `eslint_d
restart` after installing a plugin.

To keep the memory footprint low, `eslint_d` keeps only the last 10 used
instances in the internal [nanolru][] cache.

## What if eslint or a plugin is updated?

The cached version of eslint and the Node `require` cache for the current
working directory are cleared whenever a change to one of these files is
detected: `package.json`, `package-lock.json`, `npm-shrinkwrap.json` and
`yarn.lock`. If changes are not automatically detected, remember to run
`eslint_d restart` to bounce the background server.

## Commands

Control the server like this:
Expand Down

0 comments on commit 39c56bc

Please sign in to comment.