Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

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

branch: master

Fetching latest commit…

Octocat-spinner-32-eaf2f5

Cannot retrieve the latest commit at this time

Octocat-spinner-32 test
Octocat-spinner-32 .gitignore
Octocat-spinner-32 .travis.yml
Octocat-spinner-32 README.md
Octocat-spinner-32 index.js duh, directories too January 17, 2014
Octocat-spinner-32 package.json
README.md

Description

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

Latest Version

1.1.0

Installation

npm install requireindex

or in package.json

{
  ...
  "dependencies": {
    "requireindex": "1.1.x"
  }
}

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]
  }
}

Build status

build status

Something went wrong with that request. Please try again.