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) {
const rc = require(filePath);
}