Introduction to Include-All

The include-all package simplifies the process of dynamically including entire directories of files into your Node.js application. This is highly useful for organizing your code, especially in large projects.

Installation

  npm install include-all

Basic Usage

To include all JavaScript files in a directory, you can use:

  const includeAll = require('include-all');
  const controllers = includeAll({
    dirname: __dirname + '/controllers',
    filter : /(.+Controller)\.js$/
  });

Filtering Files

You can specify custom filters to include only specific types of files:

  const models = includeAll({
    dirname: __dirname + '/models',
    filter : /(.+Model)\.js$/
  });

Directory Tree

Include subdirectories by setting the depth parameter:

  const services = includeAll({
    dirname    :  __dirname + '/services',
    filter     :  /(.+Service)\.js$/,
    depth      :  3
  });

Recursive Include

Recursively include files and directories:

  const allFiles = includeAll({
    dirname :  __dirname,
    recursive: true
  });

Using Options

Additional options for more control:

  const configs = includeAll({
    dirname :  __dirname + '/config',
    excludeDirs:  /^\.(git|svn)$/,
    filter :  /(.+)\.json$/
  });

App Example

Here’s a simple Express app using include-all:

  const express = require('express');
  const includeAll = require('include-all');
  const app = express();

  // Include all controllers
  const controllers = includeAll({
    dirname: __dirname + '/controllers',
    filter : /(.+Controller)\.js$/
  });

  // Map controllers to routes
  Object.keys(controllers).forEach(name => {
    if (typeof controllers[name] === 'function') {
      app.use('/api/' + name, controllers[name]);
    }
  });

  app.listen(3000, () => {
    console.log('Server running on http://localhost:3000');
  });

With include-all, you can easily manage and include multiple files without redundant code. This makes your application more modular and organized.

Hash: ed420238baf5b207887f9a9024bfb9241c1cab79e332e94d436f4459f7f86420