# rc-yaml

> Extend the RC module with YAML parsing

Latest version **2.0.0** (published 2017-03-20) · MIT license · 0 weekly downloads

## Install

```sh
npm install rc-yaml
pnpm add rc-yaml
yarn add rc-yaml
bun add rc-yaml
```

## 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 | 2.0.0 |
| Published | 2017-03-20 |
| First published | 2015-07-23 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=6 |
| Dependencies | 4 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Christopher Hiller |
| Maintainers | boneskull |
| Keywords | rc, yaml, yml, config, configfile |

## Links

- npm: https://www.npmjs.com/package/rc-yaml
- Repository: https://github.com/boneskull/rc-yaml
- Homepage: https://github.com/boneskull/rc-yaml#readme
- Issues: https://github.com/boneskull/rc-yaml/issues
- npm.io page: https://npm.io/package/rc-yaml

## Dependencies (4)

- [rc](https://npm.io/package/rc.md) ^1.1.7
- [ini](https://npm.io/package/ini.md) ^1.3.4
- [js-yaml](https://npm.io/package/js-yaml.md) ^3.8.2
- [strip-json-comments](https://npm.io/package/strip-json-comments.md) ^2.0.1

## Alternatives

- [monaco-yaml](https://npm.io/package/monaco-yaml.md) — 420.1K weekly downloads
- [@crewx/workflow](https://npm.io/package/@crewx/workflow.md) — 3.1K weekly downloads
- [yaml-cat](https://npm.io/package/yaml-cat.md) — 38 weekly downloads
- [nunjucks-in-yaml](https://npm.io/package/nunjucks-in-yaml.md) — 9 weekly downloads
- [shopify-symlinks](https://npm.io/package/shopify-symlinks.md) — 3 weekly downloads

## Recent versions

- 2.0.0 (latest) — 2017-03-20
- 1.0.0 — 2016-06-13
- 0.1.0 — 2015-07-23

## README

# rc-yaml

rc + YAML - INI = this module 

This module cannibalizes the [**rc**](https://www.npmjs.com/package/rc) module and tries to parse a [YAML](http://yaml.org) "rc" file, in addition to JSON and INI formats.
 
## Key Differences Between this and **rc**
   
- Well, if the "rc" file is not JSON, we try YAML, then fall back to INI.
- Since there's crossover between INI and YAML, we choose YAML if the YAML parser doesn't return a `String` value.  So, if we end up with a `String`, we call it INI.  The end. 

## Usage

```js
var rc = require('rc-yaml');

var config = rc('name', {
  defaults: 'go here'
});
```

Custom parsers are still supported. See [**rc**'s `README.md`](https://github.com/dominictarr/rc/blob/master/README.md) for full usage.

If you just want the parsing function for some reason, it's accessible via:

```js
var parser = require('rc-yaml').parser;
```

## A Note About Peer Dependencies

This module *depends on* the **rc** module, which means installing them both side-by-side is unnecessary.  One or the other, people.

Using `peerDependencies` here may be more politically correct, but at a cost.  Since **rc** is "for lazy people", when in Rome...

## Author, Somewhat

[Christopher Hiller](https://boneskull.com)

## License

MIT

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