requireindex

What is requireindex?

The requireindex npm package is a utility that helps you require all modules in a directory and returns an object with the module names as keys and the modules themselves as values. This can be particularly useful for organizing and managing large codebases where you need to import multiple modules from a single directory.

What are requireindex's main functionalities?

Require all modules in a directory

This feature allows you to require all modules in a specified directory. The code sample demonstrates how to use requireindex to import all modules from the 'myModules' directory and log the resulting object.

const requireindex = require('requireindex');
const modules = requireindex(__dirname + '/myModules');
console.log(modules);

Custom file filtering

This feature allows you to filter which files to require based on a custom function. The code sample shows how to only require JavaScript files from the 'myModules' directory.

const requireindex = require('requireindex');
const modules = requireindex(__dirname + '/myModules', (filename) => filename.endsWith('.js'));
console.log(modules);

Other packages similar to requireindex

require-all

The require-all package is similar to requireindex in that it allows you to require all modules in a directory. However, require-all provides more configuration options, such as the ability to filter files by regular expressions, exclude certain files, and more. It is more flexible but also slightly more complex to use.

include-all

The include-all package is another alternative that allows you to include all files in a directory. It offers features like recursive directory inclusion and custom file filtering. Compared to requireindex, include-all is more feature-rich and provides more control over the inclusion process.

README

Description

Write minimal node index.js files that require and export siblings by file basename

Latest Version

0.1.3

Installation

npm install requireindex

or in package.json

{
  ...
  "dependencies": {
    "requireindex": "~0.1.3"
  }
}

Usage

Check the test directory for example usage. The test/lib looks like:

lib/
  index.js
  Foo.js
  bar/
    index.js
    f.js
    fing.js
    fed/
      again.js
      ignored.js
      index.js
      somemore.js
  bam.js
  _private.js
  

The index.js files in test/lib/ and test/lib/bar/ contain:

module.exports = require('requireindex')(__dirname);

and the index.js file in test/lib/bar/fed/ contains:

module.exports = require('requireindex')(__dirname, ['again', 'somemore']);

The optional second argument allows you to explicitly specify the required files using their basename. In this example test/lib/bar/fed/ignored.js is not included as a public module. The other way to make a module/file private without the need for explicitly naming all the other included files is to prefix the filename with an underscore, as demonstrated by test/lib/_private.js which is not exported.

So, with these index.js files, the result of

require('lib');

is:

{ 
  bam: { 
    m: [Function], 
    n: [Function] 
  },
  bar: { 
    f: [Function],
    fed: { 
      again: [Function], 
      somemore: [Function] 
    },
    fing: [Function] 
  },
  Foo: { 
    l: [Function], 
    ls: [Function] 
  } 
}