c12 3.0.4 → 3.2.0

package/README.md

@@ -27,42 +27,24 @@ c12 (pronounced as /siːtwelv/, like c-twelve) is a smart configuration loader.
 ## 🦴 Used by
 
 - [Nuxt](https://nuxt.com/)
-- [Nitro](https://nitro.unjs.io/)
+- [Nitro](https://nitro.build/)
 - [Unbuild](https://unbuild.unjs.io)
 - [Automd](https://automd.unjs.io)
 - [Changelogen](https://changelogen.unjs.io)
 - [RemixKit](https://github.com/jrestall/remix-kit)
 - [Hey API](https://github.com/hey-api/openapi-ts)
 - [kysely-ctl](https://github.com/kysely-org/kysely-ctl)
+- [Prisma](https://github.com/prisma/prisma)
 
 ## Usage
 
 Install package:
 
-<!-- automd:pm-install -->
-
 ```sh
 # ✨ Auto-detect
 npx nypm install c12
-
-# npm
-npm install c12
-
-# yarn
-yarn add c12
-
-# pnpm
-pnpm install c12
-
-# bun
-bun install c12
-
-# deno
-deno install c12
 ```
 
-<!-- /automd -->
-
 Import:
 
 ```js
@@ -171,10 +153,17 @@ Environment name used for [environment specific configuration](#environment-spec
 
 The default is `process.env.NODE_ENV`. You can set `envName` to `false` or an empty string to disable the feature.
 
+### `context`
+
+Context object passed to dynamic config functions.
+
 ### `resolve`
 
 You can define a custom function that resolves the config.
 
+### `configFileRequired`
+
+If this option is set to `true`, loader fails if the main config file does not exists.
 
 ## Extending configuration
 
@@ -386,30 +375,11 @@ Update or create a new configuration files.
 
 Add `magicast` peer dependency:
 
-<!-- automd:pm-install name="magicast" dev -->
-
 ```sh
 # ✨ Auto-detect
 npx nypm install -D magicast
-
-# npm
-npm install -D magicast
-
-# yarn
-yarn add -D magicast
-
-# pnpm
-pnpm install -D magicast
-
-# bun
-bun install -D magicast
-
-# deno
-deno install --dev magicast
 ```
 
-<!-- /automd -->
-
 Import util from `c12/update`
 
 ```js
@@ -430,6 +400,28 @@ const { configFile, created } = await updateConfig({
 console.log(`Config file ${created ? "created" : "updated"} in ${configFile}`);
 ```
 
+## Configuration functions
+
+You can use a function to define your configuration dynamically based on context.
+
+```ts
+// config.ts
+export default (ctx) => {
+  return {
+    apiUrl: ctx?.dev ? "http://localhost:3000" : "https://api.example.com",
+  };
+};
+```
+
+```ts
+// Usage
+import { loadConfig } from "c12";
+
+const config = await loadConfig({
+  context: { dev: true },
+});
+```
+
 ## Contribution
 
 <details>

package/dist/index.d.mts

@@ -9,10 +9,11 @@ interface DotenvOptions {
      */
     cwd: string;
     /**
-     * What file to look in for environment variables (either absolute or relative
+     * What file or files to look in for environment variables (either absolute or relative
      * to the current working directory). For example, `.env`.
+     * With the array type, the order enforce the env loading priority (last one overrides).
      */
-    fileName?: string;
+    fileName?: string | string[];
     /**
      * Whether to interpolate variables within .env.
      *
@@ -92,9 +93,15 @@ interface ResolvedConfig<T extends UserInputConfig = UserInputConfig, MT extends
     config: T;
     layers?: ConfigLayer<T, MT>[];
     cwd?: string;
+    _configFile?: string;
+}
+type ConfigSource = "overrides" | "main" | "rc" | "packageJson" | "defaultConfig";
+interface ConfigFunctionContext {
+    [key: string]: any;
 }
 interface ResolvableConfigContext<T extends UserInputConfig = UserInputConfig> {
-    configs: Record<"overrides" | "main" | "rc" | "packageJson" | "defaultConfig", T | null | undefined>;
+    configs: Record<ConfigSource, T | null | undefined>;
+    rawConfigs: Record<ConfigSource, ResolvableConfig<T> | null | undefined>;
 }
 type MaybePromise<T> = T | Promise<T>;
 type ResolvableConfig<T extends UserInputConfig = UserInputConfig> = MaybePromise<T | null | undefined> | ((ctx: ResolvableConfigContext<T>) => MaybePromise<T | null | undefined>);
@@ -111,6 +118,8 @@ interface LoadConfigOptions<T extends UserInputConfig = UserInputConfig, MT exte
     defaultConfig?: ResolvableConfig<T>;
     overrides?: ResolvableConfig<T>;
     omit$Keys?: boolean;
+    /** Context passed to config functions */
+    context?: ConfigFunctionContext;
     resolve?: (id: string, options: LoadConfigOptions<T, MT>) => null | undefined | ResolvedConfig<T, MT> | Promise<ResolvedConfig<T, MT> | undefined | null>;
     jiti?: Jiti;
     jitiOptions?: JitiOptions;
@@ -119,6 +128,7 @@ interface LoadConfigOptions<T extends UserInputConfig = UserInputConfig, MT exte
     extend?: false | {
         extendKey?: string | string[];
     };
+    configFileRequired?: boolean;
 }
 type DefineConfig<T extends UserInputConfig = UserInputConfig, MT extends ConfigLayerMeta = ConfigLayerMeta> = (input: InputConfig<T, MT>) => InputConfig<T, MT>;
 declare function createDefineConfig<T extends UserInputConfig = UserInputConfig, MT extends ConfigLayerMeta = ConfigLayerMeta>(): DefineConfig<T, MT>;
@@ -152,4 +162,4 @@ interface WatchConfigOptions<T extends UserInputConfig = UserInputConfig, MT ext
 declare function watchConfig<T extends UserInputConfig = UserInputConfig, MT extends ConfigLayerMeta = ConfigLayerMeta>(options: WatchConfigOptions<T, MT>): Promise<ConfigWatcher<T, MT>>;
 
 export { SUPPORTED_EXTENSIONS, createDefineConfig, loadConfig, loadDotenv, setupDotenv, watchConfig };
-export type { C12InputConfig, ConfigLayer, ConfigLayerMeta, ConfigWatcher, DefineConfig, DotenvOptions, Env, InputConfig, LoadConfigOptions, ResolvableConfig, ResolvableConfigContext, ResolvedConfig, SourceOptions, UserInputConfig, WatchConfigOptions };
+export type { C12InputConfig, ConfigFunctionContext, ConfigLayer, ConfigLayerMeta, ConfigSource, ConfigWatcher, DefineConfig, DotenvOptions, Env, InputConfig, LoadConfigOptions, ResolvableConfig, ResolvableConfigContext, ResolvedConfig, SourceOptions, UserInputConfig, WatchConfigOptions };

package/dist/index.mjs

@@ -1,5 +1,5 @@
-import { l as loadConfig, S as SUPPORTED_EXTENSIONS } from './shared/c12.CEGFwQZa.mjs';
-export { a as loadDotenv, s as setupDotenv } from './shared/c12.CEGFwQZa.mjs';
+import { l as loadConfig, S as SUPPORTED_EXTENSIONS } from './shared/c12.DDjD4HmS.mjs';
+export { a as loadDotenv, s as setupDotenv } from './shared/c12.DDjD4HmS.mjs';
 import { debounce } from 'perfect-debounce';
 import { resolve } from 'pathe';
 import 'node:fs';

package/dist/shared/{c12.CEGFwQZa.mjs → c12.DDjD4HmS.mjs}

@@ -31,10 +31,15 @@ async function setupDotenv(options) {
 }
 async function loadDotenv(options) {
   const environment = /* @__PURE__ */ Object.create(null);
-  const dotenvFile = resolve(options.cwd, options.fileName);
+  const _fileName = options.fileName || ".env";
+  const dotenvFiles = typeof _fileName === "string" ? [_fileName] : _fileName;
   const dotenvVars = getDotEnvVars(options.env || {});
   Object.assign(environment, options.env);
-  if (statSync(dotenvFile, { throwIfNoEntry: false })?.isFile()) {
+  for (const file of dotenvFiles) {
+    const dotenvFile = resolve(options.cwd, file);
+    if (!statSync(dotenvFile, { throwIfNoEntry: false })?.isFile()) {
+      continue;
+    }
     const parsed = dotenv.parse(await promises.readFile(dotenvFile, "utf8"));
     for (const key in parsed) {
       if (key in environment && !dotenvVars.has(key)) {
@@ -144,9 +149,10 @@ async function loadConfig(options) {
     config: {},
     cwd: options.cwd,
     configFile: resolve(options.cwd, options.configFile),
-    layers: []
+    layers: [],
+    _configFile: void 0
   };
-  const _configs = {
+  const rawConfigs = {
     overrides: options.overrides,
     main: void 0,
     rc: void 0,
@@ -161,8 +167,9 @@ async function loadConfig(options) {
   }
   const _mainConfig = await resolveConfig(".", options);
   if (_mainConfig.configFile) {
-    _configs.main = _mainConfig.config;
+    rawConfigs.main = _mainConfig.config;
     r.configFile = _mainConfig.configFile;
+    r._configFile = _mainConfig._configFile;
   }
   if (_mainConfig.meta) {
     r.meta = _mainConfig.meta;
@@ -178,7 +185,7 @@ async function loadConfig(options) {
       }
       rcSources.push(rc9.readUser({ name: options.rcFile, dir: options.cwd }));
     }
-    _configs.rc = _merger({}, ...rcSources);
+    rawConfigs.rc = _merger({}, ...rcSources);
   }
   if (options.packageJson) {
     const keys = (Array.isArray(options.packageJson) ? options.packageJson : [
@@ -187,12 +194,12 @@ async function loadConfig(options) {
     const pkgJsonFile = await readPackageJSON(options.cwd).catch(() => {
     });
     const values = keys.map((key) => pkgJsonFile?.[key]);
-    _configs.packageJson = _merger({}, ...values);
+    rawConfigs.packageJson = _merger({}, ...values);
   }
   const configs = {};
-  for (const key in _configs) {
-    const value = _configs[key];
-    configs[key] = await (typeof value === "function" ? value({ configs }) : value);
+  for (const key in rawConfigs) {
+    const value = rawConfigs[key];
+    configs[key] = await (typeof value === "function" ? value({ configs, rawConfigs }) : value);
   }
   r.config = _merger(
     configs.overrides,
@@ -231,6 +238,9 @@ async function loadConfig(options) {
       }
     }
   }
+  if (options.configFileRequired && !r._configFile) {
+    throw new Error(`Required config (${r.configFile}) cannot be resolved.`);
+  }
   return r;
 }
 async function extendConfig(config, options) {
@@ -356,6 +366,7 @@ async function resolveConfig(source, options, sourceOptions = {}) {
   if (!existsSync(res.configFile)) {
     return res;
   }
+  res._configFile = res.configFile;
   const configFileExt = extname(res.configFile) || "";
   if (configFileExt in ASYNC_LOADERS) {
     const asyncLoader = await ASYNC_LOADERS[configFileExt]();
@@ -366,8 +377,8 @@ async function resolveConfig(source, options, sourceOptions = {}) {
       default: true
     });
   }
-  if (res.config instanceof Function) {
-    res.config = await res.config();
+  if (typeof res.config === "function") {
+    res.config = await res.config(options.context);
   }
   if (options.envName) {
     const envConfig = {

package/dist/update.mjs

@@ -1,5 +1,5 @@
 import { resolveModulePath } from 'exsolve';
-import { S as SUPPORTED_EXTENSIONS } from './shared/c12.CEGFwQZa.mjs';
+import { S as SUPPORTED_EXTENSIONS } from './shared/c12.DDjD4HmS.mjs';
 import { join, normalize } from 'pathe';
 import { mkdir, writeFile, readFile } from 'node:fs/promises';
 import { dirname, extname } from 'node:path';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "c12",
-  "version": "3.0.4",
+  "version": "3.2.0",
   "description": "Smart Config Loader",
   "repository": "unjs/c12",
   "license": "MIT",
@@ -34,29 +34,29 @@
     "chokidar": "^4.0.3",
     "confbox": "^0.2.2",
     "defu": "^6.1.4",
-    "dotenv": "^16.5.0",
-    "exsolve": "^1.0.5",
+    "dotenv": "^17.2.1",
+    "exsolve": "^1.0.7",
     "giget": "^2.0.0",
-    "jiti": "^2.4.2",
+    "jiti": "^2.5.1",
     "ohash": "^2.0.11",
     "pathe": "^2.0.3",
     "perfect-debounce": "^1.0.0",
-    "pkg-types": "^2.1.0",
+    "pkg-types": "^2.2.0",
     "rc9": "^2.1.2"
   },
   "devDependencies": {
-    "@types/node": "^22.15.18",
-    "@vitest/coverage-v8": "^3.1.3",
+    "@types/node": "^24.1.0",
+    "@vitest/coverage-v8": "^3.2.4",
     "automd": "^0.4.0",
-    "changelogen": "^0.6.1",
-    "eslint": "^9.27.0",
-    "eslint-config-unjs": "^0.4.2",
-    "expect-type": "^1.2.1",
+    "changelogen": "^0.6.2",
+    "eslint": "^9.32.0",
+    "eslint-config-unjs": "^0.5.0",
+    "expect-type": "^1.2.2",
     "magicast": "^0.3.5",
-    "prettier": "^3.5.3",
+    "prettier": "^3.6.2",
     "typescript": "^5.8.3",
-    "unbuild": "^3.5.0",
-    "vitest": "^3.1.3"
+    "unbuild": "^3.6.0",
+    "vitest": "^3.2.4"
   },
   "peerDependencies": {
     "magicast": "^0.3.5"
@@ -66,5 +66,5 @@
       "optional": true
     }
   },
-  "packageManager": "pnpm@10.11.0"
+  "packageManager": "pnpm@10.13.1"
 }