rc-config-loader/src/types.ts

load config file from .{product}rc.{json,yml,js}

export type ExtensionName = ".cjs" | ".js" | ".json" | ".yaml" | ".yml";

export type RequiredOption = "packageJSON" | "defaultExtension" | "cwd";

export type Loader = <R extends {}>(fileName: string, supperes: boolean) => R;

export type ExtensionLoaderMap = Record<ExtensionName, Loader>;

export type PossibleUndefined<T> = T | undefined;

export interface rcConfigResult<R extends Record<string, unknown>> {
    config: R;
    filePath: string;
}

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?: ExtensionName | ExtensionName[];

    /** where start to load */
    cwd?: string;
}