Security News
Introducing the Socket Python SDK
The initial version of the Socket Python SDK is now on PyPI, enabling developers to more easily interact with the Socket REST API in Python projects.
require-dir
Advanced tools
The require-dir npm package allows you to require all files in a directory, making it easier to manage and load multiple modules without having to require each one individually.
Basic Usage
This feature allows you to require all files in a specified directory. The returned object will have keys corresponding to the filenames and values being the required modules.
const requireDir = require('require-dir');
const modules = requireDir('./path/to/directory');
Recursive Loading
This feature allows you to recursively require all files in a directory and its subdirectories. The returned object will have nested objects corresponding to the directory structure.
const requireDir = require('require-dir');
const modules = requireDir('./path/to/directory', { recurse: true });
Filtering Files
This feature allows you to filter which files to require based on a custom filter function. In this example, only files ending with '.js' will be required.
const requireDir = require('require-dir');
const modules = requireDir('./path/to/directory', { filter: (filename) => filename.endsWith('.js') });
The glob package allows you to use wildcard patterns to find files and directories. It is more flexible in terms of pattern matching but does not directly require the files like require-dir.
The readdirp package provides recursive file and directory listing with filtering options. It is more focused on file system traversal and does not directly require the files.
The require-all package is very similar to require-dir, allowing you to require all files in a directory. It offers additional options like filtering and mapping filenames to module names.
Node helper to require()
directories. The directory's files are examined,
and each one that can be require()
'd is 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:
{ a: require('./dir/a.js')
, b: require('./dir/b.json')
}
And if CoffeeScript has been registered via require('coffee-script/register')
,
c.coffee
will also be returned.
npm install require-dir
Note that this package is not requireDir
— turns out that's already
taken! ;)
Basic usage that examines only directories' immediate files:
var requireDir = require('require-dir');
var dir = requireDir('./path/to/dir');
You can optionally customize the behavior by passing an extra options object:
var dir = requireDir('./path/to/dir', {recurse: true});
recurse
: Whether to recursively require()
subdirectories too.
(node_modules
within subdirectories will be ignored.)
Default is false.
camelcase
: Automatically add camelcase aliases for files with dash- and
underscore-separated names. E.g. foo-bar.js
will be exposed under both the
original 'foo-bar'
name as well as a 'fooBar'
alias. Default is false.
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.
E.g. 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: require('./dir/a.js')
, 'a.js': require('./dir/a.js')
, 'a.json': require('./dir/a.json')
, b: require('./dir/b.json')
, 'b.json': require('./dir/b.json')
}
There might be more options in the future. ;)
If you want to require()
the same directory in multiple places, you can do
this in the directory itself! Just make an index.js
file with the following:
module.exports = require('require-dir')(); // defaults to '.'
And don't worry, the calling file is always ignored to prevent infinite loops.
It'd be awesome if this could work with the regular require()
, e.g. like a
regular require()
hook. Not sure that's possible though; directories are
already special-cased to look for an index
file or package.json
.
An ignore
option would be nice: a string or regex, or an array of either or
both, of paths, relative to the directory, to ignore. String paths can be
extensionless to ignore all extensions for that path. Supporting shell-style
globs in string paths would be nice.
Currently, basenames are derived for directories too — e.g. a directory named
a.txt
will be returned as a
when recursing — but should that be the case?
Maybe directories should always be returned by their full name, and/or maybe
this behavior should be customizable. This is hopefully an edge case.
MIT. © 2012-2015 Aseem Kishore.
FAQs
Helper to require() directories.
The npm package require-dir receives a total of 197,850 weekly downloads. As such, require-dir popularity was classified as popular.
We found that require-dir demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
The initial version of the Socket Python SDK is now on PyPI, enabling developers to more easily interact with the Socket REST API in Python projects.
Security News
Floating dependency ranges in npm can introduce instability and security risks into your project by allowing unverified or incompatible versions to be installed automatically, leading to unpredictable behavior and potential conflicts.
Security News
A new Rust RFC proposes "Trusted Publishing" for Crates.io, introducing short-lived access tokens via OIDC to improve security and reduce risks associated with long-lived API tokens.