Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/nhz-io/gulp-stream-config

Merge JSON/CSON files and resolve references
https://github.com/nhz-io/gulp-stream-config

Last synced: 3 days ago
JSON representation

Merge JSON/CSON files and resolve references

Awesome Lists containing this project

README

        

@nhz.io/gulp-stream-config



NPM Version


Bithound Status


License


Downloads

Merge and resolve JSON/CSON references

## Install
```
npm i -S @nhz.io/gulp-stream-config
```

## Reference resolution is done with [ref-resolve](https://github.com/nhz-io/ref-resolve)

## Example

### Load configuration from multiple files
```javascript
/** +-+- config
* |
* +--- a.cson
* +--- b.cson
* +--- c.cson
*/

const gulp = require('gulp')
const conf = require('@nhz-io/gulp-stream-config')
const config = {}
const unresolved = []

gulp.task('config', () =>
gulp.src('config/*.cson').pipe(conf(config, unresolved))
)

/** After runing config task the configuration
* will be in `config` and unresolved references
* will be in `unresolved`.
* Also, a warning will be shown for each unresolved match
*/
```

## License

### [MIT](LICENSE)