Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/data7expressions/config-extends
Allow to extend json or yaml/json files configuration
https://github.com/data7expressions/config-extends
config configuration extend json json-files yaml yaml-configuration
Last synced: 2 months ago
JSON representation
Allow to extend json or yaml/json files configuration
- Host: GitHub
- URL: https://github.com/data7expressions/config-extends
- Owner: data7expressions
- License: mit
- Created: 2020-12-08T04:22:24.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-09-02T07:18:53.000Z (5 months ago)
- Last Synced: 2024-11-15T21:45:51.172Z (3 months ago)
- Topics: config, configuration, extend, json, json-files, yaml, yaml-configuration
- Language: TypeScript
- Homepage:
- Size: 802 KB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Config Extends
Allow to extend json or yaml/json files configuration
## Features
- Multiple extension
- Can be loaded from yaml or json files
- Can load from a directory including all its files
- Available from browser and node.js
- CLI
## Methods
### .extends(source,...args) [synchronously]
This api allows to extend one or more json objects
- Params:
- source : object with extensions defined
- args : others sources
### .apply(source,target) [asynchronous]
This api allows to extend configuration from a file or several files from a path
- Params:
- source : path of file or folder
- target : file result (optional)
Note: Only node.js
## Installation
### module for node.js
```Shell
npm install config-extends
```
### CLI executable
If you want to extends from CLI, install config-extends globally:
```Shell
npm install -g config-extends
```
## Usage
### From library for node.js
```javascript
const ConfigExtends = require("config-extends")
let source ={
data : {_extends:'base',d:3,e:4},
base: {a:1,b:2}
};
let config = ConfigExtends.extends(source);
console.log(JSON.stringify(config,null,2));
```
### From library for browsers
```javascript
let source ={
data : {_extends:'base',d:3,e:4},
base: {a:1,b:2}
};
let config = ConfigExtends.extends(source);
console.log(JSON.stringify(config,null,2));
```
### From CLI
extends
```shell
usage: config-extends extends -s
arguments:
-s, --source Input json (serialized).
```
apply
```shell
usage: config-extends apply -s [-t]
arguments:
-s, --source Input path of folder or file.
-t, --target output file (optional).
```
## Examples
### Simple extension
```javascript
let source ={
data : {_extends:'base',d:3,e:4},
base: {a:1,b:2}
};
let config = ConfigExtends.extends(source);
console.log(JSON.stringify(config,null,2));
```
result:
```json
{
"data": {"d": 3,"e": 4,"a": 1,"b": 2 },
"base": {"a": 1,"b": 2}
}
```
### Chain extension
```javascript
let source ={
data: { 1: {_extends:'base',d:3,e:4},
2: {_extends:'data.1', f:3,g:4},
},
base: {a:1,b:2}
}
let config = ConfigExtends.extends(source);
console.log(JSON.stringify(config,null,2));
```
result:
```json
{
"data": {
"1":{"d": 3,"e": 4,"a": 1,"b": 2 },
"2":{"f": 3,"g": 4,"d": 3,"e": 4,"a": 1,"b": 2}
},
"base": {"a": 1,"b": 2}
}
```
### Multiple extension
```javascript
let source ={
data: { 1: {_extends:'base',d:3,e:4},
2: {_extends:['base','base2'], f:3,g:4},
},
base: {a:1,b:2},
base2: {h:'a',i:'b'}
};
let config = ConfigExtends.extends(source);
console.log(JSON.stringify(config,null,2));
```
result:
```json
{
"data": {
"1": {"d": 3,"e": 4,"a": 1,"b": 2},
"2": {"f": 3,"g": 4,"a": 1,"b": 2,"h": "a","i": "b"}
},
"base": {"a": 1,"b": 2 },
"base2": {"h": "a","i": "b"}
}
```
### apply from path
```javascript
let config = await ConfigExtends.apply(path.join(__dirname,'test-1'));
console.log(JSON.stringify(config,null,2));
```
structure folder
- test-1
- folder1
- file1.yaml content => c: 3
- folder2
- file1.yaml content => _extends: [file,folder1.file1]
d: 1
- file2.yaml content => _extends: folder2.file1
e: 1
- file.yaml content => a: 1
b: "b"
result
```json
{
"file": { "a": 1, "b": "b" },
"folder1": { "file1": { "c": 3 } },
"folder2": {
"file1": { "d": 1, "a": 1, "b": "b", "c": 3 },
"file2": { "e": 1, "d": 1, "a": 1, "b": "b", "c": 3 }
}
}
```
### apply from path CLI
```shell
config-extends apply -s ./test/test-1
```
result:
```json
{
"file": { "a": 1, "b": "b" },
"folder1": { "file1": { "c": 3 } },
"folder2": {
"file1": { "d": 1, "a": 1, "b": "b", "c": 3 },
"file2": { "e": 1, "d": 1, "a": 1, "b": "b", "c": 3 }
}
}
```
### apply from single file
```javascript
let config = await configExtends.apply(path.join(__dirname,'raspberry.yaml'));
console.log(JSON.stringify(config.version,null,2));
```
raspberry.yaml
```yaml
version:
PiA:
_extends: [family.Pi, model.A]
PiB:
_extends: [family.Pi, model.B]
PiA+:
_extends: [family.Pi, model.A]
measure:
_extends: measure.compact
PiB+:
_extends: [family.Pi, model.B]
Pi2B:
measure:
_extends: measure.standard
Pi3A:
_extends: [family.Pi3, model.A]
Pi3A+:
_extends: [family.Pi3, model.A]
Pi3B+:
_extends: [family.Pi3, model.B]
Pi4B1G:
_extends: family.Pi4
memory: 1G
Pi4B2G:
_extends: family.Pi4
memory: 2G
Pi4B4G:
_extends: family.Pi4
memory: 4G
Pi4B8G:
_extends: family.Pi4
memory: 8G
family:
Pi:
wireless: false
measure:
_extends: measure.standard
Pi3:
wireless: true
measure:
_extends: measure.standard
Pi4:
_extends: [model.B]
wireless: true
measure:
_extends: measure.standard
model:
A:
ethernet: false
B:
ethernet: true
measure:
standard:
high: 85.6
long: 56.5
compact:
high: 65
long: 56.5
```
result:
```yaml
{
"PiA": {"wireless": false,"measure": {"high": 85.6,"long": 56.5 },"ethernet": false},
"PiB": {"wireless": false,"measure": {"high": 85.6,"long": 56.5 },"ethernet": true },
"PiA+": {"measure": {"high": 85.6,"long": 56.5},"wireless": false,"ethernet": false },
"PiB+": {"wireless": false,"measure": {"high": 85.6,"long": 56.5},"ethernet": true },
"Pi2B": {"measure": {"high": 85.6,"long": 56.5}},
"Pi3A": {"wireless": true,"measure": {"high": 85.6,"long": 56.5},"ethernet": false },
"Pi3A+":{"wireless": true,"measure": {"high": 85.6,"long": 56.5},"ethernet": false },
"Pi3B+":{"wireless": true,"measure": {"high": 85.6,"long": 56.5},"ethernet": true },
"Pi4B1G":{"memory": "1G","wireless": true,"measure": {"high": 85.6,"long": 56.5},"ethernet": true},
"Pi4B2G":{"memory": "2G","wireless": true,"measure": {"high": 85.6,"long": 56.5},"ethernet": true},
"Pi4B4G":{"memory": "4G","wireless": true,"measure": {"high": 85.6,"long": 56.5 },"ethernet": true},
"Pi4B8G": {"memory": "8G","wireless": true,"measure": {"high": 85.6,"long": 56.5 },"ethernet": true}
}
```
## Test
```Shell
npm run test
```