c12 0.1.1 → 0.1.2

package/README.md

@@ -13,7 +13,7 @@
 - RC config support with [unjs/rc9](https://github.com/unjs/rc9)
 - Multiple sources merged with [unjs/defu](https://github.com/unjs/defu)
 - `.env` support with [dotenv](https://www.npmjs.com/package/dotenv)
-- Support extending nested configurations from multiple local or git sourecs
+- Support extending nested configurations from multiple local or git sources
 
 ## Usage
 

package/dist/index.cjs

@@ -100,6 +100,12 @@ async function loadConfig(opts) {
   opts.name = opts.name || "config";
   opts.configFile = opts.configFile ?? (opts.name !== "config" ? `${opts.name}.config` : "config");
   opts.rcFile = opts.rcFile ?? `.${opts.name}rc`;
+  if (opts.extend !== false) {
+    opts.extend = {
+      extendKey: "extends",
+      ...opts.extend
+    };
+  }
   const r = {
     config: {},
     cwd: opts.cwd,
@@ -112,7 +118,7 @@ async function loadConfig(opts) {
       ...opts.dotenv === true ? {} : opts.dotenv
     });
   }
-  const { config, configFile } = await loadConfigFile(opts.cwd, opts.configFile);
+  const { config, configFile } = await resolveConfig(".", opts);
   if (configFile) {
     r.configFile = configFile;
   }
@@ -124,59 +130,64 @@ async function loadConfig(opts) {
     Object.assign(configRC, rc9__namespace.read({ name: opts.rcFile, dir: opts.cwd }));
   }
   r.config = defu__default(opts.overrides, config, configRC, opts.defaults);
-  await extendConfig(r.config, opts.configFile, opts.cwd);
-  r.layers = r.config._layers;
-  delete r.config._layers;
-  r.config = defu__default(r.config, ...r.layers.map((e) => e.config));
+  if (opts.extend) {
+    await extendConfig(r.config, opts);
+    r.layers = r.config._layers;
+    delete r.config._layers;
+    r.config = defu__default(r.config, ...r.layers.map((e) => e.config));
+  }
   return r;
 }
-const GIT_PREFIXES = ["github:", "gitlab:", "bitbucket:", "https://"];
-async function extendConfig(config, configFile, cwd) {
+async function extendConfig(config, opts) {
   config._layers = config._layers || [];
-  const extendSources = (Array.isArray(config.extends) ? config.extends : [config.extends]).filter(Boolean);
-  delete config.extends;
-  for (let extendSource of extendSources) {
-    if (GIT_PREFIXES.some((prefix) => extendSource.startsWith(prefix))) {
-      const url = new URL(extendSource);
-      const subPath = url.pathname.split("/").slice(2).join("/");
-      const gitRepo = url.protocol + url.pathname.split("/").slice(0, 2).join("/");
-      const tmpdir = pathe.resolve(os__default.tmpdir(), "c12/", gitRepo.replace(/[#:@/\\]/g, "_"));
-      await fs.promises.rm(tmpdir, { recursive: true }).catch(() => {
-      });
-      const gittar = await import('gittar').then((r) => r.default || r);
-      const tarFile = await gittar.fetch(gitRepo);
-      await gittar.extract(tarFile, tmpdir);
-      extendSource = pathe.resolve(tmpdir, subPath);
-    }
-    const isDir = !pathe.extname(extendSource);
-    const _cwd = pathe.resolve(cwd, isDir ? extendSource : pathe.dirname(extendSource));
-    const _config = await loadConfigFile(_cwd, isDir ? configFile : extendSource);
+  if (!opts.extend) {
+    return;
+  }
+  const key = opts.extend.extendKey;
+  const extendSources = (Array.isArray(config[key]) ? config[key] : [config[key]]).filter(Boolean);
+  delete config[key];
+  for (const extendSource of extendSources) {
+    const _config = await resolveConfig(extendSource, opts);
     if (!_config.config) {
       continue;
     }
-    await extendConfig(_config.config, configFile, _cwd);
-    config._layers.push({
-      config: _config.config,
-      cwd: _cwd,
-      configFile: _config.configFile
-    });
+    await extendConfig(_config.config, { ...opts, cwd: _config.cwd });
+    config._layers.push(_config);
     if (_config.config._layers) {
       config._layers.push(..._config.config._layers);
       delete _config.config._layers;
     }
   }
 }
+const GIT_PREFIXES = ["github:", "gitlab:", "bitbucket:", "https://"];
 const jiti = createJiti__default(null, { cache: false, interopDefault: true });
-async function loadConfigFile(cwd, configFile) {
-  const res = {
-    configFile: null,
-    config: null
-  };
-  if (!configFile) {
-    return res;
+async function resolveConfig(source, opts) {
+  if (opts.resolve) {
+    const res2 = await opts.resolve(source, opts);
+    if (res2) {
+      return res2;
+    }
+  }
+  if (GIT_PREFIXES.some((prefix) => source.startsWith(prefix))) {
+    const url = new URL(source);
+    const subPath = url.pathname.split("/").slice(2).join("/");
+    const gitRepo = url.protocol + url.pathname.split("/").slice(0, 2).join("/");
+    const tmpdir = pathe.resolve(os__default.tmpdir(), "c12/", gitRepo.replace(/[#:@/\\]/g, "_"));
+    await fs.promises.rm(tmpdir, { recursive: true }).catch(() => {
+    });
+    const gittar = await import('gittar').then((r) => r.default || r);
+    const tarFile = await gittar.fetch(gitRepo);
+    await gittar.extract(tarFile, tmpdir);
+    source = pathe.resolve(tmpdir, subPath);
+  }
+  const isDir = !pathe.extname(source);
+  const cwd = pathe.resolve(opts.cwd, isDir ? source : pathe.dirname(source));
+  if (isDir) {
+    source = opts.configFile;
   }
+  const res = { config: {}, cwd };
   try {
-    res.configFile = jiti.resolve(pathe.resolve(cwd, configFile), { paths: [cwd] });
+    res.configFile = jiti.resolve(pathe.resolve(cwd, source), { paths: [cwd] });
     res.config = jiti(res.configFile);
     if (typeof res.config === "function") {
       res.config = await res.config();

package/dist/index.d.ts

@@ -38,9 +38,12 @@ interface InputConfig extends Record<string, any> {
 }
 interface ResolvedConfig<T extends InputConfig = InputConfig> {
     config: T;
+    cwd?: string;
+    configFile?: string;
+    layers?: ResolvedConfig<T>[];
+}
+interface ResolveConfigOptions {
     cwd: string;
-    configFile: string;
-    layers: ResolvedConfig<T>[];
 }
 interface LoadConfigOptions<T extends InputConfig = InputConfig> {
     name?: string;
@@ -51,7 +54,11 @@ interface LoadConfigOptions<T extends InputConfig = InputConfig> {
     dotenv?: boolean | DotenvOptions;
     defaults?: T;
     overrides?: T;
+    resolve?: (id: string, opts: LoadConfigOptions) => null | ResolvedConfig | Promise<ResolvedConfig | null>;
+    extend?: false | {
+        extendKey?: string;
+    };
 }
 declare function loadConfig<T extends InputConfig = InputConfig>(opts: LoadConfigOptions<T>): Promise<ResolvedConfig<T>>;
 
-export { DotenvOptions, Env, InputConfig, LoadConfigOptions, ResolvedConfig, loadConfig, loadDotenv, setupDotenv };
+export { DotenvOptions, Env, InputConfig, LoadConfigOptions, ResolveConfigOptions, ResolvedConfig, loadConfig, loadDotenv, setupDotenv };

package/dist/index.mjs

@@ -76,6 +76,12 @@ async function loadConfig(opts) {
   opts.name = opts.name || "config";
   opts.configFile = opts.configFile ?? (opts.name !== "config" ? `${opts.name}.config` : "config");
   opts.rcFile = opts.rcFile ?? `.${opts.name}rc`;
+  if (opts.extend !== false) {
+    opts.extend = {
+      extendKey: "extends",
+      ...opts.extend
+    };
+  }
   const r = {
     config: {},
     cwd: opts.cwd,
@@ -88,7 +94,7 @@ async function loadConfig(opts) {
       ...opts.dotenv === true ? {} : opts.dotenv
     });
   }
-  const { config, configFile } = await loadConfigFile(opts.cwd, opts.configFile);
+  const { config, configFile } = await resolveConfig(".", opts);
   if (configFile) {
     r.configFile = configFile;
   }
@@ -100,59 +106,64 @@ async function loadConfig(opts) {
     Object.assign(configRC, rc9.read({ name: opts.rcFile, dir: opts.cwd }));
   }
   r.config = defu(opts.overrides, config, configRC, opts.defaults);
-  await extendConfig(r.config, opts.configFile, opts.cwd);
-  r.layers = r.config._layers;
-  delete r.config._layers;
-  r.config = defu(r.config, ...r.layers.map((e) => e.config));
+  if (opts.extend) {
+    await extendConfig(r.config, opts);
+    r.layers = r.config._layers;
+    delete r.config._layers;
+    r.config = defu(r.config, ...r.layers.map((e) => e.config));
+  }
   return r;
 }
-const GIT_PREFIXES = ["github:", "gitlab:", "bitbucket:", "https://"];
-async function extendConfig(config, configFile, cwd) {
+async function extendConfig(config, opts) {
   config._layers = config._layers || [];
-  const extendSources = (Array.isArray(config.extends) ? config.extends : [config.extends]).filter(Boolean);
-  delete config.extends;
-  for (let extendSource of extendSources) {
-    if (GIT_PREFIXES.some((prefix) => extendSource.startsWith(prefix))) {
-      const url = new URL(extendSource);
-      const subPath = url.pathname.split("/").slice(2).join("/");
-      const gitRepo = url.protocol + url.pathname.split("/").slice(0, 2).join("/");
-      const tmpdir = resolve(os.tmpdir(), "c12/", gitRepo.replace(/[#:@/\\]/g, "_"));
-      await promises.rm(tmpdir, { recursive: true }).catch(() => {
-      });
-      const gittar = await import('gittar').then((r) => r.default || r);
-      const tarFile = await gittar.fetch(gitRepo);
-      await gittar.extract(tarFile, tmpdir);
-      extendSource = resolve(tmpdir, subPath);
-    }
-    const isDir = !extname(extendSource);
-    const _cwd = resolve(cwd, isDir ? extendSource : dirname(extendSource));
-    const _config = await loadConfigFile(_cwd, isDir ? configFile : extendSource);
+  if (!opts.extend) {
+    return;
+  }
+  const key = opts.extend.extendKey;
+  const extendSources = (Array.isArray(config[key]) ? config[key] : [config[key]]).filter(Boolean);
+  delete config[key];
+  for (const extendSource of extendSources) {
+    const _config = await resolveConfig(extendSource, opts);
     if (!_config.config) {
       continue;
     }
-    await extendConfig(_config.config, configFile, _cwd);
-    config._layers.push({
-      config: _config.config,
-      cwd: _cwd,
-      configFile: _config.configFile
-    });
+    await extendConfig(_config.config, { ...opts, cwd: _config.cwd });
+    config._layers.push(_config);
     if (_config.config._layers) {
       config._layers.push(..._config.config._layers);
       delete _config.config._layers;
     }
   }
 }
+const GIT_PREFIXES = ["github:", "gitlab:", "bitbucket:", "https://"];
 const jiti = createJiti(null, { cache: false, interopDefault: true });
-async function loadConfigFile(cwd, configFile) {
-  const res = {
-    configFile: null,
-    config: null
-  };
-  if (!configFile) {
-    return res;
+async function resolveConfig(source, opts) {
+  if (opts.resolve) {
+    const res2 = await opts.resolve(source, opts);
+    if (res2) {
+      return res2;
+    }
+  }
+  if (GIT_PREFIXES.some((prefix) => source.startsWith(prefix))) {
+    const url = new URL(source);
+    const subPath = url.pathname.split("/").slice(2).join("/");
+    const gitRepo = url.protocol + url.pathname.split("/").slice(0, 2).join("/");
+    const tmpdir = resolve(os.tmpdir(), "c12/", gitRepo.replace(/[#:@/\\]/g, "_"));
+    await promises.rm(tmpdir, { recursive: true }).catch(() => {
+    });
+    const gittar = await import('gittar').then((r) => r.default || r);
+    const tarFile = await gittar.fetch(gitRepo);
+    await gittar.extract(tarFile, tmpdir);
+    source = resolve(tmpdir, subPath);
+  }
+  const isDir = !extname(source);
+  const cwd = resolve(opts.cwd, isDir ? source : dirname(source));
+  if (isDir) {
+    source = opts.configFile;
   }
+  const res = { config: {}, cwd };
   try {
-    res.configFile = jiti.resolve(resolve(cwd, configFile), { paths: [cwd] });
+    res.configFile = jiti.resolve(resolve(cwd, source), { paths: [cwd] });
     res.config = jiti(res.configFile);
     if (typeof res.config === "function") {
       res.config = await res.config();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "c12",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "description": "Smart Config Loader",
   "repository": "unjs/c12",
   "license": "MIT",