export-dirs

export-dirs

Export directories and their files as node.js modules.

Install with npm

npm i export-dirs --save

Usage

Pass the directory as the only argument:

module.exports = require('export-dirs')(__dirname);

Example:

Given the following directory structure:

fixtures/
  one/
    a.js
    b.js
    c.js
    // use `export-files` in this index.js
    index.js
  two/
    d.js
    e.js
    f.js
    // use `export-files` in this index.js
    index.js
  three/
    g.js
    h.js
    i.js
    // use `export-files` in this index.js
    index.js
  x.js
  y.js
  z.js
  // use `export-dirs` in this index.js
  index.js

The result would be:

// all modules are flattened onto the `_` object
{ _:
   { z: [Function],
     y: [Function],
     x: [Function],
     f: [Function],
     e: [Function],
     d: [Function],
     i: [Function],
     h: [Function],
     g: [Function],
     c: [Function],
     b: [Function],
     a: [Function] },
  // files from the same directory as export-dirs
  z: [Function],
  y: [Function],
  x: [Function],
  // directory names and the files in each exposed as modules
  two: { f: [Function], e: [Function], d: [Function] },
  three: { i: [Function], h: [Function], g: [Function] },
  one: { c: [Function], b: [Function], a: [Function] } }

Related projects

• to-exports: Create exports from a directory of non-javascript or javascript files.
• export-files: node.js utility for exporting a directory of files as modules.
• map-files: Return an object for a glob of files. Pass a rename function for the keys, or a parse function for the content, allowing it to be used for readable or require-able files.
• file-reader: Read a glob of files, dynamically choosing the reader or requiring the files based on the file extension.

Running tests

Install dev dependencies.

npm i -d && npm test

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue

Author

Jon Schlinkert

• github/jonschlinkert
• twitter/jonschlinkert

License

Copyright (c) 2015 Jon Schlinkert
Released under the MIT license

---

This file was generated by verb-cli on March 18, 2015.