require-dir1.2.0 • Public • Published
Node helper to
require() directories. The directory's files are examined,
and each one that can be
require()'d and returned as part
of a hash from that file's basename to its exported contents.
Given this directory structure:
dir + a.js + b.json + c.coffee + d.txt
requireDir('./dir') will return the equivalent of:
If CoffeeScript is registered via
c.coffee will also be returned. Any extension registered with node will work the same way without any additional configuration.
npm install require-dir
Note that this package is not
requireDir — turns out that's already
Basic usage that examines only directories' immediate files:
var requireDir = ;var dir = ;
You can optionally customize the behavior by passing an extra options object:
var dir = ;
recurse: Whether to recursively
require() subdirectories too.
node_modules within subdirectories will be ignored.)
Default is false.
filter: Apply a filter on the filename before require-ing. For example, ignoring files prefixed with
dev in a production environment:
mapKey: Apply a transform to the module base name after require-ing. For example, uppercasing any module names:
mapValue: Apply a transform to the value after require-ing. For example, uppercasing any text exported:
duplicates: By default, if multiple files share the same basename, only the
highest priority one is
require()'d and returned. (Priority is determined by
the order of
require.extensions keys, with directories taking precedence
over files if
recurse is true.) Specifying this option
files and returns full filename keys in addition to basename keys.
Default is false.
In the example above, if there were also an
a.json, the behavior would
be the same by default, but specifying
duplicates: true would yield:
noCache: Prevent file caching. Could be useful using gulp.watch or other watch requiring refreshed file content Default is false.
extensions: Array of extensions to look for instead of using
index.js in a directory with this code to clean things up:
moduleexports = ; // defaults to '.'
And don't worry, the calling file is always ignored to prevent infinite loops.