# rcfile

> Loads library configuration in all possible ways

Latest version **1.0.3** (published 2016-05-30) · MIT license · 0 weekly downloads

## Install

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

## 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 | 1.0.3 |
| Published | 2016-05-30 |
| First published | 2016-05-29 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=0.10 |
| Dependencies | 7 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 15 |
| Author | Zoltan Kochan |
| Maintainers | zkochan |
| Keywords | rc, config, configuration, json, yaml |

## Links

- npm: https://www.npmjs.com/package/rcfile
- Repository: https://github.com/zkochan/rcfile
- Homepage: https://github.com/zkochan/rcfile#readme
- Issues: https://github.com/zkochan/rcfile/issues
- npm.io page: https://npm.io/package/rcfile

## Dependencies (7)

- [debug](https://npm.io/package/debug.md) ^2.2.0
- [json5](https://npm.io/package/json5.md) ^0.5.0
- [js-yaml](https://npm.io/package/js-yaml.md) ^3.6.1
- [object-keys](https://npm.io/package/object-keys.md) ^1.0.9
- [path-exists](https://npm.io/package/path-exists.md) ^2.1.0
- [object-assign](https://npm.io/package/object-assign.md) ^4.1.0
- [require-uncached](https://npm.io/package/require-uncached.md) ^1.0.2

## 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

- 1.0.3 (latest) — 2016-05-30
- 1.0.2 — 2016-05-29
- 1.0.1 — 2016-05-29
- 1.0.0 — 2016-05-29

## README

# rcfile

> Loads library configuration in all possible ways

<!--@shields.flatSquare('npm', 'travis', 'coveralls')-->
[![npm version](https://img.shields.io/npm/v/rcfile.svg?style=flat-square)](https://www.npmjs.com/package/rcfile) [![Build Status](https://img.shields.io/travis/zkochan/rcfile/master.svg?style=flat-square)](https://travis-ci.org/zkochan/rcfile) [![Coverage Status](https://img.shields.io/coveralls/zkochan/rcfile/master.svg?style=flat-square)](https://coveralls.io/r/zkochan/rcfile?branch=master)
<!--/@-->

Read library configurations from `yaml`, `json`, `js` files or from sections in `package.json`.

## Installation

```sh
npm install --save rcfile
```

## Usage

```js
'use strict'
var rcfile = require('rcfile')

console.log(rcfile('eslint'))
//> { extends: 'standard',
//    rules:
//     { 'comma-dangle': [ 2, 'always-multiline' ],
//       'arrow-parens': [ 2, 'as-needed' ] } }

console.log(rcfile('travis', { configFileName: '.travis' }))
//> { language: 'node_js',
//    sudo: false,
//    node_js: [ 'v0.10', 'v4' ],
//    cache: { directories: [ 'node_modules' ] },
//    before_install: [ 'npm install -g npm@3' ],
//    install: [ 'npm install' ],
//    after_success:
//     [ 'if [[ $TRAVIS_NODE_VERSION == "v4" ]]; then npm run coveralls; fi;',
//       'if [[ $TRAVIS_NODE_VERSION == "v4" ]]; then npm run semantic-release; fi;' ] }
```

## License

[MIT](./LICENSE) © [Zoltan Kochan](http://kochan.io)

* * *

<!--@dependencies({ shield: 'flat-square' })-->
## <a name="dependencies">Dependencies</a> [![dependency status](https://img.shields.io/david/zkochan/rcfile/master.svg?style=flat-square)](https://david-dm.org/zkochan/rcfile/master)

- [debug](https://github.com/visionmedia/debug): small debugging utility
- [js-yaml](https://github.com/nodeca/js-yaml): YAML 1.2 parser and serializer
- [json5](https://github.com/aseemk/json5): JSON for the ES5 era.
- [object-assign](https://github.com/sindresorhus/object-assign): ES2015 Object.assign() ponyfill
- [object-keys](https://github.com/ljharb/object-keys): An Object.keys replacement, in case Object.keys is not available. From <https://github.com/es-shims/es5-shim>
- [path-exists](https://github.com/sindresorhus/path-exists): Check if a path exists
- [require-uncached](https://github.com/sindresorhus/require-uncached): Require a module bypassing the cache

<!--/@-->

<!--@devDependencies({ shield: 'flat-square' })-->
## <a name="dev-dependencies">Dev Dependencies</a> [![devDependency status](https://img.shields.io/david/dev/zkochan/rcfile/master.svg?style=flat-square)](https://david-dm.org/zkochan/rcfile/master#info=devDependencies)

- [chai](https://github.com/chaijs/chai): BDD/TDD assertion library for node.js and the browser. Test framework agnostic.
- [cz-conventional-changelog](https://github.com/commitizen/cz-conventional-changelog): Commitizen adapter following the conventional-changelog format.
- [eslint](https://github.com/eslint/eslint): An AST-based pattern checker for JavaScript.
- [eslint-config-standard](https://github.com/feross/eslint-config-standard): JavaScript Standard Style - ESLint Shareable Config
- [eslint-plugin-promise](https://github.com/xjamundx/eslint-plugin-promise): Enforce best practices for JavaScript promises
- [eslint-plugin-standard](https://github.com/xjamundx/eslint-plugin-standard): ESlint Plugin for the Standard Linter
- [ghooks](https://github.com/gtramontina/ghooks): Simple git hooks
- [istanbul](https://github.com/gotwarlost/istanbul): Yet another JS code coverage tool that computes statement, line, function and branch coverage with module loader hooks to transparently add coverage when running tests. Supports all JS coverage use cases including unit tests, server side functional tests
- [mocha](https://github.com/mochajs/mocha): simple, flexible, fun test framework
- [mos](https://github.com/mosjs/mos): A pluggable module that injects content into your markdown files via hidden JavaScript snippets
- [mos-plugin-readme](https://github.com/mosjs/mos-plugin-readme): A mos plugin for generating README
- [semantic-release](https://github.com/semantic-release/semantic-release): automated semver compliant package publishing
- [validate-commit-msg](https://github.com/kentcdodds/validate-commit-msg): Script to validate a commit message follows the conventional changelog standard

<!--/@-->

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