https://github.com/stringparser/require.dir
require folders that may have modules inside
https://github.com/stringparser/require.dir
Last synced: 11 months ago
JSON representation
require folders that may have modules inside
- Host: GitHub
- URL: https://github.com/stringparser/require.dir
- Owner: stringparser
- License: mit
- Created: 2015-08-04T11:15:57.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2015-08-04T14:06:13.000Z (over 10 years ago)
- Last Synced: 2025-02-09T22:46:21.252Z (12 months ago)
- Language: JavaScript
- Size: 121 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
# require.dir [![NPM version][badge-version]][npm][![downloads][badge-downloads]][npm]
[![build][badge-build]][travis][![engines][badge-engines]][travis-yml]
[documentation](#documentation) -
[install](#install) -
[why](#why)
Say we have the following tree
```
./folder
├── a.js
├── a.json
├── module
│ └── index.js
└── module.js
```
and each module exports its `basename`, i.e.
```js
// ./folder/a.js
module.exports = 'a';
```
then
```js
var requireDir = require('require.dir');
requireDir('./folder') // =>
{
a: 'a',
ajson: {
a: 'a'
},
module: 'module',
modulejs: 'module'
}
```
## documentation
Require directories that may or may not have modules inside.
The `basename` of each file/module is used for the exported object. When in the given directory, if so happens, are files that have the same `basename` the extension is used for that key of the exported object.
Recurse folders if passed as an option.
The caller's path is always excluded.
> Note that modules are not recursed.
> Only folders that either do not have a package.json or an index file
### spec
The `module.exports` a function
```js
function requireDir([string dirname, object options])
```
_arguments_
- `dirname`, type string optional, directory to inspect and require
- `options`, type object optional, properties are:
- `dot` whether to include `pathnames` starting with a `.dot`
- `test`, type regexp, test each `pathname` found, that is not `.dot`
- `recursive`, whether continue recursively on next folders
_defaults_
- `dirname` to the caller's directory
_when_
- `options.dot` is `falsy` dotfiles/folders are excluded
- `options.test` is `false` that `pathname` is skipped
```js
require('./folder', {test: /\.js$/}) // js files
```
_throws_
- When the first `dirname` does not exists
_returns_
- object with all the exports
## why
I've used [`require-dir`][require-dir] but wanted to have it also return `modules` by default without recursing.
## install
With [npm](http://npmjs.org)
npm install --save require.dir
### test
npm test
```
require.dir
basic
✓ should return folder exports
camelCase
✓ should camelCase folder exports
recursive
✓ should recurse folder exports given {recursive: true}
sameBasename
✓ should add lowerCase extension if basename existed
4 passing (23ms)
```
### license
[npm]: https://npmjs.org/package/require.dir
[travis]: https://travis-ci.org/stringparser/require.dir/builds
[travis-yml]: ./.travis.yml
[badge-build]: http://img.shields.io/travis/stringparser/require.dir/master.svg?style=flat-square
[require-dir]: https://npmjs.org/require-dir
[badge-engines]: https://img.shields.io/badge/engines-node%20%3E%3D%20v0.10%20%7C%7C%20iojs-blue.svg?style=flat-square
[badge-version]: http://img.shields.io/npm/v/require.dir.svg?style=flat-square
[badge-downloads]: http://img.shields.io/npm/dm/require.dir.svg?style=flat-square