importDir()

Node helper to import() directories. The directory's files are examined, and each one that can be import()'d is import()'d and returned as part of a hash from that file's basename to its exported contents.

Example

Given this directory structure:

dir
+ a.js
+ b.json
+ c.coffee
+ d.txt

importDir('./dir') will return the equivalent of:

{
  a: await import('./dir/a.js'),
  b: await import('./dir/b.json')
}

If CoffeeScript is registered via require('coffee-script/register'), c.coffee will also be returned. Any extension registered with node will work the same way without any additional configuration.

Installation

npm install @tomrpc/import-dir

Usage

Basic usage that examines only directories' immediate files:

const importDir,{join} import '@tomrpc/import-dir';

const dir = await importDir(join(import.meta.url, './path/to/dir'));

You can optionally customize the behavior by passing an extra options object:

const dir = await importDir(join(import.meta.url, './path/to/dir'), { recurse: true });

Options

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:

await importDir('./dir', {
  filter: function (fullPath) {
    return process.env.NODE_ENV !== 'production' && !fullPath.match(/$dev/);
  }
})

mapKey: Apply a transform to the module base name after require-ing. For example, uppercasing any module names:

await importDir('./dir', {
  mapKey: function (value, baseName) {
    return baseName.toUpperCase();
  }
})

mapValue: Apply a transform to the value after require-ing. For example, uppercasing any text exported:

await importDir('./dir', {
  mapValue: function (value, baseName) {
    return typeof value === 'string' ? value.toUpperCase() : value;
  }
})

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 require()'s all 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:

{
  a: await import('./dir/a.js'),
  'a.js': await import('./dir/a.js'),
  'a.json': await import('./dir/a.json'),
  b: await import('./dir/b.json'),
  'b.json': await import('./dir/b.json')
}

noCache: Prevent file caching. Could be useful using gulp.watch or other watch requiring refreshed file content Default is false.

await importDir('./dir', { noCache: true })

extensions: Array of extensions to look for instead of using require.extensions.

await importDir('./dir', { extensions: ['.js', '.json'] })

Thanks

many thanks https://github.com/aseemk/requireDir