# boring-config

> Load a CSON config file

Latest version **0.3.0** (published 2014-10-03) · MIT license · 0 weekly downloads

## Install

```sh
npm install boring-config
pnpm add boring-config
yarn add boring-config
bun add boring-config
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.3.0 |
| Published | 2014-10-03 |
| First published | 2014-05-14 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=0.10 |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Mike MacCana |
| Maintainers | mikemaccana |
| Keywords | config, cson, config file |

## Links

- npm: https://www.npmjs.com/package/boring-config
- Repository: https://github.com/mikemaccana/boring-config
- Issues: https://github.com/mikemaccana/boring-config/issues
- npm.io page: https://npm.io/package/boring-config

## Dependencies (1)

- [cson](https://npm.io/package/cson.md) ^1.4.5

## Alternatives

- [jsforce](https://npm.io/package/jsforce.md) — 851.2K weekly downloads
- [react-native-qrcode-svg](https://npm.io/package/react-native-qrcode-svg.md) — 693.5K weekly downloads
- [@salesforce/plugin-data](https://npm.io/package/@salesforce/plugin-data.md) — 394.9K weekly downloads
- [@backstage/plugin-search-common](https://npm.io/package/@backstage/plugin-search-common.md) — 308.5K weekly downloads
- [@chain-registry/types](https://npm.io/package/@chain-registry/types.md) — 38.4K weekly downloads

## Recent versions

- 0.3.0 (latest) — 2014-10-03
- 0.2.4 — 2014-09-18
- 0.2.3 — 2014-09-17
- 0.2.2 — 2014-09-17
- 0.2.1 — 2014-09-15
- 0.2.0 — 2014-08-06
- 0.1.2 — 2014-05-15
- 0.1.1 — 2014-05-15
- 0.1.0 — 2014-05-14

## README

# Boring Config

[CSON](https://github.com/bevry/cson) is great for config files, with less unnecessary tokens than JSON and more consistency than YAML.

**Boring config loads a config file**. It's deliberately sync - there's no point loading your app until its config file has been parsed.

## Example

First you'll need a config file. `config.cson` is a good name for a config file:

	{
		# CSON has comments. Which is neat
		isProduction: null
		someApi:
			authKey: 'someApiKeyGoesHere' # TODO: pretty sure this isn't a real key
			userAgent: 'Mozilla/2.02Gold (Win95; I)'
		someOtherSetting: 'someValue'
	}

Then require and use it like this:

	var boringConfig = require('boring-config');

	var config = boringConfig(__dirname + '/config.cson')

Simple.

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