Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/qiwi/uniconfig
Yet another one config processor. Weird. Slow. Our own.
https://github.com/qiwi/uniconfig
js-platform pipeline
Last synced: 4 days ago
JSON representation
Yet another one config processor. Weird. Slow. Our own.
- Host: GitHub
- URL: https://github.com/qiwi/uniconfig
- Owner: qiwi
- License: mit
- Created: 2018-06-06T09:22:39.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-11-05T03:59:31.000Z (11 days ago)
- Last Synced: 2024-11-08T09:05:24.515Z (7 days ago)
- Topics: js-platform, pipeline
- Language: TypeScript
- Homepage:
- Size: 18.6 MB
- Stars: 13
- Watchers: 10
- Forks: 0
- Open Issues: 34
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# uniconfig
[](https://github.com/qiwi/uniconfig/actions/workflows/ci.yaml)
[](https://snyk.io/test/github/qiwi/uniconfig)
[](https://codeclimate.com/github/qiwi/uniconfig/maintainability)
[](https://codeclimate.com/github/qiwi/uniconfig/test_coverage)
Yet another one config processor. Weird. Slow. Our own.
## Install
```bash
npm i @qiwi/uniconfig
yarn add @qiwi/uniconfig
```
## Concept
Config is just a piece of `data` with getters. The `data` is obtained from `ISource` in some way and processed by registered `IPipe` handlers.
These operations form the `pipeline`.
> Btw, here's the next step in config evolution: [**topoconfig** 🚀](https://github.com/antongolub/misc/tree/master/packages/topoconfig/core)
## Features
* Declarative definitions
* Multiple source composition
* Modular design
* Ease extensibility
## Basic usage
```javascript
import * as path from 'path'
import { Config, rollupPlugin } from '@qiwi/uniconfig-core'
import envPlugin from '@qiwi/uniconfig-plugin-env'
import jsonPlugin from '@qiwi/uniconfig-plugin-json'
import filePlugin from '@qiwi/uniconfig-plugin-api-file'
import datatreePlugin from '@qiwi/uniconfig-plugin-datatree'
rollupPlugin(envPlugin)
rollupPlugin(jsonPlugin)
rollupPlugin(filePlugin)
rollupPlugin(datatreePlugin)
const target = path.resolve(__dirname, '../../config/default.json')
/* default.json
{
"data": {
"mode": "$env:ENVIRONMENT_PROFILE_NAME",
"server": {
"port": 8080
},
"consul": {
"host": "$env:CONSUL_AGENT_HOST",
"port": "$env:CONSUL_AGENT_PORT",
"token": "***"
}
},
"sources": {
"env": {
"pipeline": "env"
}
}
}
*/
export default new Config({
data: target,
mode: 'sync',
pipeline: 'file>json>datatree'
})
config.get('consul.host') // '10.10.10.10'
```
## Examples
* [vault](./examples/vault.md)
* [file-by-env](./examples/file-by-env-value.md)
## Plugins
##### Fetchers
* [uniconfig-plugin-api-http](./packages/uniconfig-plugin-api-http/README.md)
* [uniconfig-plugin-api-file](./packages/uniconfig-plugin-api-file/README.md)
* [uniconfig-plugin-env](./packages/uniconfig-plugin-env/README.md)
* [uniconfig-plugin-ip](./packages/uniconfig-plugin-ip/README.md)
* [uniconfig-plugin-pkg](./packages/uniconfig-plugin-pkg/README.md)
* [uniconfig-plugin-root](./packages/uniconfig-plugin-root/README.md)
* [uniconfig-plugin-global](./packages/uniconfig-plugin-global/README.md)
* [uniconfig-plugin-path](./packages/uniconfig-plugin-path/README.md)
* [uniconfig-plugin-argv](./packages/uniconfig-plugin-argv/README.md)
##### Parsers
* [uniconfig-plugin-json](./packages/uniconfig-plugin-json/README.md)
* [uniconfig-plugin-yaml](./packages/uniconfig-plugin-yaml/README.md)
* [uniconfig-plugin-datatree](./packages/uniconfig-plugin-datatree/README.md)
* [uniconfig-plugin-dotenv](./packages/uniconfig-plugin-dotenv/README.md)
##### Template engines
* [uniconfig-plugin-dot](./packages/uniconfig-plugin-dot/README.md)
##### Etc
* [uniconfig-plugin-ajv](./packages/uniconfig-plugin-ajv/README.md)
## API
### Migration from 1.x to 2.x
Update `sources` definitions. Replace `api` and `parser` fields with `pipeline`, and `target` with `data`.
```javascript
const before = {
"sources": {
"fromFile": {
"target": "",
"api": "file",
"parser": "json"
}
}
}
const after = {
"sources": {
"fromFile": {
"data": "",
"pipeline": "file>json"
}
}
}
```
#### `factory`
Produces `IConfig` instance.
```javascript
import {factory} from '@qiwi/uniconfig-core'
...
const config = factory({pipeline: 'env'}) // IConfig
```
#### `addPipe`
```javascript
import {transform} from 'lodash'
import {addPipe, context} from '@qiwi/uniconfig-core'
const formatToUpper = data => transform(
data,
(result, value, key) => result[key.toUpperCase()] = ('' + value).toUpperCase(),
{}
)
const pipe = {
handleSync(data) {
return formatToUpper(data)
},
handle(data) {
return Promise.resolve(formatToUpper(data))
}
}
addPipe('uppercase', pipe)
context.pipe.get('uppercase') //
```
#### `removePipe`
```javascript
removePipe('uppercase')
context.pipe.get('uppercase') // undefined
```
#### `rollupPlugin`
```javascript
import {addPipe, context} from '@qiwi/uniconfig-core'
import envPlugin from '@qiwi/uniconfig-plugin-env'
rollupPlugin(envPlugin)
context.pipe.get('env') //
```
#### `rollbackPlugin`
```javascript
rollbackPlugin(envPlugin)
context.pipe.get('env') // undefined
```