Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jonschlinkert/merge-configs
Find, load and merge JSON and YAML config settings from one or more files, in the specified order.
https://github.com/jonschlinkert/merge-configs
combine conf config configuration data eslint find jonschlinkert lookup merge namespace node nodejs object package rc runtime-config search store
Last synced: about 1 month ago
JSON representation
Find, load and merge JSON and YAML config settings from one or more files, in the specified order.
- Host: GitHub
- URL: https://github.com/jonschlinkert/merge-configs
- Owner: jonschlinkert
- License: mit
- Created: 2017-05-28T20:41:17.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-11-19T15:36:23.000Z (almost 6 years ago)
- Last Synced: 2024-07-10T18:17:13.756Z (2 months ago)
- Topics: combine, conf, config, configuration, data, eslint, find, jonschlinkert, lookup, merge, namespace, node, nodejs, object, package, rc, runtime-config, search, store
- Language: JavaScript
- Homepage: https://github.com/jonschlinkert
- Size: 29.3 KB
- Stars: 12
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: .github/contributing.md
- License: LICENSE
Awesome Lists containing this project
README
# merge-configs [](https://www.npmjs.com/package/merge-configs) [](https://npmjs.org/package/merge-configs) [](https://npmjs.org/package/merge-configs) [](https://travis-ci.org/jonschlinkert/merge-configs)
> Find, load and merge JSON and YAML config settings from one or more files, in the specified order.
Please consider following this project's author, [Jon Schlinkert](https://github.com/jonschlinkert), and consider starring the project to show your :heart: and support.
## Install
Install with [npm](https://www.npmjs.com/):
```sh
$ npm install --save merge-configs
```
### What does this do?
This library makes it easy for your application to support config files similar to `.eslintrc.json`, `.travis.yml`, etc. by providing granular control over:
* the patterns and directories to search for config files
* how config files are loaded (or whether or not they should be loaded at all)
* which config files are merged, and how they are merged
## Usage
```js
const configs = require('merge-configs');
console.log(configs(name[, locations, options]));
```
## options
### options.builtins
**Type**: `boolean`
**Default**: `undefined`
Disable built-in loaders.
```js
const mergeConfig = new MergeConfig({
options: {
builtins: false
}
});
```
### options.filter
**Type**: `function`
**Default**: `undefined`
Filter files that are resolved by glob patterns. Useful for conditionally filtering out files based on contents or other variables.
```js
// can be defined on the ctor options
const mergeConfig = new MergeConfig({
options: {
filter: file => {
// "file" is an object with path properties
return file.basename === 'foo.json'
}
}
});
// or on the options for a specific config type
mergeConfig.type('local', {
cwd: process.cwd(),
patterns: ['*.json'],
filter: file => {
return file.basename !== 'foo.json';
}
});
```
### Params
* `name` **{String}** - (required) The module name (example: `eslint`, `babel`, `travis` etc)
* `types` **{Array}** - (optional) The [config locations](#config-locations) or "types" to search. If specified, only the given locations will be searched. If undefined, all locations are searched.
* `options` **{Object}** - see all [available options](#options)
## About
Contributing
Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).
Please read the [contributing guide](.github/contributing.md) for advice on opening issues, pull requests, and coding standards.
Running Tests
Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:
```sh
$ npm install && npm test
```
Building docs
_(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_
To generate the readme, run the following command:
```sh
$ npm install -g verbose/verb#dev verb-generate-readme && verb
```
### Author
**Jon Schlinkert**
* [GitHub Profile](https://github.com/jonschlinkert)
* [Twitter Profile](https://twitter.com/jonschlinkert)
* [LinkedIn Profile](https://linkedin.com/in/jonschlinkert)
### License
Copyright © 2018, [Jon Schlinkert](https://github.com/jonschlinkert).
Released under the [MIT License](LICENSE).
***
_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.8.0, on November 19, 2018._