# blueconfig

> Merge and validate your config depending of your schema, forked from node-convict.

Latest version **6.2.2** (published 2020-05-03) · Apache-2.0 license · 0 weekly downloads

## Install

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

## 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 | 6.2.2 |
| Published | 2020-05-03 |
| First published | 2020-03-06 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=8 |
| Dependencies | 3 |
| Unpacked size | 77.2 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 2 |
| Maintainers | a-312 |
| Keywords | node-convict, configuration, config, schema, nested, validation, customize, yaml, json, validate |

## Links

- npm: https://www.npmjs.com/package/blueconfig
- Repository: https://github.com/A-312/node-blueconfig/tree/master/packages/blueconfig
- Homepage: https://github.com/A-312/node-blueconfig
- Issues: https://github.com/A-312/node-blueconfig/issues
- npm.io page: https://npm.io/package/blueconfig

## Dependencies (3)

- [objectpath](https://npm.io/package/objectpath.md) 2.0.0
- [yargs-parser](https://npm.io/package/yargs-parser.md) 13.0.0
- [lodash.clonedeep](https://npm.io/package/lodash.clonedeep.md) 4.5.0

## Alternatives

- [@mapbox/jsonlint-lines-primitives](https://npm.io/package/@mapbox/jsonlint-lines-primitives.md) — 5.3M weekly downloads
- [reftools](https://npm.io/package/reftools.md) — 3.5M weekly downloads
- [@hey-api/openapi-ts](https://npm.io/package/@hey-api/openapi-ts.md) — 3.5M weekly downloads
- [@mapbox/geojson-rewind](https://npm.io/package/@mapbox/geojson-rewind.md) — 2.4M weekly downloads
- [turbo-stream](https://npm.io/package/turbo-stream.md) — 1.7M weekly downloads

## Recent versions

- 6.2.2 (latest) — 2020-05-03
- 6.2.1 — 2020-05-02
- 6.2.0 — 2020-04-16
- 6.1.0 — 2020-04-09
- 6.0.2 — 2020-03-06
- 6.0.1 — 2020-03-06
- 6.0.0 — 2020-03-06

## README

# Blueconfig

[![NPM version](http://img.shields.io/npm/v/blueconfig.svg)](https://www.npmjs.org/package/blueconfig)
[![Build Status](https://travis-ci.com/A-312/node-blueconfig.svg?branch=master)](https://travis-ci.com/A-312/node-blueconfig)
[![Coverage Status](https://coveralls.io/repos/github/A-312/node-blueconfig/badge.svg?branch=master)](https://coveralls.io/github/A-312/node-blueconfig?branch=master)

Blueconfig is schema validator for your config files on production or development environment. Blueconfig merges configs and validates them depending of a pattern called *schema*. Configs can be an object or a file (json, yaml...).

Introducing a configuration schema, blueconfig gives project collaborators more **context** on each setting and enables **validation and early failures** for when configuration goes wrong.

*This is a fork of node-convict 5.x because I had lot of changes todo (more than the workflow of node-convict can process).*

# Why Blueconfig ?

 1) Merge several config in one ;
 2) Support environmental variables and Command-line arguments ;
 2) Validate your config with your schema ;
 3) Customize your schema and your validation (with custom format, type and type converter) ;
 5) Use your own file format (JSON, JSON5, YAML, TOML, XML...) ; *(JSON5 allows comment)*
 6) Only 3 dependancies (Blueconfig 7.0 will have only 2 dependancies).

**Install:** `npm install blueconfig`

# Exemple

## Schema

```yml
# Schema <blueconfig.js.org>
# database.yml
db:
  name:
    # db.name
    format: 'String'
    default: ''
  password:
    # db.password
    format: 'String'
    sensitive: true
    required: true
    env: PWD
  host:
    # db.host (require https://www.npmjs.com/package/blueconfig-format-with-validator)
    format: 'ipaddress'
    default: '127.0.0.1'
  port:
    # db.port
    format: 'port'
    default: 80
    arg: 'port'
```

See more on: https://blueconfig.js.org/

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