find-rc's Introduction

`npm install find-rc`

Find a rc file given a name. Inspiration from rc.

The rc file is assumed to be written in JavaScript, therefore the filename must be .${app}rc.js or .${app}rc.cjs or .${app}rc.mjs . If your app is named 'lab' then the rc file must be named .labrc.js (.labrc.cjs / .labrc.mjs).

Here is the order that folders will be searched:

Current directory
Parent of current directory, until the root folder is encountered
$HOME/.${app}rc.js
$HOME/.${app}rc.cjs
$HOME/.${app}rc.mjs
$HOME/.config/.${app}rc.js
$HOME/.config/.${app}rc.cjs
$HOME/.config/.${app}rc.mjs

`(appname, [startDir])`

appname - name of file you are looking for. Example: lab. It will be formatted as .{appname}rc.js
startDir - (optional) directory to start looking for the file. Defaults to process.cwd

Example

const FindRc = require('find-rc');

const filePath = FindRc('lab');
if (filePath) {
  // load file and parse configuration
  const rc = require(filePath);
}

find-rc's People

Contributors

Watchers

find-rc's Issues

Broken on Windows

Hey

This is output from running test on Windows, it is affecting lab upgrade for me due to this commit hapijs/lab@4d22872

D:\Modules\find-rc>npm t

> [email protected] pretest D:\Modules\find-rc
> npm run lint


> [email protected] lint D:\Modules\find-rc
> belly-button


Clean as a whistle! No issues found!


> [email protected] test D:\Modules\find-rc
> lab -c


<--- Last few GCs --->

   14567 ms: Mark-sweep 1379.3 (1434.9) -> 1379.2 (1434.9) MB, 248.4 / 0 ms [allocation failure] [GC in old space requested].
   14946 ms: Mark-sweep 1379.2 (1434.9) -> 1379.2 (1434.9) MB, 311.9 / 0 ms [allocation failure] [GC in old space requested].
   15254 ms: Mark-sweep 1379.2 (1434.9) -> 1379.2 (1434.9) MB, 308.0 / 0 ms [last resort gc].
   15563 ms: Mark-sweep 1379.2 (1434.9) -> 1379.2 (1434.9) MB, 308.9 / 0 ms [last resort gc].


<--- JS stacktrace --->

==== JS stack trace =========================================

Security context: 000001E8B85C9E79 <JS Object>
    2: normalize [path.js:~308] [pc=000001786FB2BEFE] (this=0000035349DFA5D1 <an Object with map 000003F9F430CBE1>,path=000002238A004101 <String[13]: D:\\.labrc.js>)
    3: join [path.js:~458] [pc=000001786FB44320] (this=0000035349DFA5D1 <an Object with map 000003F9F430CBE1>)
    4: arguments adaptor frame: 2->0
    5: dirPaths [D:\Modules\find-rc\node_modules\find-rc\lib\index.js:~44] [pc=00...

FATAL ERROR: CALL_AND_RETRY_LAST Allocation failed - JavaScript heap out of memory
npm ERR! Test failed.  See above for more details.