browserify-extract-registry/README.md

Browserify plugin to extract a bundle's module-deps registry to a file.

# browserify-extract-registry

Export a Browserify bundle's "dependency registry," a mapping of modules to their dependencies.

## Installation

`npm install browserify-extract-registry --save`

## Usage

```
// main.js
require('./a');
require('./b');
```

```
// a.js
require('c');
```

```
// b.js
console.log('do nothing!');
```

```
// c.js
console.log('do nothing!');
```

```
const extractRegistry = require('browserify-extract-registry');

browserify()
  .add('./main.js')
  .plugin(extractRegistry, {
    outputFile: './registry.json'
  });
```

This will result in a `registry.json` like the following. (Note: Browserify assigns modules numeric IDs.)

```
{
  "1": [2, 3], // "main" requires "a" and "b"
  "2": [4] // "a" requires "c"
  "3": [] // "b" has no deps
  "4": [] // "c" has no deps
}
```

## Plugin configuration

* `outputFile` - Write the registy to the specified file path.
* `callback` - Callback. First argument is an error, and the second is the registry object.
* `validateRegistry` - Boolean. Default: `false`. Check that each module's dependency is in the registry. If not and `outputFile` is set, throws error. If not and `callback` is set, passes error as first argument.
* `sortDeps` - Boolean. Default: `false`. Sort each module's dependency array in the registry, allowing deterministic registries.

## Why does this exist?

This plugin is designed for scenarios in which you need outside access to a bundle's dependencies.

It can be used alongside [browserify-splitter](https://github.com/cperryk/browserify-splitter) to compute dependencies and generate dynamic bundles at runtime.