# rc-parser > Find and parse rc, rc.js, rc.yaml or etc if any one of them exists Latest version **1.0.2** (published 2018-08-03) · MIT license · 0 weekly downloads ## Install ```sh npm install rc-parser pnpm add rc-parser yarn add rc-parser bun add rc-parser ``` ## 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.2 | | Published | 2018-08-03 | | First published | 2018-08-03 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | none | | Module format | CommonJS | | Node | >= 6 | | Dependencies | 6 | | Unpacked size | 12.9 KB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 1 | | Author | kaelzhang | | Maintainers | kael | | Keywords | rc-parser, eslintrc, rc.js, rc.yaml, runtime-config, rc, read, parser, finder | ## Links - npm: https://www.npmjs.com/package/rc-parser - Repository: https://github.com/kaelzhang/rc-parser - Homepage: https://github.com/kaelzhang/rc-parser#readme - Issues: https://github.com/kaelzhang/rc-parser/issues - npm.io page: https://npm.io/package/rc-parser ## Dependencies (6) - [json5](https://npm.io/package/json5.md) ^1.0.1 - [js-yaml](https://npm.io/package/js-yaml.md) ^3.12.0 - [make-array](https://npm.io/package/make-array.md) ^1.0.5 - [promise-faker](https://npm.io/package/promise-faker.md) ^1.2.5 - [promise.extra](https://npm.io/package/promise.extra.md) ^3.0.1 - [@babel/code-frame](https://npm.io/package/@babel/code-frame.md) ^7.0.0-beta.55 ## Alternatives - [babylon](https://npm.io/package/babylon.md) — 5.1M weekly downloads - [csscolorparser](https://npm.io/package/csscolorparser.md) — 3.7M weekly downloads - [expr-eval-fork](https://npm.io/package/expr-eval-fork.md) — 1.5M weekly downloads - [@leeoniya/ufuzzy](https://npm.io/package/@leeoniya/ufuzzy.md) — 247.7K weekly downloads - [xml-parser](https://npm.io/package/xml-parser.md) — 78.4K weekly downloads ## Recent versions - 1.0.2 (latest) — 2018-08-03 - 0.0.0 — 2018-08-03 ## README [![Build Status](https://travis-ci.org/kaelzhang/rc-parser.svg?branch=master)](https://travis-ci.org/kaelzhang/rc-parser) [![Coverage](https://codecov.io/gh/kaelzhang/rc-parser/branch/master/graph/badge.svg)](https://codecov.io/gh/kaelzhang/rc-parser) # rc-parser Find and parse rc, rc.js, rc.yaml or etc if any one of them exists. `rc-parser` searches the giving path(s), and parses out that if the runtime configuration file with the certain extension listed in `options.extensions` exists. If found, it parses and returns the config object. `rc-parser` featured in: - Supports to define custom parser for a certain file type. - Better error messages and syntax hint. - Fully customizable. ## Install ```sh $ npm i rc-parser ``` ## Usage ```js const parse = require('rc-parser') const sync = require('rc-parser/sync') // The synchronous version const options = { path: __dirname, // current directory name: '.travis' } const rc = await parse(options) console.log(rc.extension) // 'yml' console.log(rc.value.language) // 'node_js' console.log(sync(options)) // the same as rc ``` ### Define your own parsers to support more file types ```js const ini = require('ini') parse({ path: '/path/to', name: 'somerc', extensions: ['ini', 'js'], parsers: { ini (content) { return ini.parse(content) } } }) .then(({extension, value}) => { console.log(extension) // 'ini' console.log(value) // the parsed object from ini }) ``` ## APIs ### parse(options): Promise<RCResult> - **options** - **path** `string | Array` the search path(s) for the rc file. - **name** `string` the prefix name of the rc file to search. - **extensions** `Extensions | undefined` - **parsers** `Object{[Extension]: ParserFunction}` - **not_found_error** `NotFoundErrorFunction` will be executed if no rc files are found. - **code_frame** `CodeFrameFunction | false` Returns `Promise` ```ts type Extension = string | parse.NO_EXT type Extensions = Array ``` `options.extensions` specifies the extension priority for searching rc files. Defaults to `['yaml', 'yml', 'js', parse.NO_EXT]` `parse.NO_EXT` is a special extension which indicates there is no extension after `name` ```sh # Suppose: options.name === '.eslintrc' # filepath | extension # ------------------------- | ----------------- /path/to/project |-- .eslintrc # rc-parser.NO_EXT |-- .eslintrc.js # 'js' |-- .eslintrc.yaml # 'yaml' ``` If `options.extensions` as `['yaml', 'js', NO_EXT]`, then we will get `.eslintrc.yaml`. Similarly, `['js', 'yaml', NO_EXT]` => `.eslintrc.js` ```ts interface RCResult { extension: string; abspath: string; value: object; } ``` - **extension** the extension string of the found rc file, excluding `.` - **value** the parsed value - **abspath** the absolute path of the rc file. ```ts function ParserFunction (object: { content: string, filepath: string, abspath: string, extension: string }): object throws ParserError ``` - **content** the content of the rc file - **filepath** the filepath relative to the current search path Parses the content of rc files, returns the parsed object, or throws error if there is a parse error. ```ts interface ParserError extends Error { line?: number; column?: number; } ``` If the error (`ParserError`) thrown by `ParserFunction` contains both the `line` property and the `column` property, the `error.message` will be argumented by `CodeFrameFunction` ```ts interface Location { line: number; column: number; } function CodeFrameFunction ( rawLines: string, loc: Location ): string ``` ```ts function NotFoundErrorFunction ( paths: Array, extensions: Extensions ): Error ``` ### sync(options): RCResult - **options** the same as `options` of `parse(options)` ## Built-in parsers ```js parse.PARSERS. ``` ### yaml, yml Based on [`js-yaml`](https://npmjs.org/package/js-yaml) ### json Based on [`json5`](https://npmjs.org/package/json5) ## License MIT --- _Source: https://npm.io/package/rc-parser · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._