# configurify

> Browserify transform to expose configuration to the browser

Latest version **1.0.0** (published 2014-09-30) · MIT license · 0 weekly downloads

## Install

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

## 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.0 |
| Published | 2014-09-30 |
| First published | 2014-09-30 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 (+5 in 1 direct dependencies) |
| Install scripts | no |
| Author | Felix Gnass |
| Maintainers | fgnass |
| Keywords | browserify, browserify-transform, configuration |

## Links

- npm: https://www.npmjs.com/package/configurify
- npm.io page: https://npm.io/package/configurify

## Dependencies (2)

- [through2](https://npm.io/package/through2.md) ^0.6.2
- [minimatch](https://npm.io/package/minimatch.md) ^1.0.0

## Alternatives

- [jsforce](https://npm.io/package/jsforce.md) — 851.2K weekly downloads
- [react-native-qrcode-svg](https://npm.io/package/react-native-qrcode-svg.md) — 693.5K weekly downloads
- [@salesforce/plugin-data](https://npm.io/package/@salesforce/plugin-data.md) — 394.9K weekly downloads
- [@backstage/plugin-search-common](https://npm.io/package/@backstage/plugin-search-common.md) — 308.5K weekly downloads
- [@chain-registry/types](https://npm.io/package/@chain-registry/types.md) — 38.4K weekly downloads

## Recent versions

- 1.0.0 (latest) — 2014-09-30

## README

[![Build Status](https://travis-ci.org/fgnass/configurify.svg)](https://travis-ci.org/fgnass/configurify)

# configurify

A browserify transform to expose server-side configuration options to the
browser.

### The Idea

Lets say you have a `conf` module that exposes a different set of config
options depending on its environement:

```js
var profile = process.env.NODE_CONF || 'default';

// Note the dynamic require expression:
module.exports = require('./' + profile);
```

The __configurify__ transform will require the module on the server and pass
the exported object to `JSON.stringify()`. The serialized configuration will
then be bundled by browserify and exposed to the client.

Whether the transform is applied or not depends on the modules file name. By
default all files that match the `**/conf/*` glob pattern will be transformed.

### Usage

The easiest way to use (and optionally configure) the transform is to add it to
your project's package.json:

```json
{
  "browserify": {
    "transform": [
      ["configurify", { "pattern": "**/conf/*" } ]
    ]
  }
}
```

### Async Example

Your module may also obtain its configuration asynchronously. Simply export a
function that takes a node-style callback as argument:

```js
var request = require('request');

module.exports = function(cb) {
  request.get('http://localhost:8080/config.json', function(err, res, body) {
    if (err) return cb(err);
    cb(null, JSON.parse(body));
  });
}
```

### The MIT License (MIT)

Copyright (c) 2014 Felix Gnass

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.

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