rc-config-loader 2.0.3 → 4.0.0

package/README.md

@@ -1,4 +1,4 @@
-# rc-config-loader [![Build Status](https://travis-ci.org/azu/rc-config-loader.svg?branch=master)](https://travis-ci.org/azu/rc-config-loader)
+# rc-config-loader [![Actions Status: test](https://github.com/azu/rc-config-loader/workflows/test/badge.svg)](https://github.com/azu/rc-config-loader/actions?query=workflow%3A"test")
 
 Load config from `.{product}rc.{json,yml,js}` file.
 
@@ -26,6 +26,10 @@ Find and load a configuration object from:
 
 - <del>Sync loading</del>
     - [cosmiconfig@3+](https://github.com/davidtheclark/cosmiconfig/blob/master/CHANGELOG.md#300) support `sync` option
+- <del>Built-in TypeScript support</del>
+    - [comisconfig@6*](https://github.com/davidtheclark/cosmiconfig/blob/master/CHANGELOG.md#600) is written by TypeScript
+
+If you want to async support and customize loader, recommended to use [cosmiconfig](https://github.com/davidtheclark/cosmiconfig).
 
 ## Install
 
@@ -40,34 +44,75 @@ Install with [npm](https://www.npmjs.com/):
 ```ts
 export interface rcConfigLoaderOption {
     // does look for `package.json`
-    packageJSON?: boolean,
+    packageJSON?:
+        | boolean
+        | {
+              fieldName: string;
+          };
     // if config file name is not same with packageName, set the name
     configFileName?: string;
     // treat default(no ext file) as some extension
-    defaultExtension?: string | string[],
+    defaultExtension?: string | string[];
     // where start to load
     cwd?: string;
 }
-export default function rcConfigLoader(packageName: string, options?: rcConfigLoaderOption): Object;
+/**
+ * Find and load rcfile, return { config, filePath }
+ * If not found any rcfile, throw an Error.
+ * @param {string} pkgName
+ * @param {rcConfigLoaderOption} [opts]
+ * @returns {{ config: Object, filePath:string } | undefined}
+ */
+export declare function rcFile<R extends {}>(pkgName: string, opts?: rcConfigLoaderOption): {
+    config: R;
+    filePath: string;
+} | undefined;
+
 ```
 
-`rcConfigLoader` return `{ config, filePath }` object.
+`rcFile` return `{ config, filePath }` object.
 
 - `config`: it is config object
 - `filePath`: absolute path to config file
 
-If not found config file, return `undefined`.
+**Note:**
+ 
+- `rcFile` function return `undefined` if the config file is not found
+- `rcFile` throw an Error if the config file content is malformed (causing a parsing error)
+
+Recommenced usage:
+
+```js
+import { rcFile } from "rc-config-loader"
+
+function loadRcFile(rcFileName){
+    try {
+        const results = rcFile(rcFileName);
+        // Not Found
+        if (!results) {
+            return {};
+        }
+        return results.config;
+    } catch (error) {
+        // Found it, but it is parsing error
+        return {} ; // default value
+    }
+}
+// load config
+const config = loadRcFile("your-application");
+console.log(config); // => rcfile content
+```
 
 ### Example
 
 ```js
 "use strict";
-const rcfile = require("rc-config-loader");
+import { rcFile } from "rc-config-loader"
 // load .eslintrc from current dir
-console.log(rcfile("eslint"));
+console.log(rcFile("eslint"));
 
 // load .eslintrc from specific path
-console.log(rcfile("eslint", {
+console.log(rcFile("eslint", {
     configFileName: `${__dirname}/test/fixtures/.eslintrc`
 }));
 /*
@@ -79,7 +124,7 @@ filePath: ${__dirname}/test/fixtures/.eslintrc
  */
 
 // load property from pacakge.json
-console.log(rcfile("rc-config-loader", {
+console.log(rcFile("rc-config-loader", {
     packageJSON: {
         fieldName: "directories"
     }
@@ -90,27 +135,30 @@ filePath: /path/to/package.json
  */
 
 // load .eslintrc from specific dir
-console.log(rcfile("eslint", {
+console.log(rcFile("eslint", {
     cwd: `${__dirname}/test/fixtures`
 }));
 
 // load specific filename from current dir
-console.log(rcfile("travis", {configFileName: ".travis"}));
+console.log(rcFile("travis", {configFileName: ".travis"}));
 /*
 config: { sudo: false, language: 'node_js', node_js: 'stable' }
 filePath: /path/to/.travis
  */
 
 // try to load as .json, .yml, js
-console.log(rcfile("bar", {
+console.log(rcFile("bar", {
     configFileName: `${__dirname}/test/fixtures/.barrc`,
     defaultExtension: [".json", ".yml", ".js"]
 }));
 
-// try to load as .yml, but it is not json
-// throw Error
+// try to load as foobar, but .foobarrc is not found
+console.log(rcFile("foorbar")); // => undefined
+
+// try to load as .json, but it is not json
+// throw SyntaxError
 try {
-    rcfile("unknown", {
+    rcFile("unknown", {
         // This is not json
         configFileName: `${__dirname}/test/fixtures/.unknownrc`,
         defaultExtension: ".json"
@@ -121,7 +169,6 @@ try {
     SyntaxError: Cannot read config file: /test/fixtures/.unknownrc
     */
 }
-
 ```
 
 ## Users

package/lib/rc-config-loader.d.ts

@@ -1,11 +1,19 @@
 export interface rcConfigLoaderOption {
-    // does look for `package.json`
-    packageJSON?: boolean;
-    // if config file name is not same with packageName, set the name
+    packageJSON?: boolean | {
+        fieldName: string;
+    };
     configFileName?: string;
-    // treat default(no ext file) as some extension
     defaultExtension?: string | string[];
-    // where start to load
     cwd?: string;
 }
-export default function rcConfigLoader(packageName: string, options?: rcConfigLoaderOption): Object;
+/**
+ * Find and load rcfile, return { config, filePath }
+ * If not found any rcfile, throw an Error.
+ * @param {string} pkgName
+ * @param {rcConfigLoaderOption} [opts]
+ * @returns {{ config: Object, filePath:string } | undefined}
+ */
+export declare function rcFile<R extends {}>(pkgName: string, opts?: rcConfigLoaderOption): {
+    config: R;
+    filePath: string;
+} | undefined;

package/lib/rc-config-loader.js

@@ -1,185 +1,172 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.rcFile = void 0;
 // MIT © 2017 azu
 // MIT © Zoltan Kochan
 // Original https://github.com/zkochan/rcfile
-"use strict";
-
-var _typeof = typeof Symbol === "function" && typeof Symbol.iterator === "symbol" ? function (obj) { return typeof obj; } : function (obj) { return obj && typeof Symbol === "function" && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; };
-
-var path = require("path");
-var debug = require("debug")("rc-config-loader");
-var requireFromString = require("require-from-string");
-var JSON5 = require("json5");
-var fs = require("fs");
-var pathExists = require("path-exists");
-var objectAssign = require("object-assign");
-var keys = require("object-keys");
-
-var defaultLoaderByExt = {
+const path_1 = __importDefault(require("path"));
+const fs_1 = __importDefault(require("fs"));
+const require_from_string_1 = __importDefault(require("require-from-string"));
+const json5_1 = __importDefault(require("json5"));
+const debug = require("debug")("rc-config-loader");
+const defaultLoaderByExt = {
     ".js": loadJSConfigFile,
     ".json": loadJSONConfigFile,
     ".yaml": loadYAMLConfigFile,
-    ".yml": loadYAMLConfigFile
+    ".yml": loadYAMLConfigFile,
 };
-
-var defaultOptions = {
+const defaultOptions = {
     // does look for `package.json`
     packageJSON: false,
     // treat default(no ext file) as some extension
     defaultExtension: [".json", ".yaml", ".yml", ".js"],
-    cwd: process.cwd()
+    cwd: process.cwd(),
+};
+const selectLoader = (defaultLoaderByExt, extension) => {
+    if (![".json", ".yaml", ".yml", ".js"].includes(extension)) {
+        throw new Error(`${extension} is not supported.`);
+    }
+    return defaultLoaderByExt[extension];
 };
-
 /**
+ * Find and load rcfile, return { config, filePath }
+ * If not found any rcfile, throw an Error.
  * @param {string} pkgName
  * @param {rcConfigLoaderOption} [opts]
  * @returns {{ config: Object, filePath:string } | undefined}
  */
-module.exports = function rcConfigLoader(pkgName) {
-    var opts = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
-
+function rcFile(pkgName, opts = {}) {
     // path/to/config or basename of config file.
-    var configFileName = opts.configFileName || "." + pkgName + "rc";
-    var defaultExtension = opts.defaultExtension || defaultOptions.defaultExtension;
-    var cwd = opts.cwd || defaultOptions.cwd;
-    var packageJSON = opts.packageJSON || defaultOptions.packageJSON;
-    var packageJSONFieldName = (typeof packageJSON === "undefined" ? "undefined" : _typeof(packageJSON)) === "object" ? packageJSON.fieldName : pkgName;
-
-    var parts = splitPath(cwd);
-
-    var loaders = Array.isArray(defaultExtension) ? defaultExtension.map(function (extension) {
-        return defaultLoaderByExt[extension];
-    }) : defaultLoaderByExt[defaultExtension];
-
-    var loaderByExt = objectAssign({}, defaultLoaderByExt, {
-        "": loaders
+    const configFileName = opts.configFileName || `.${pkgName}rc`;
+    const defaultExtension = opts.defaultExtension || defaultOptions.defaultExtension;
+    const cwd = opts.cwd || defaultOptions.cwd;
+    const packageJSON = opts.packageJSON || defaultOptions.packageJSON;
+    const packageJSONFieldName = typeof packageJSON === "object" ? packageJSON.fieldName : pkgName;
+    const parts = splitPath(cwd);
+    const loadersByOrder = Array.isArray(defaultExtension)
+        ? defaultExtension.map((extension) => selectLoader(defaultLoaderByExt, extension))
+        : selectLoader(defaultLoaderByExt, defaultExtension);
+    const loaderByExt = Object.assign(Object.assign({}, defaultLoaderByExt), { "": loadersByOrder });
+    return findConfig({
+        parts,
+        loaderByExt,
+        loadersByOrder,
+        configFileName,
+        packageJSON,
+        packageJSONFieldName,
     });
-
-    return findConfig({ parts: parts, loaderByExt: loaderByExt, configFileName: configFileName, packageJSON: packageJSON, packageJSONFieldName: packageJSONFieldName });
-};
-
+}
+exports.rcFile = rcFile;
 /**
  *
- * @param {string[]} parts
- * @param {Object} loaderByExt
- * @param {string} configFileName
- * @param {boolean|Object} packageJSON
- * @param {string} packageJSONFieldName
  * @returns {{
  *  config: string,
  *  filePath: string
- * }|undefined}
+ * }}
  */
-function findConfig(_ref) {
-    var parts = _ref.parts,
-        loaderByExt = _ref.loaderByExt,
-        configFileName = _ref.configFileName,
-        packageJSON = _ref.packageJSON,
-        packageJSONFieldName = _ref.packageJSONFieldName;
-
-    var exts = keys(loaderByExt);
-    while (exts.length) {
-        var ext = exts.shift();
-        var configLocation = join(parts, configFileName + ext);
-        if (!pathExists.sync(configLocation)) {
+function findConfig({ parts, loaderByExt, loadersByOrder, configFileName, packageJSON, packageJSONFieldName, }) {
+    const extensions = Object.keys(loaderByExt);
+    while (extensions.length) {
+        const ext = extensions.shift();
+        // may be ext is "". if it .<product>rc
+        const configLocation = join(parts, configFileName + ext);
+        if (!fs_1.default.existsSync(configLocation)) {
             continue;
         }
-        var loaders = loaderByExt[ext];
+        // if ext === ""(empty string):, use ordered loaders
+        const loaders = ext ? loaderByExt[ext] : loadersByOrder;
         if (!Array.isArray(loaders)) {
-            var loader = loaders;
-            var result = loader(configLocation);
+            const loader = loaders;
+            const result = loader(configLocation, false);
             if (!result) {
                 continue;
             }
             return {
                 config: result,
-                filePath: configLocation
+                filePath: configLocation,
             };
         }
-        for (var i = 0; i < loaders.length; i++) {
-            var _loader = loaders[i];
-            var _result = _loader(configLocation, true);
-            if (!_result) {
+        for (let i = 0; i < loaders.length; i++) {
+            const loader = loaders[i];
+            const result = loader(configLocation, true);
+            if (!result) {
                 continue;
             }
             return {
-                config: _result,
-                filePath: configLocation
+                config: result,
+                filePath: configLocation,
             };
         }
     }
-
     if (packageJSON) {
-        var pkgJSONLoc = join(parts, "package.json");
-        if (pathExists.sync(pkgJSONLoc)) {
-            var pkgJSON = require(pkgJSONLoc);
+        const pkgJSONLoc = join(parts, "package.json");
+        if (fs_1.default.existsSync(pkgJSONLoc)) {
+            const pkgJSON = require(pkgJSONLoc);
             if (pkgJSON[packageJSONFieldName]) {
                 return {
                     config: pkgJSON[packageJSONFieldName],
-                    filePath: pkgJSONLoc
+                    filePath: pkgJSONLoc,
                 };
             }
         }
     }
     if (parts.pop()) {
-        return findConfig({ parts: parts, loaderByExt: loaderByExt, configFileName: configFileName, packageJSON: packageJSON, packageJSONFieldName: packageJSONFieldName });
+        return findConfig({ parts, loaderByExt, loadersByOrder, configFileName, packageJSON, packageJSONFieldName });
     }
-    return undefined;
+    return;
 }
-
 function splitPath(x) {
-    return path.resolve(x || "").split(path.sep);
+    return path_1.default.resolve(x || "").split(path_1.default.sep);
 }
-
 function join(parts, filename) {
-    return path.resolve(parts.join(path.sep) + path.sep, filename);
+    return path_1.default.resolve(parts.join(path_1.default.sep) + path_1.default.sep, filename);
 }
-
 function loadJSConfigFile(filePath, suppress) {
-    debug("Loading JavaScript config file: " + filePath);
+    debug(`Loading JavaScript config file: ${filePath}`);
     try {
-        var content = fs.readFileSync(filePath, "utf-8");
-        return requireFromString(content, filePath);
-    } catch (e) {
-        debug("Error reading JavaScript file: " + filePath);
+        const content = fs_1.default.readFileSync(filePath, "utf-8");
+        return require_from_string_1.default(content, filePath);
+    }
+    catch (error) {
+        debug(`Error reading JavaScript file: ${filePath}`);
         if (!suppress) {
-            e.message = "Cannot read config file: " + filePath + "\nError: " + e.message;
-            throw e;
+            error.message = `Cannot read config file: ${filePath}\nError: ${error.message}`;
+            throw error;
         }
     }
 }
-
 function loadJSONConfigFile(filePath, suppress) {
-    debug("Loading JSON config file: " + filePath);
-
+    debug(`Loading JSON config file: ${filePath}`);
     try {
-        return JSON5.parse(readFile(filePath));
-    } catch (e) {
-        debug("Error reading JSON file: " + filePath);
+        return json5_1.default.parse(readFile(filePath));
+    }
+    catch (error) {
+        debug(`Error reading JSON file: ${filePath}`);
         if (!suppress) {
-            e.message = "Cannot read config file: " + filePath + "\nError: " + e.message;
-            throw e;
+            error.message = `Cannot read config file: ${filePath}\nError: ${error.message}`;
+            throw error;
         }
     }
 }
-
 function readFile(filePath) {
-    return fs.readFileSync(filePath, "utf8");
+    return fs_1.default.readFileSync(filePath, "utf8");
 }
-
 function loadYAMLConfigFile(filePath, suppress) {
-    debug("Loading YAML config file: " + filePath);
-
+    debug(`Loading YAML config file: ${filePath}`);
     // lazy load YAML to improve performance when not used
-    var yaml = require("js-yaml");
-
+    const yaml = require("js-yaml");
     try {
         // empty YAML file can be null, so always use
-        return yaml.safeLoad(readFile(filePath)) || {};
-    } catch (e) {
-        debug("Error reading YAML file: " + filePath);
+        return yaml.load(readFile(filePath)) || {};
+    }
+    catch (error) {
+        debug(`Error reading YAML file: ${filePath}`);
         if (!suppress) {
-            e.message = "Cannot read config file: " + filePath + "\nError: " + e.message;
-            throw e;
+            error.message = `Cannot read config file: ${filePath}\nError: ${error.message}`;
+            throw error;
         }
     }
 }

package/lib/rc-config-loader.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/rc-config-loader.js"],"names":["path","require","debug","requireFromString","JSON5","fs","pathExists","objectAssign","keys","defaultLoaderByExt","loadJSConfigFile","loadJSONConfigFile","loadYAMLConfigFile","defaultOptions","packageJSON","defaultExtension","cwd","process","module","exports","rcConfigLoader","pkgName","opts","configFileName","packageJSONFieldName","fieldName","parts","splitPath","loaders","Array","isArray","map","extension","loaderByExt","findConfig","exts","length","ext","shift","configLocation","join","sync","loader","result","config","filePath","i","pkgJSONLoc","pkgJSON","pop","undefined","x","resolve","split","sep","filename","suppress","content","readFileSync","e","message","parse","readFile","yaml","safeLoad"],"mappings":"AAAA;AACA;AACA;AACA;;;;AACA,IAAMA,OAAOC,QAAQ,MAAR,CAAb;AACA,IAAMC,QAAQD,QAAQ,OAAR,EAAiB,kBAAjB,CAAd;AACA,IAAME,oBAAoBF,QAAQ,qBAAR,CAA1B;AACA,IAAMG,QAAQH,QAAQ,OAAR,CAAd;AACA,IAAMI,KAAKJ,QAAQ,IAAR,CAAX;AACA,IAAMK,aAAaL,QAAQ,aAAR,CAAnB;AACA,IAAMM,eAAeN,QAAQ,eAAR,CAArB;AACA,IAAMO,OAAOP,QAAQ,aAAR,CAAb;;AAEA,IAAMQ,qBAAqB;AACvB,WAAOC,gBADgB;AAEvB,aAASC,kBAFc;AAGvB,aAASC,kBAHc;AAIvB,YAAQA;AAJe,CAA3B;;AAOA,IAAMC,iBAAiB;AACnB;AACAC,iBAAa,KAFM;AAGnB;AACAC,sBAAkB,CAAC,OAAD,EAAU,OAAV,EAAmB,MAAnB,EAA2B,KAA3B,CAJC;AAKnBC,SAAKC,QAAQD,GAAR;AALc,CAAvB;;AAQA;;;;;AAKAE,OAAOC,OAAP,GAAiB,SAASC,cAAT,CAAwBC,OAAxB,EAA4C;AAAA,QAAXC,IAAW,uEAAJ,EAAI;;AACzD;AACA,QAAMC,iBAAiBD,KAAKC,cAAL,UAA2BF,OAA3B,OAAvB;AACA,QAAMN,mBAAmBO,KAAKP,gBAAL,IAAyBF,eAAeE,gBAAjE;AACA,QAAMC,MAAMM,KAAKN,GAAL,IAAYH,eAAeG,GAAvC;AACA,QAAMF,cAAcQ,KAAKR,WAAL,IAAoBD,eAAeC,WAAvD;AACA,QAAMU,uBAAuB,QAAOV,WAAP,yCAAOA,WAAP,OAAuB,QAAvB,GAAkCA,YAAYW,SAA9C,GAA0DJ,OAAvF;;AAEA,QAAMK,QAAQC,UAAUX,GAAV,CAAd;;AAEA,QAAMY,UAAUC,MAAMC,OAAN,CAAcf,gBAAd,IACVA,iBAAiBgB,GAAjB,CAAqB;AAAA,eAAatB,mBAAmBuB,SAAnB,CAAb;AAAA,KAArB,CADU,GAEVvB,mBAAmBM,gBAAnB,CAFN;;AAIA,QAAMkB,cAAc1B,aAAa,EAAb,EAAiBE,kBAAjB,EAAqC;AACrD,YAAImB;AADiD,KAArC,CAApB;;AAIA,WAAOM,WAAW,EAAER,YAAF,EAASO,wBAAT,EAAsBV,8BAAtB,EAAsCT,wBAAtC,EAAmDU,0CAAnD,EAAX,CAAP;AACH,CAnBD;;AAqBA;;;;;;;;;;;;AAYA,SAASU,UAAT,OAA+F;AAAA,QAAzER,KAAyE,QAAzEA,KAAyE;AAAA,QAAlEO,WAAkE,QAAlEA,WAAkE;AAAA,QAArDV,cAAqD,QAArDA,cAAqD;AAAA,QAArCT,WAAqC,QAArCA,WAAqC;AAAA,QAAxBU,oBAAwB,QAAxBA,oBAAwB;;AAC3F,QAAMW,OAAO3B,KAAKyB,WAAL,CAAb;AACA,WAAOE,KAAKC,MAAZ,EAAoB;AAChB,YAAMC,MAAMF,KAAKG,KAAL,EAAZ;AACA,YAAMC,iBAAiBC,KAAKd,KAAL,EAAYH,iBAAiBc,GAA7B,CAAvB;AACA,YAAI,CAAC/B,WAAWmC,IAAX,CAAgBF,cAAhB,CAAL,EAAsC;AAClC;AACH;AACD,YAAMX,UAAUK,YAAYI,GAAZ,CAAhB;AACA,YAAI,CAACR,MAAMC,OAAN,CAAcF,OAAd,CAAL,EAA6B;AACzB,gBAAMc,SAASd,OAAf;AACA,gBAAMe,SAASD,OAAOH,cAAP,CAAf;AACA,gBAAI,CAACI,MAAL,EAAa;AACT;AACH;AACD,mBAAO;AACHC,wBAAQD,MADL;AAEHE,0BAAUN;AAFP,aAAP;AAIH;AACD,aAAK,IAAIO,IAAI,CAAb,EAAgBA,IAAIlB,QAAQQ,MAA5B,EAAoCU,GAApC,EAAyC;AACrC,gBAAMJ,UAASd,QAAQkB,CAAR,CAAf;AACA,gBAAMH,UAASD,QAAOH,cAAP,EAAuB,IAAvB,CAAf;AACA,gBAAI,CAACI,OAAL,EAAa;AACT;AACH;AACD,mBAAO;AACHC,wBAAQD,OADL;AAEHE,0BAAUN;AAFP,aAAP;AAIH;AACJ;;AAED,QAAIzB,WAAJ,EAAiB;AACb,YAAMiC,aAAaP,KAAKd,KAAL,EAAY,cAAZ,CAAnB;AACA,YAAIpB,WAAWmC,IAAX,CAAgBM,UAAhB,CAAJ,EAAiC;AAC7B,gBAAMC,UAAU/C,QAAQ8C,UAAR,CAAhB;AACA,gBAAIC,QAAQxB,oBAAR,CAAJ,EAAmC;AAC/B,uBAAO;AACHoB,4BAAQI,QAAQxB,oBAAR,CADL;AAEHqB,8BAAUE;AAFP,iBAAP;AAIH;AACJ;AACJ;AACD,QAAIrB,MAAMuB,GAAN,EAAJ,EAAiB;AACb,eAAOf,WAAW,EAAER,YAAF,EAASO,wBAAT,EAAsBV,8BAAtB,EAAsCT,wBAAtC,EAAmDU,0CAAnD,EAAX,CAAP;AACH;AACD,WAAO0B,SAAP;AACH;;AAED,SAASvB,SAAT,CAAmBwB,CAAnB,EAAsB;AAClB,WAAOnD,KAAKoD,OAAL,CAAaD,KAAK,EAAlB,EAAsBE,KAAtB,CAA4BrD,KAAKsD,GAAjC,CAAP;AACH;;AAED,SAASd,IAAT,CAAcd,KAAd,EAAqB6B,QAArB,EAA+B;AAC3B,WAAOvD,KAAKoD,OAAL,CAAa1B,MAAMc,IAAN,CAAWxC,KAAKsD,GAAhB,IAAuBtD,KAAKsD,GAAzC,EAA8CC,QAA9C,CAAP;AACH;;AAED,SAAS7C,gBAAT,CAA0BmC,QAA1B,EAAoCW,QAApC,EAA8C;AAC1CtD,+CAAyC2C,QAAzC;AACA,QAAI;AACA,YAAMY,UAAUpD,GAAGqD,YAAH,CAAgBb,QAAhB,EAA0B,OAA1B,CAAhB;AACA,eAAO1C,kBAAkBsD,OAAlB,EAA2BZ,QAA3B,CAAP;AACH,KAHD,CAGE,OAAOc,CAAP,EAAU;AACRzD,kDAAwC2C,QAAxC;AACA,YAAI,CAACW,QAAL,EAAe;AACXG,cAAEC,OAAF,iCAAwCf,QAAxC,iBAA4Dc,EAAEC,OAA9D;AACA,kBAAMD,CAAN;AACH;AACJ;AACJ;;AAED,SAAShD,kBAAT,CAA4BkC,QAA5B,EAAsCW,QAAtC,EAAgD;AAC5CtD,yCAAmC2C,QAAnC;;AAEA,QAAI;AACA,eAAOzC,MAAMyD,KAAN,CAAYC,SAASjB,QAAT,CAAZ,CAAP;AACH,KAFD,CAEE,OAAOc,CAAP,EAAU;AACRzD,4CAAkC2C,QAAlC;AACA,YAAI,CAACW,QAAL,EAAe;AACXG,cAAEC,OAAF,iCAAwCf,QAAxC,iBAA4Dc,EAAEC,OAA9D;AACA,kBAAMD,CAAN;AACH;AACJ;AACJ;;AAED,SAASG,QAAT,CAAkBjB,QAAlB,EAA4B;AACxB,WAAOxC,GAAGqD,YAAH,CAAgBb,QAAhB,EAA0B,MAA1B,CAAP;AACH;;AAED,SAASjC,kBAAT,CAA4BiC,QAA5B,EAAsCW,QAAtC,EAAgD;AAC5CtD,yCAAmC2C,QAAnC;;AAEA;AACA,QAAMkB,OAAO9D,QAAQ,SAAR,CAAb;;AAEA,QAAI;AACA;AACA,eAAO8D,KAAKC,QAAL,CAAcF,SAASjB,QAAT,CAAd,KAAqC,EAA5C;AACH,KAHD,CAGE,OAAOc,CAAP,EAAU;AACRzD,4CAAkC2C,QAAlC;AACA,YAAI,CAACW,QAAL,EAAe;AACXG,cAAEC,OAAF,iCAAwCf,QAAxC,iBAA4Dc,EAAEC,OAA9D;AACA,kBAAMD,CAAN;AACH;AACJ;AACJ","file":"rc-config-loader.js","sourcesContent":["// MIT © 2017 azu\n// MIT © Zoltan Kochan\n// Original https://github.com/zkochan/rcfile\n\"use strict\";\nconst path = require(\"path\");\nconst debug = require(\"debug\")(\"rc-config-loader\");\nconst requireFromString = require(\"require-from-string\");\nconst JSON5 = require(\"json5\");\nconst fs = require(\"fs\");\nconst pathExists = require(\"path-exists\");\nconst objectAssign = require(\"object-assign\");\nconst keys = require(\"object-keys\");\n\nconst defaultLoaderByExt = {\n    \".js\": loadJSConfigFile,\n    \".json\": loadJSONConfigFile,\n    \".yaml\": loadYAMLConfigFile,\n    \".yml\": loadYAMLConfigFile\n};\n\nconst defaultOptions = {\n    // does look for `package.json`\n    packageJSON: false,\n    // treat default(no ext file) as some extension\n    defaultExtension: [\".json\", \".yaml\", \".yml\", \".js\"],\n    cwd: process.cwd()\n};\n\n/**\n * @param {string} pkgName\n * @param {rcConfigLoaderOption} [opts]\n * @returns {{ config: Object, filePath:string } | undefined}\n */\nmodule.exports = function rcConfigLoader(pkgName, opts = {}) {\n    // path/to/config or basename of config file.\n    const configFileName = opts.configFileName || `.${pkgName}rc`;\n    const defaultExtension = opts.defaultExtension || defaultOptions.defaultExtension;\n    const cwd = opts.cwd || defaultOptions.cwd;\n    const packageJSON = opts.packageJSON || defaultOptions.packageJSON;\n    const packageJSONFieldName = typeof packageJSON === \"object\" ? packageJSON.fieldName : pkgName;\n\n    const parts = splitPath(cwd);\n\n    const loaders = Array.isArray(defaultExtension)\n        ? defaultExtension.map(extension => defaultLoaderByExt[extension])\n        : defaultLoaderByExt[defaultExtension];\n\n    const loaderByExt = objectAssign({}, defaultLoaderByExt, {\n        \"\": loaders\n    });\n\n    return findConfig({ parts, loaderByExt, configFileName, packageJSON, packageJSONFieldName });\n};\n\n/**\n *\n * @param {string[]} parts\n * @param {Object} loaderByExt\n * @param {string} configFileName\n * @param {boolean|Object} packageJSON\n * @param {string} packageJSONFieldName\n * @returns {{\n *  config: string,\n *  filePath: string\n * }|undefined}\n */\nfunction findConfig({ parts, loaderByExt, configFileName, packageJSON, packageJSONFieldName }) {\n    const exts = keys(loaderByExt);\n    while (exts.length) {\n        const ext = exts.shift();\n        const configLocation = join(parts, configFileName + ext);\n        if (!pathExists.sync(configLocation)) {\n            continue;\n        }\n        const loaders = loaderByExt[ext];\n        if (!Array.isArray(loaders)) {\n            const loader = loaders;\n            const result = loader(configLocation);\n            if (!result) {\n                continue;\n            }\n            return {\n                config: result,\n                filePath: configLocation\n            };\n        }\n        for (let i = 0; i < loaders.length; i++) {\n            const loader = loaders[i];\n            const result = loader(configLocation, true);\n            if (!result) {\n                continue;\n            }\n            return {\n                config: result,\n                filePath: configLocation\n            };\n        }\n    }\n\n    if (packageJSON) {\n        const pkgJSONLoc = join(parts, \"package.json\");\n        if (pathExists.sync(pkgJSONLoc)) {\n            const pkgJSON = require(pkgJSONLoc);\n            if (pkgJSON[packageJSONFieldName]) {\n                return {\n                    config: pkgJSON[packageJSONFieldName],\n                    filePath: pkgJSONLoc\n                };\n            }\n        }\n    }\n    if (parts.pop()) {\n        return findConfig({ parts, loaderByExt, configFileName, packageJSON, packageJSONFieldName });\n    }\n    return undefined;\n}\n\nfunction splitPath(x) {\n    return path.resolve(x || \"\").split(path.sep);\n}\n\nfunction join(parts, filename) {\n    return path.resolve(parts.join(path.sep) + path.sep, filename);\n}\n\nfunction loadJSConfigFile(filePath, suppress) {\n    debug(`Loading JavaScript config file: ${filePath}`);\n    try {\n        const content = fs.readFileSync(filePath, \"utf-8\");\n        return requireFromString(content, filePath);\n    } catch (e) {\n        debug(`Error reading JavaScript file: ${filePath}`);\n        if (!suppress) {\n            e.message = `Cannot read config file: ${filePath}\\nError: ${e.message}`;\n            throw e;\n        }\n    }\n}\n\nfunction loadJSONConfigFile(filePath, suppress) {\n    debug(`Loading JSON config file: ${filePath}`);\n\n    try {\n        return JSON5.parse(readFile(filePath));\n    } catch (e) {\n        debug(`Error reading JSON file: ${filePath}`);\n        if (!suppress) {\n            e.message = `Cannot read config file: ${filePath}\\nError: ${e.message}`;\n            throw e;\n        }\n    }\n}\n\nfunction readFile(filePath) {\n    return fs.readFileSync(filePath, \"utf8\");\n}\n\nfunction loadYAMLConfigFile(filePath, suppress) {\n    debug(`Loading YAML config file: ${filePath}`);\n\n    // lazy load YAML to improve performance when not used\n    const yaml = require(\"js-yaml\");\n\n    try {\n        // empty YAML file can be null, so always use\n        return yaml.safeLoad(readFile(filePath)) || {};\n    } catch (e) {\n        debug(`Error reading YAML file: ${filePath}`);\n        if (!suppress) {\n            e.message = `Cannot read config file: ${filePath}\\nError: ${e.message}`;\n            throw e;\n        }\n    }\n}\n"]}
+{"version":3,"file":"rc-config-loader.js","sourceRoot":"","sources":["../src/rc-config-loader.ts"],"names":[],"mappings":";;;;;;AAAA,iBAAiB;AACjB,sBAAsB;AACtB,6CAA6C;AAC7C,gDAAwB;AACxB,4CAAoB;AACpB,8EAAoD;AACpD,kDAA0B;AAE1B,MAAM,KAAK,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC,kBAAkB,CAAC,CAAC;AACnD,MAAM,kBAAkB,GAAG;IACvB,KAAK,EAAE,gBAAgB;IACvB,OAAO,EAAE,kBAAkB;IAC3B,OAAO,EAAE,kBAAkB;IAC3B,MAAM,EAAE,kBAAkB;CAC7B,CAAC;AAEF,MAAM,cAAc,GAAG;IACnB,+BAA+B;IAC/B,WAAW,EAAE,KAAK;IAClB,+CAA+C;IAC/C,gBAAgB,EAAE,CAAC,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,KAAK,CAAC;IACnD,GAAG,EAAE,OAAO,CAAC,GAAG,EAAE;CACrB,CAAC;AAmBF,MAAM,YAAY,GAAG,CAAC,kBAA+C,EAAE,SAAiB,EAAE,EAAE;IACxF,IAAI,CAAC,CAAC,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE;QACxD,MAAM,IAAI,KAAK,CAAC,GAAG,SAAS,oBAAoB,CAAC,CAAC;KACrD;IACD,OAAO,kBAAkB,CAAC,SAAS,CAAC,CAAC;AACzC,CAAC,CAAC;AAEF;;;;;;GAMG;AACH,SAAgB,MAAM,CAClB,OAAe,EACf,OAA6B,EAAE;IAO/B,6CAA6C;IAC7C,MAAM,cAAc,GAAG,IAAI,CAAC,cAAc,IAAI,IAAI,OAAO,IAAI,CAAC;IAC9D,MAAM,gBAAgB,GAAG,IAAI,CAAC,gBAAgB,IAAI,cAAc,CAAC,gBAAgB,CAAC;IAClF,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,IAAI,cAAc,CAAC,GAAG,CAAC;IAC3C,MAAM,WAAW,GAAG,IAAI,CAAC,WAAW,IAAI,cAAc,CAAC,WAAW,CAAC;IACnE,MAAM,oBAAoB,GAAG,OAAO,WAAW,KAAK,QAAQ,CAAC,CAAC,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC;IAE/F,MAAM,KAAK,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC;IAC7B,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,gBAAgB,CAAC;QAClD,CAAC,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,YAAY,CAAC,kBAAkB,EAAE,SAAS,CAAC,CAAC;QAClF,CAAC,CAAC,YAAY,CAAC,kBAAkB,EAAE,gBAAgB,CAAC,CAAC;IAEzD,MAAM,WAAW,mCACV,kBAAkB,KACrB,EAAE,EAAE,cAAc,GACrB,CAAC;IACF,OAAO,UAAU,CAAI;QACjB,KAAK;QACL,WAAW;QACX,cAAc;QACd,cAAc;QACd,WAAW;QACX,oBAAoB;KACvB,CAAC,CAAC;AACP,CAAC;AAjCD,wBAiCC;AAED;;;;;;GAMG;AACH,SAAS,UAAU,CAAe,EAC9B,KAAK,EACL,WAAW,EACX,cAAc,EACd,cAAc,EACd,WAAW,EACX,oBAAoB,GAUvB;IAMG,MAAM,UAAU,GAAG,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;IAC5C,OAAO,UAAU,CAAC,MAAM,EAAE;QACtB,MAAM,GAAG,GAAG,UAAU,CAAC,KAAK,EAAE,CAAC;QAC/B,uCAAuC;QACvC,MAAM,cAAc,GAAG,IAAI,CAAC,KAAK,EAAE,cAAc,GAAG,GAAG,CAAC,CAAC;QACzD,IAAI,CAAC,YAAE,CAAC,UAAU,CAAC,cAAc,CAAC,EAAE;YAChC,SAAS;SACZ;QACD,oDAAoD;QACpD,MAAM,OAAO,GAAG,GAAG,CAAC,CAAC,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC;QACxD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE;YACzB,MAAM,MAAM,GAAG,OAAO,CAAC;YACvB,MAAM,MAAM,GAAG,MAAM,CAAI,cAAc,EAAE,KAAK,CAAC,CAAC;YAChD,IAAI,CAAC,MAAM,EAAE;gBACT,SAAS;aACZ;YACD,OAAO;gBACH,MAAM,EAAE,MAAM;gBACd,QAAQ,EAAE,cAAc;aAC3B,CAAC;SACL;QACD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;YACrC,MAAM,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;YAC1B,MAAM,MAAM,GAAG,MAAM,CAAI,cAAc,EAAE,IAAI,CAAC,CAAC;YAC/C,IAAI,CAAC,MAAM,EAAE;gBACT,SAAS;aACZ;YACD,OAAO;gBACH,MAAM,EAAE,MAAM;gBACd,QAAQ,EAAE,cAAc;aAC3B,CAAC;SACL;KACJ;IAED,IAAI,WAAW,EAAE;QACb,MAAM,UAAU,GAAG,IAAI,CAAC,KAAK,EAAE,cAAc,CAAC,CAAC;QAC/C,IAAI,YAAE,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE;YAC3B,MAAM,OAAO,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;YACpC,IAAI,OAAO,CAAC,oBAAoB,CAAC,EAAE;gBAC/B,OAAO;oBACH,MAAM,EAAE,OAAO,CAAC,oBAAoB,CAAC;oBACrC,QAAQ,EAAE,UAAU;iBACvB,CAAC;aACL;SACJ;KACJ;IACD,IAAI,KAAK,CAAC,GAAG,EAAE,EAAE;QACb,OAAO,UAAU,CAAC,EAAE,KAAK,EAAE,WAAW,EAAE,cAAc,EAAE,cAAc,EAAE,WAAW,EAAE,oBAAoB,EAAE,CAAC,CAAC;KAChH;IACD,OAAO;AACX,CAAC;AAED,SAAS,SAAS,CAAC,CAAS;IACxB,OAAO,cAAI,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,cAAI,CAAC,GAAG,CAAC,CAAC;AACjD,CAAC;AAED,SAAS,IAAI,CAAC,KAAe,EAAE,QAAgB;IAC3C,OAAO,cAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,cAAI,CAAC,GAAG,CAAC,GAAG,cAAI,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC;AACnE,CAAC;AAED,SAAS,gBAAgB,CAAC,QAAgB,EAAE,QAAiB;IACzD,KAAK,CAAC,mCAAmC,QAAQ,EAAE,CAAC,CAAC;IACrD,IAAI;QACA,MAAM,OAAO,GAAG,YAAE,CAAC,YAAY,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;QACnD,OAAO,6BAAiB,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;KAC/C;IAAC,OAAO,KAAK,EAAE;QACZ,KAAK,CAAC,kCAAkC,QAAQ,EAAE,CAAC,CAAC;QACpD,IAAI,CAAC,QAAQ,EAAE;YACX,KAAK,CAAC,OAAO,GAAG,4BAA4B,QAAQ,YAAY,KAAK,CAAC,OAAO,EAAE,CAAC;YAChF,MAAM,KAAK,CAAC;SACf;KACJ;AACL,CAAC;AAED,SAAS,kBAAkB,CAAC,QAAgB,EAAE,QAAiB;IAC3D,KAAK,CAAC,6BAA6B,QAAQ,EAAE,CAAC,CAAC;IAE/C,IAAI;QACA,OAAO,eAAK,CAAC,KAAK,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC;KAC1C;IAAC,OAAO,KAAK,EAAE;QACZ,KAAK,CAAC,4BAA4B,QAAQ,EAAE,CAAC,CAAC;QAC9C,IAAI,CAAC,QAAQ,EAAE;YACX,KAAK,CAAC,OAAO,GAAG,4BAA4B,QAAQ,YAAY,KAAK,CAAC,OAAO,EAAE,CAAC;YAChF,MAAM,KAAK,CAAC;SACf;KACJ;AACL,CAAC;AAED,SAAS,QAAQ,CAAC,QAAgB;IAC9B,OAAO,YAAE,CAAC,YAAY,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;AAC7C,CAAC;AAED,SAAS,kBAAkB,CAAC,QAAgB,EAAE,QAAiB;IAC3D,KAAK,CAAC,6BAA6B,QAAQ,EAAE,CAAC,CAAC;IAC/C,sDAAsD;IACtD,MAAM,IAAI,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC;IAChC,IAAI;QACA,6CAA6C;QAC7C,OAAO,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,IAAI,EAAE,CAAC;KAC9C;IAAC,OAAO,KAAK,EAAE;QACZ,KAAK,CAAC,4BAA4B,QAAQ,EAAE,CAAC,CAAC;QAC9C,IAAI,CAAC,QAAQ,EAAE;YACX,KAAK,CAAC,OAAO,GAAG,4BAA4B,QAAQ,YAAY,KAAK,CAAC,OAAO,EAAE,CAAC;YAChF,MAAM,KAAK,CAAC;SACf;KACJ;AACL,CAAC"}

package/package.json

@@ -1,76 +1,76 @@
 {
-  "directories": {
-    "test": "test"
-  },
-  "author": "azu",
-  "license": "MIT",
-  "files": [
-    "bin/",
-    "lib/",
-    "src/"
-  ],
   "name": "rc-config-loader",
-  "version": "2.0.3",
+  "version": "4.0.0",
   "description": "load config file from .{product}rc.{json,yml,js}",
-  "main": "lib/rc-config-loader.js",
-  "scripts": {
-    "test": "mocha test/",
-    "build": "cross-env NODE_ENV=production babel src --out-dir lib --copy-files --source-maps",
-    "watch": "babel src --out-dir lib --watch --source-maps",
-    "prepublish": "npm run --if-present build",
-    "prettier": "prettier --write '**/*.{js,jsx,ts,tsx,css}'",
-    "precommit": "lint-staged",
-    "postcommit": "git reset"
-  },
   "keywords": [
-    "rc",
     "config",
     "configuration",
-    "loader",
     "json",
+    "loader",
+    "rc",
     "yaml",
     "yml"
   ],
+  "homepage": "https://github.com/azu/rc-config-loader",
+  "bugs": {
+    "url": "https://github.com/azu/rc-config-loader/issues"
+  },
   "repository": {
     "type": "git",
     "url": "https://github.com/azu/rc-config-loader.git"
   },
-  "bugs": {
-    "url": "https://github.com/azu/rc-config-loader/issues"
+  "license": "MIT",
+  "author": "azu",
+  "files": [
+    "bin/",
+    "lib/",
+    "src/"
+  ],
+  "main": "lib/rc-config-loader.js",
+  "types": "lib/rc-config-loader.d.ts",
+  "directories": {
+    "test": "test"
   },
-  "homepage": "https://github.com/azu/rc-config-loader",
-  "dependencies": {
-    "debug": "^3.1.0",
-    "js-yaml": "^3.12.0",
-    "json5": "^1.0.1",
-    "object-assign": "^4.1.0",
-    "object-keys": "^1.0.12",
-    "path-exists": "^3.0.0",
-    "require-from-string": "^2.0.2"
+  "scripts": {
+    "build": "tsc -p .",
+    "prettier": "prettier --write '**/*.{js,jsx,ts,tsx,css}'",
+    "prepublish": "npm run --if-present build",
+    "test": "mocha \"test/**/*.{js,ts}\"",
+    "watch": "tsc -p . --watch"
   },
-  "devDependencies": {
-    "babel-cli": "^6.22.2",
-    "babel-preset-jsdoc-to-assert": "^4.0.0",
-    "babel-preset-latest": "^6.22.0",
-    "babel-preset-power-assert": "^1.0.0",
-    "babel-register": "^6.22.0",
-    "chai": "^3.5.0",
-    "cross-env": "^3.1.4",
-    "eslint": "^3.15.0",
-    "husky": "^0.14.3",
-    "lint-staged": "^5.0.0",
-    "mocha": "^3.2.0",
-    "power-assert": "^1.4.2",
-    "prettier": "^1.8.2"
+  "husky": {
+    "hooks": {
+      "post-commit": "git reset",
+      "pre-commit": "lint-staged"
+    }
+  },
+  "lint-staged": {
+    "*.{js,jsx,ts,tsx,css}": [
+      "prettier --write"
+    ]
   },
   "prettier": {
     "printWidth": 120,
     "tabWidth": 4
   },
-  "lint-staged": {
-    "*.{js,jsx,ts,tsx,css}": [
-      "prettier --write",
-      "git add"
-    ]
+  "dependencies": {
+    "debug": "^4.1.1",
+    "js-yaml": "^4.0.0",
+    "json5": "^2.1.2",
+    "require-from-string": "^2.0.2"
+  },
+  "devDependencies": {
+    "@types/json5": "^0.0.30",
+    "@types/mocha": "^8.2.0",
+    "@types/node": "^14.14.20",
+    "@types/require-from-string": "^1.2.0",
+    "chai": "^4.2.0",
+    "husky": "^4.2.3",
+    "lint-staged": "^10.1.1",
+    "mocha": "^8.2.1",
+    "prettier": "^2.0.2",
+    "ts-node": "^9.1.1",
+    "ts-node-test-register": "^9.0.1",
+    "typescript": "^4.1.3"
   }
 }

package/src/rc-config-loader.ts

@@ -0,0 +1,226 @@
+// MIT © 2017 azu
+// MIT © Zoltan Kochan
+// Original https://github.com/zkochan/rcfile
+import path from "path";
+import fs from "fs";
+import requireFromString from "require-from-string";
+import JSON5 from "json5";
+
+const debug = require("debug")("rc-config-loader");
+const defaultLoaderByExt = {
+    ".js": loadJSConfigFile,
+    ".json": loadJSONConfigFile,
+    ".yaml": loadYAMLConfigFile,
+    ".yml": loadYAMLConfigFile,
+};
+
+const defaultOptions = {
+    // does look for `package.json`
+    packageJSON: false,
+    // treat default(no ext file) as some extension
+    defaultExtension: [".json", ".yaml", ".yml", ".js"],
+    cwd: process.cwd(),
+};
+
+export interface rcConfigLoaderOption {
+    // does look for `package.json`
+    packageJSON?:
+        | boolean
+        | {
+              fieldName: string;
+          };
+    // if config file name is not same with packageName, set the name
+    configFileName?: string;
+    // treat default(no ext file) as some extension
+    defaultExtension?: string | string[];
+    // where start to load
+    cwd?: string;
+}
+
+type Loader = <R extends object>(fileName: string, suppress: boolean) => R;
+
+const selectLoader = (defaultLoaderByExt: { [index: string]: Loader }, extension: string) => {
+    if (![".json", ".yaml", ".yml", ".js"].includes(extension)) {
+        throw new Error(`${extension} is not supported.`);
+    }
+    return defaultLoaderByExt[extension];
+};
+
+/**
+ * Find and load rcfile, return { config, filePath }
+ * If not found any rcfile, throw an Error.
+ * @param {string} pkgName
+ * @param {rcConfigLoaderOption} [opts]
+ * @returns {{ config: Object, filePath:string } | undefined}
+ */
+export function rcFile<R extends {}>(
+    pkgName: string,
+    opts: rcConfigLoaderOption = {}
+):
+    | {
+          config: R;
+          filePath: string;
+      }
+    | undefined {
+    // path/to/config or basename of config file.
+    const configFileName = opts.configFileName || `.${pkgName}rc`;
+    const defaultExtension = opts.defaultExtension || defaultOptions.defaultExtension;
+    const cwd = opts.cwd || defaultOptions.cwd;
+    const packageJSON = opts.packageJSON || defaultOptions.packageJSON;
+    const packageJSONFieldName = typeof packageJSON === "object" ? packageJSON.fieldName : pkgName;
+
+    const parts = splitPath(cwd);
+    const loadersByOrder = Array.isArray(defaultExtension)
+        ? defaultExtension.map((extension) => selectLoader(defaultLoaderByExt, extension))
+        : selectLoader(defaultLoaderByExt, defaultExtension);
+
+    const loaderByExt = {
+        ...defaultLoaderByExt,
+        "": loadersByOrder,
+    };
+    return findConfig<R>({
+        parts,
+        loaderByExt,
+        loadersByOrder,
+        configFileName,
+        packageJSON,
+        packageJSONFieldName,
+    });
+}
+
+/**
+ *
+ * @returns {{
+ *  config: string,
+ *  filePath: string
+ * }}
+ */
+function findConfig<R extends {}>({
+    parts,
+    loaderByExt,
+    loadersByOrder,
+    configFileName,
+    packageJSON,
+    packageJSONFieldName,
+}: {
+    parts: string[];
+    loaderByExt: {
+        [index: string]: Loader | Loader[];
+    };
+    loadersByOrder: Loader | Loader[];
+    configFileName: string;
+    packageJSON: boolean | { fieldName: string };
+    packageJSONFieldName: string;
+}):
+    | {
+          config: R;
+          filePath: string;
+      }
+    | undefined {
+    const extensions = Object.keys(loaderByExt);
+    while (extensions.length) {
+        const ext = extensions.shift();
+        // may be ext is "". if it .<product>rc
+        const configLocation = join(parts, configFileName + ext);
+        if (!fs.existsSync(configLocation)) {
+            continue;
+        }
+        // if ext === ""(empty string):, use ordered loaders
+        const loaders = ext ? loaderByExt[ext] : loadersByOrder;
+        if (!Array.isArray(loaders)) {
+            const loader = loaders;
+            const result = loader<R>(configLocation, false);
+            if (!result) {
+                continue;
+            }
+            return {
+                config: result,
+                filePath: configLocation,
+            };
+        }
+        for (let i = 0; i < loaders.length; i++) {
+            const loader = loaders[i];
+            const result = loader<R>(configLocation, true);
+            if (!result) {
+                continue;
+            }
+            return {
+                config: result,
+                filePath: configLocation,
+            };
+        }
+    }
+
+    if (packageJSON) {
+        const pkgJSONLoc = join(parts, "package.json");
+        if (fs.existsSync(pkgJSONLoc)) {
+            const pkgJSON = require(pkgJSONLoc);
+            if (pkgJSON[packageJSONFieldName]) {
+                return {
+                    config: pkgJSON[packageJSONFieldName],
+                    filePath: pkgJSONLoc,
+                };
+            }
+        }
+    }
+    if (parts.pop()) {
+        return findConfig({ parts, loaderByExt, loadersByOrder, configFileName, packageJSON, packageJSONFieldName });
+    }
+    return;
+}
+
+function splitPath(x: string): string[] {
+    return path.resolve(x || "").split(path.sep);
+}
+
+function join(parts: string[], filename: string) {
+    return path.resolve(parts.join(path.sep) + path.sep, filename);
+}
+
+function loadJSConfigFile(filePath: string, suppress: boolean) {
+    debug(`Loading JavaScript config file: ${filePath}`);
+    try {
+        const content = fs.readFileSync(filePath, "utf-8");
+        return requireFromString(content, filePath);
+    } catch (error) {
+        debug(`Error reading JavaScript file: ${filePath}`);
+        if (!suppress) {
+            error.message = `Cannot read config file: ${filePath}\nError: ${error.message}`;
+            throw error;
+        }
+    }
+}
+
+function loadJSONConfigFile(filePath: string, suppress: boolean) {
+    debug(`Loading JSON config file: ${filePath}`);
+
+    try {
+        return JSON5.parse(readFile(filePath));
+    } catch (error) {
+        debug(`Error reading JSON file: ${filePath}`);
+        if (!suppress) {
+            error.message = `Cannot read config file: ${filePath}\nError: ${error.message}`;
+            throw error;
+        }
+    }
+}
+
+function readFile(filePath: string) {
+    return fs.readFileSync(filePath, "utf8");
+}
+
+function loadYAMLConfigFile(filePath: string, suppress: boolean) {
+    debug(`Loading YAML config file: ${filePath}`);
+    // lazy load YAML to improve performance when not used
+    const yaml = require("js-yaml");
+    try {
+        // empty YAML file can be null, so always use
+        return yaml.load(readFile(filePath)) || {};
+    } catch (error) {
+        debug(`Error reading YAML file: ${filePath}`);
+        if (!suppress) {
+            error.message = `Cannot read config file: ${filePath}\nError: ${error.message}`;
+            throw error;
+        }
+    }
+}

package/src/rc-config-loader.d.ts

@@ -1,11 +0,0 @@
-export interface rcConfigLoaderOption {
-    // does look for `package.json`
-    packageJSON?: boolean;
-    // if config file name is not same with packageName, set the name
-    configFileName?: string;
-    // treat default(no ext file) as some extension
-    defaultExtension?: string | string[];
-    // where start to load
-    cwd?: string;
-}
-export default function rcConfigLoader(packageName: string, options?: rcConfigLoaderOption): Object;

package/src/rc-config-loader.js

@@ -1,174 +0,0 @@
-// MIT © 2017 azu
-// MIT © Zoltan Kochan
-// Original https://github.com/zkochan/rcfile
-"use strict";
-const path = require("path");
-const debug = require("debug")("rc-config-loader");
-const requireFromString = require("require-from-string");
-const JSON5 = require("json5");
-const fs = require("fs");
-const pathExists = require("path-exists");
-const objectAssign = require("object-assign");
-const keys = require("object-keys");
-
-const defaultLoaderByExt = {
-    ".js": loadJSConfigFile,
-    ".json": loadJSONConfigFile,
-    ".yaml": loadYAMLConfigFile,
-    ".yml": loadYAMLConfigFile
-};
-
-const defaultOptions = {
-    // does look for `package.json`
-    packageJSON: false,
-    // treat default(no ext file) as some extension
-    defaultExtension: [".json", ".yaml", ".yml", ".js"],
-    cwd: process.cwd()
-};
-
-/**
- * @param {string} pkgName
- * @param {rcConfigLoaderOption} [opts]
- * @returns {{ config: Object, filePath:string } | undefined}
- */
-module.exports = function rcConfigLoader(pkgName, opts = {}) {
-    // path/to/config or basename of config file.
-    const configFileName = opts.configFileName || `.${pkgName}rc`;
-    const defaultExtension = opts.defaultExtension || defaultOptions.defaultExtension;
-    const cwd = opts.cwd || defaultOptions.cwd;
-    const packageJSON = opts.packageJSON || defaultOptions.packageJSON;
-    const packageJSONFieldName = typeof packageJSON === "object" ? packageJSON.fieldName : pkgName;
-
-    const parts = splitPath(cwd);
-
-    const loaders = Array.isArray(defaultExtension)
-        ? defaultExtension.map(extension => defaultLoaderByExt[extension])
-        : defaultLoaderByExt[defaultExtension];
-
-    const loaderByExt = objectAssign({}, defaultLoaderByExt, {
-        "": loaders
-    });
-
-    return findConfig({ parts, loaderByExt, configFileName, packageJSON, packageJSONFieldName });
-};
-
-/**
- *
- * @param {string[]} parts
- * @param {Object} loaderByExt
- * @param {string} configFileName
- * @param {boolean|Object} packageJSON
- * @param {string} packageJSONFieldName
- * @returns {{
- *  config: string,
- *  filePath: string
- * }|undefined}
- */
-function findConfig({ parts, loaderByExt, configFileName, packageJSON, packageJSONFieldName }) {
-    const exts = keys(loaderByExt);
-    while (exts.length) {
-        const ext = exts.shift();
-        const configLocation = join(parts, configFileName + ext);
-        if (!pathExists.sync(configLocation)) {
-            continue;
-        }
-        const loaders = loaderByExt[ext];
-        if (!Array.isArray(loaders)) {
-            const loader = loaders;
-            const result = loader(configLocation);
-            if (!result) {
-                continue;
-            }
-            return {
-                config: result,
-                filePath: configLocation
-            };
-        }
-        for (let i = 0; i < loaders.length; i++) {
-            const loader = loaders[i];
-            const result = loader(configLocation, true);
-            if (!result) {
-                continue;
-            }
-            return {
-                config: result,
-                filePath: configLocation
-            };
-        }
-    }
-
-    if (packageJSON) {
-        const pkgJSONLoc = join(parts, "package.json");
-        if (pathExists.sync(pkgJSONLoc)) {
-            const pkgJSON = require(pkgJSONLoc);
-            if (pkgJSON[packageJSONFieldName]) {
-                return {
-                    config: pkgJSON[packageJSONFieldName],
-                    filePath: pkgJSONLoc
-                };
-            }
-        }
-    }
-    if (parts.pop()) {
-        return findConfig({ parts, loaderByExt, configFileName, packageJSON, packageJSONFieldName });
-    }
-    return undefined;
-}
-
-function splitPath(x) {
-    return path.resolve(x || "").split(path.sep);
-}
-
-function join(parts, filename) {
-    return path.resolve(parts.join(path.sep) + path.sep, filename);
-}
-
-function loadJSConfigFile(filePath, suppress) {
-    debug(`Loading JavaScript config file: ${filePath}`);
-    try {
-        const content = fs.readFileSync(filePath, "utf-8");
-        return requireFromString(content, filePath);
-    } catch (e) {
-        debug(`Error reading JavaScript file: ${filePath}`);
-        if (!suppress) {
-            e.message = `Cannot read config file: ${filePath}\nError: ${e.message}`;
-            throw e;
-        }
-    }
-}
-
-function loadJSONConfigFile(filePath, suppress) {
-    debug(`Loading JSON config file: ${filePath}`);
-
-    try {
-        return JSON5.parse(readFile(filePath));
-    } catch (e) {
-        debug(`Error reading JSON file: ${filePath}`);
-        if (!suppress) {
-            e.message = `Cannot read config file: ${filePath}\nError: ${e.message}`;
-            throw e;
-        }
-    }
-}
-
-function readFile(filePath) {
-    return fs.readFileSync(filePath, "utf8");
-}
-
-function loadYAMLConfigFile(filePath, suppress) {
-    debug(`Loading YAML config file: ${filePath}`);
-
-    // lazy load YAML to improve performance when not used
-    const yaml = require("js-yaml");
-
-    try {
-        // empty YAML file can be null, so always use
-        return yaml.safeLoad(readFile(filePath)) || {};
-    } catch (e) {
-        debug(`Error reading YAML file: ${filePath}`);
-        if (!suppress) {
-            e.message = `Cannot read config file: ${filePath}\nError: ${e.message}`;
-            throw e;
-        }
-    }
-}