glob-autoload [Proof of concept]
Use glob patterns to automatically create a namespace of lazy-imported modules from the filesystem.
Table of contents
Installation
Run
> npm i glob-autoload
Getting started
Disclaimer: This is a proof-of-concept project, and will be until v0.1, You can help on a RC by providing feedback about the implementation.
Any kind of contributing is more than welcome!
Import this package and create an instance by passing an Options object, then call the load()
method on it.
// /src/config/app.jsmoduleexports = version: "1.0" ; // /src/index.js; const loader = cwd: __directory namespace: controllers: "./**/*Controller.js" config: "./config/*.js" "./*.config.js" ignore: "./controllers/BaseController.js"; loader;
API
loader.load(readyFn: function)
Resolves all the globs passed to the namespace
option and fires the given readyFn
callback.
readyFn(err, namespace)
An error-first callback to be fired after the load
method resolved all the globs.
err
: an error is assigned to this argument if something bad happenednamespace
: an object containing a dictionary of namespaces, whose values are another dictionary offile paths
(key) andfile contents
(value), askey: value
respectively.
Example:
const loader = namespace: config: "./config/*.js" ; loader;
Options
new Autoload(AutoloadOptions)
cwd
(path string)
The root directory to start autoloading from.
This option is mandatory
namespace
({})
Key-value store of namespaces and their respective glob strings
ignore
(string|string[])
String or Array of globs to prevent matching files from being actually matched.
onlyFiles: true
(Boolean)
Return only files