Clear Require Cache

Watch files and clear them from require.cache whenever changes are made.

Installation

Install locally:

$ npm install sapientnitrola/clear-require-cache --save-dev

Install globally to have clearcache available in your path:

$ npm install sapientnitrola/clear-require-cache -g

Usage

Module

1const clearRequireCache = require( 'clear-require-cache' );
2clearRequireCache( patterns, options );

CLI

Globally installed:

1clearcache [options] <pattern> [patterns...]

Locally installed:

1./node_modules/.bin/clearcache [options] <pattern> [patterns...]

Module Arguments

patterns

File glob patterns. See supported minimatch patterns.

• Type: String, Array
• Required: true

Example:

1const clearRequireCache = require( 'clear-require-cache' );
2clearRequireCache( '**/*.js' );

Note: The node_modules directory is ignored by default.

options

Defaults to the options supported by chokidar. This object is passed directly to chokidar, but not all options will be relavent to the scope of clear-require-cache.

• Type: Object
• Required: false

options.quiet

Suppress all log messages.

• Type: Boolean
• Default: false

CLI

1Usage: clearcache [options] <pattern> [patterns...]
2
3Multiple glob patterns can passed as a space delimited list.
4To prevent shell globbing, wrap each pattern in quotes.
5Glob primer: https://github.com/isaacs/node-glob#glob-primer
6
7Options:
8
9  -h, --help     output usage information
10  -V, --version  output the version number
11  -q, --quiet    Suppress all log messages.
12
13
14Examples:
15
16  Watch all files with '.js' extension
17  $ clearcache '**/*.js'
18
19  Watch all files with '.js' extension, except ones in the "tests" directory
20  $ clearcache '**/*.js' '!tests/*.js'

TODO

• Describe some common use cases.
• Cross platform testing.
• Test suite.
• Travis CI