# rir

> Recursively iterates over specified directory, require()'ing each file, and returning a nested hash structure containing those modules.

Latest version **1.0.11** (published 2019-12-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install rir
pnpm add rir
yarn add rir
bun add rir
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.11 |
| Published | 2019-12-07 |
| First published | 2019-02-01 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=0.10.0 |
| Dependencies | 0 |
| Unpacked size | 61.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | hi.owen.luke@gmail.com |
| Maintainers | owenluke |
| Keywords | require, directory, library, recursive |

## Links

- npm: https://www.npmjs.com/package/rir
- Repository: https://github.com/hiowenluke/rir
- Issues: http://github.com/hiowenluke/rir/issues/
- npm.io page: https://npm.io/package/rir

## Recent versions

- 1.0.11 (latest) — 2019-12-07
- 1.0.10 — 2019-12-07
- 1.0.9 — 2019-11-26
- 1.0.8 — 2019-05-17
- 1.0.7 — 2019-05-17
- 1.0.6 — 2019-03-08
- 1.0.5 — 2019-03-08
- 1.0.4 — 2019-03-05
- 1.0.3 — 2019-03-02
- 1.0.2 — 2019-02-19
- 1.0.1 — 2019-02-08
- 1.0.0 — 2019-02-01

## README

# Rir

Recursively iterates over specified directory, `require()`'ing each file, and returning a nested hash structure containing those modules.  (Forks from: [node-require-directory](https://github.com/troygoode/node-require-directory))

Rir means **R**equ**ir**eD**ir**ectory.




## How To Use

### Installation (via [npm](https://npmjs.org/package/rir))

```bash
$ npm install rir
```

### Usage

A common pattern in node.js is to include an index file which creates a hash of the files in its current directory. Given a directory structure like so:
```
app.js
routes/
  index.js
  home.js
  auth/
    login.js
    logout.js
    register.js

```

`routes/index.js` uses `rir` to build the hash (rather than doing so manually) like so:

```javascript
var requireDirectory = require('rir');
module.exports = requireDirectory(module);
```

`app.js` references `routes/index.js` like any other module, but it now has a hash/tree of the exports from the `./routes/` directory:

```javascript
var routes = require('./routes');

// snip

app.get('/', routes.home);
app.get('/register', routes.auth.register);
app.get('/login', routes.auth.login);
app.get('/logout', routes.auth.logout);
```

The `routes` variable above is the equivalent of this:

```javascript
var routes = {
  home: require('routes/home.js'),
  auth: {
    login: require('routes/auth/login.js'),
    logout: require('routes/auth/logout.js'),
    register: require('routes/auth/register.js')
  }
};
```

*Note that `routes.index` will be `undefined` as you would hope.*

### Specifying Another Directory

You can specify which directory you want to build a tree of (if it isn't the current directory for whatever reason) by passing it as the second parameter. Not specifying the path (`requireDirectory(module)`) is the equivelant of `requireDirectory(module, __dirname)`:

```javascript
var requireDirectory = require('rir');
module.exports = requireDirectory(module, './some/subdirectory');
```

For example, in the [example in the Usage section](#usage) we could have avoided creating `routes/index.js` and instead changed the first lines of `app.js` to:

```javascript
var requireDirectory = require('rir');
var routes = requireDirectory(module, './routes');
```

## Options

You can pass an options hash to `rir` as the 2nd parameter (or 3rd if you're passing the path to another directory as the 2nd parameter already). Here are the available options:

### Whitelisting

Whitelisting (either via RegExp or function) allows you to specify that only certain files be loaded.

```javascript
var requireDirectory = require('rir'),
  whitelist = /onlyinclude.js$/,
  hash = requireDirectory(module, {include: whitelist});
```

```javascript
var requireDirectory = require('rir'),
  check = function(path){
    if(/onlyinclude.js$/.test(path)){
      return true; // go ahead and include
    }else{
      return false; // don't include
    }
  },
  hash = requireDirectory(module, {include: check});
```

### Blacklisting

Blacklisting (either via RegExp or function) allows you to specify that all but certain files should be loaded.

```javascript
var requireDirectory = require('rir'),
  blacklist = /dontinclude\.js$/,
  hash = requireDirectory(module, {exclude: blacklist});
```

```javascript
var requireDirectory = require('rir'),
  check = function(path){
    if(/dontinclude\.js$/.test(path)){
      return false; // don't include
    }else{
      return true; // go ahead and include
    }
  },
  hash = requireDirectory(module, {exclude: check});
```

### Visiting Objects As They're Loaded

`rir` takes a function as the `visit` option that will be called for each module that is added to module.exports.

```javascript
var requireDirectory = require('rir'),
  visitor = function(obj) {
    console.log(obj); // will be called for every module that is loaded
  },
  hash = requireDirectory(module, {visit: visitor});
```

The visitor can also transform the objects by returning a value:

```javascript
var requireDirectory = require('rir'),
  visitor = function(obj) {
    return obj(new Date());
  },
  hash = requireDirectory(module, {visit: visitor});
```

### Renaming Keys

```javascript
var requireDirectory = require('rir'),
  renamer = function(name) {
    return name.toUpperCase();
  },
  hash = requireDirectory(module, {rename: renamer});
```

### No Recursion

```javascript
var requireDirectory = require('rir'),
  hash = requireDirectory(module, {recurse: false});
```

## Run Unit Tests

```bash
$ npm run lint
$ npm test
```

## License

[MIT License](http://www.opensource.org/licenses/mit-license.php)

## Author

[Troy Goode](https://github.com/TroyGoode) ([troygoode@gmail.com](mailto:troygoode@gmail.com))
[Owen Luke](https://github.com/hiowenluke) ([hi.owen.luke@gmail.com](mailto:hi.owen.luke@gmail.com))

---
_Source: https://npm.io/package/rir · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._