c12 1.7.0 → 1.9.0

package/README.md

@@ -1,16 +1,20 @@
 # ⚙️ c12
 
-[![npm version][npm-version-src]][npm-version-href]
-[![npm downloads][npm-downloads-src]][npm-downloads-href]
-[![Codecov][codecov-src]][codecov-href]
-[![License][license-src]][license-href]
+<!-- automd:badges color=yellow codecov -->
+
+[![npm version](https://img.shields.io/npm/v/c12?color=yellow)](https://npmjs.com/package/c12)
+[![npm downloads](https://img.shields.io/npm/dm/c12?color=yellow)](https://npmjs.com/package/c12)
+[![codecov](https://img.shields.io/codecov/c/gh/unjs/c12?color=yellow)](https://codecov.io/gh/unjs/c12)
+
+<!-- /automd -->
 
 c12 (pronounced as /siːtwelv/, like c-twelve) is a smart configuration loader.
 
-## Features
+## ✅ Features
 
-- `.js`, `.ts`, `.cjs`, `.mjs` config loader with [unjs/jiti](https://github.com/unjs/jiti)
-- `.json`, `.json5` and `.jsonc` config support.
+- `.js`, `.ts`, `.mjs`, `.cjs`, `.mts`, `.cts` `.json` config loader with [unjs/jiti](https://jiti.unjs.io)
+- `.jsonc`, `.json5`, `.yaml`, `.yml`, `.toml` config loader with [unjs/confbox](https://confbox.unjs.io)
+- `.config/` directory support following [config dir proposal](https://github.com/pi0/config-dir)
 - `.rc` config support with [unjs/rc9](https://github.com/unjs/rc9)
 - `.env` support with [dotenv](https://www.npmjs.com/package/dotenv)
 - Multiple sources merged with [unjs/defu](https://github.com/unjs/defu)
@@ -19,21 +23,40 @@ c12 (pronounced as /siːtwelv/, like c-twelve) is a smart configuration loader.
 - Overwrite with [environment-specific configuration](#environment-specific-configuration)
 - Config watcher with auto-reload and HMR support
 
+## 🦴 Used by
+
+- [Nuxt](https://nuxt.com/)
+- [Nitro](https://nitro.unjs.io/)
+- [Unbuild](https://unbuild.unjs.io)
+- [Automd](https://automd.unjs.io)
+- [Changelogen](https://changelogen.unjs.io)
+- [RemixKit](https://github.com/jrestall/remix-kit)
+
 ## Usage
 
 Install package:
 
+<!-- automd:pm-install -->
+
 ```sh
+# ✨ Auto-detect
+npx nypm i c12@^1.7.0
+
 # npm
-npm install c12
+npm install c12@^1.7.0
 
 # yarn
-yarn add c12
+yarn add c12@^1.7.0
 
 # pnpm
-pnpm install c12
+pnpm install c12@^1.7.0
+
+# bun
+bun install c12@^1.7.0
 ```
 
+<!-- /automd -->
+
 Import:
 
 ```js

package/dist/index.cjs

@@ -10,7 +10,6 @@ const rc9 = require('rc9');
 const defu = require('defu');
 const ohash = require('ohash');
 const pkgTypes = require('pkg-types');
-const chokidar = require('chokidar');
 const perfectDebounce = require('perfect-debounce');
 
 function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e.default : e; }
@@ -104,6 +103,29 @@ function interpolate(target, source = {}, parse = (v) => v) {
 }
 
 const _normalize = (p) => p?.replace(/\\/g, "/");
+const ASYNC_LOADERS = {
+  ".yaml": () => import('confbox/yaml').then((r) => r.parseYAML),
+  ".yml": () => import('confbox/yaml').then((r) => r.parseYAML),
+  ".jsonc": () => import('confbox/jsonc').then((r) => r.parseJSONC),
+  ".json5": () => import('confbox/json5').then((r) => r.parseJSON5),
+  ".toml": () => import('confbox/toml').then((r) => r.parseTOML)
+};
+const SUPPORTED_EXTENSIONS = [
+  // with jiti
+  ".js",
+  ".ts",
+  ".mjs",
+  ".cjs",
+  ".mts",
+  ".cts",
+  ".json",
+  // with confbox
+  ".jsonc",
+  ".json5",
+  ".yaml",
+  ".yml",
+  ".toml"
+];
 async function loadConfig(options) {
   options.cwd = pathe.resolve(process.cwd(), options.cwd || ".");
   options.name = options.name || "config";
@@ -120,17 +142,7 @@ async function loadConfig(options) {
     interopDefault: true,
     requireCache: false,
     esmResolve: true,
-    extensions: [
-      ".js",
-      ".mjs",
-      ".cjs",
-      ".ts",
-      ".mts",
-      ".cts",
-      ".json",
-      ".jsonc",
-      ".json5"
-    ],
+    extensions: [...SUPPORTED_EXTENSIONS],
     ...options.jitiOptions
   });
   const r = {
@@ -151,24 +163,17 @@ async function loadConfig(options) {
   }
   const configRC = {};
   if (options.rcFile) {
+    const rcSources = [];
+    rcSources.push(rc9__namespace.read({ name: options.rcFile, dir: options.cwd }));
     if (options.globalRc) {
-      Object.assign(
-        configRC,
-        rc9__namespace.readUser({ name: options.rcFile, dir: options.cwd })
-      );
       const workspaceDir = await pkgTypes.findWorkspaceDir(options.cwd).catch(() => {
       });
       if (workspaceDir) {
-        Object.assign(
-          configRC,
-          rc9__namespace.read({ name: options.rcFile, dir: workspaceDir })
-        );
+        rcSources.push(rc9__namespace.read({ name: options.rcFile, dir: workspaceDir }));
       }
+      rcSources.push(rc9__namespace.readUser({ name: options.rcFile, dir: options.cwd }));
     }
-    Object.assign(
-      configRC,
-      rc9__namespace.read({ name: options.rcFile, dir: options.cwd })
-    );
+    Object.assign(configRC, defu.defu({}, ...rcSources));
   }
   const pkgJson = {};
   if (options.packageJson) {
@@ -309,11 +314,14 @@ async function resolveConfig(source, options, sourceOptions = {}) {
     });
     source = cloned.dir;
   }
-  if (NPM_PACKAGE_RE.test(source)) {
+  const tryResolve = (id) => {
     try {
-      source = options.jiti.resolve(source, { paths: [options.cwd] });
+      return options.jiti.resolve(id, { paths: [options.cwd] });
     } catch {
     }
+  };
+  if (NPM_PACKAGE_RE.test(source)) {
+    source = tryResolve(source) || source;
   }
   const ext = pathe.extname(source);
   const isDir = !ext || ext === pathe.basename(source);
@@ -323,25 +331,20 @@ async function resolveConfig(source, options, sourceOptions = {}) {
   }
   const res = {
     config: void 0,
+    configFile: void 0,
     cwd,
     source,
     sourceOptions
   };
-  try {
-    res.configFile = options.jiti.resolve(pathe.resolve(cwd, source), {
-      paths: [cwd]
-    });
-  } catch {
-  }
+  res.configFile = tryResolve(pathe.resolve(cwd, source)) || tryResolve(pathe.resolve(cwd, ".config", source.replace(/\.config$/, ""))) || tryResolve(pathe.resolve(cwd, ".config", source)) || source;
   if (!node_fs.existsSync(res.configFile)) {
     return res;
   }
-  if (res.configFile.endsWith(".jsonc")) {
-    const { parse } = await import('jsonc-parser');
-    res.config = parse(await promises.readFile(res.configFile, "utf8"));
-  } else if (res.configFile.endsWith(".json5")) {
-    const { parse } = await import('json5');
-    res.config = parse(await promises.readFile(res.configFile, "utf8"));
+  const configFileExt = pathe.extname(res.configFile) || "";
+  if (configFileExt in ASYNC_LOADERS) {
+    const asyncLoader = await ASYNC_LOADERS[configFileExt]();
+    const contents = await promises.readFile(res.configFile, "utf8");
+    res.config = asyncLoader(contents);
   } else {
     res.config = options.jiti(res.configFile);
   }
@@ -383,9 +386,15 @@ async function watchConfig(options) {
   const watchingFiles = [
     ...new Set(
       (config.layers || []).filter((l) => l.cwd).flatMap((l) => [
-        ...["ts", "js", "mjs", "cjs", "cts", "mts", "json"].map(
-          (ext) => pathe.resolve(l.cwd, configFileName + "." + ext)
-        ),
+        ...SUPPORTED_EXTENSIONS.flatMap((ext) => [
+          pathe.resolve(l.cwd, configFileName + ext),
+          pathe.resolve(l.cwd, ".config", configFileName + ext),
+          pathe.resolve(
+            l.cwd,
+            ".config",
+            configFileName.replace(/\.config$/, "") + ext
+          )
+        ]),
         l.source && pathe.resolve(l.cwd, l.source),
         // TODO: Support watching rc from home and workspace
         options.rcFile && pathe.resolve(
@@ -396,7 +405,8 @@ async function watchConfig(options) {
       ]).filter(Boolean)
     )
   ];
-  const _fswatcher = chokidar.watch(watchingFiles, {
+  const watch = await import('chokidar').then((r) => r.watch || r.default || r);
+  const _fswatcher = watch(watchingFiles, {
     ignoreInitial: true,
     ...options.chokidarOptions
   });
@@ -450,6 +460,7 @@ async function watchConfig(options) {
   });
 }
 
+exports.SUPPORTED_EXTENSIONS = SUPPORTED_EXTENSIONS;
 exports.createDefineConfig = createDefineConfig;
 exports.loadConfig = loadConfig;
 exports.loadDotenv = loadDotenv;

package/dist/index.d.cts

@@ -96,6 +96,7 @@ interface LoadConfigOptions<T extends UserInputConfig = UserInputConfig, MT exte
 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>;
 
+declare const SUPPORTED_EXTENSIONS: readonly [".js", ".ts", ".mjs", ".cjs", ".mts", ".cts", ".json", ".jsonc", ".json5", ".yaml", ".yml", ".toml"];
 declare function loadConfig<T extends UserInputConfig = UserInputConfig, MT extends ConfigLayerMeta = ConfigLayerMeta>(options: LoadConfigOptions<T, MT>): Promise<ResolvedConfig<T, MT>>;
 
 type ConfigWatcher<T extends UserInputConfig = UserInputConfig, MT extends ConfigLayerMeta = ConfigLayerMeta> = ResolvedConfig<T, MT> & {
@@ -122,4 +123,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 { type C12InputConfig, type ConfigLayer, type ConfigLayerMeta, type ConfigWatcher, type DefineConfig, type DotenvOptions, type Env, type InputConfig, type LoadConfigOptions, type ResolvedConfig, type SourceOptions, type UserInputConfig, type WatchConfigOptions, createDefineConfig, loadConfig, loadDotenv, setupDotenv, watchConfig };
+export { type C12InputConfig, type ConfigLayer, type ConfigLayerMeta, type ConfigWatcher, type DefineConfig, type DotenvOptions, type Env, type InputConfig, type LoadConfigOptions, type ResolvedConfig, SUPPORTED_EXTENSIONS, type SourceOptions, type UserInputConfig, type WatchConfigOptions, createDefineConfig, loadConfig, loadDotenv, setupDotenv, watchConfig };

package/dist/index.d.mts

@@ -96,6 +96,7 @@ interface LoadConfigOptions<T extends UserInputConfig = UserInputConfig, MT exte
 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>;
 
+declare const SUPPORTED_EXTENSIONS: readonly [".js", ".ts", ".mjs", ".cjs", ".mts", ".cts", ".json", ".jsonc", ".json5", ".yaml", ".yml", ".toml"];
 declare function loadConfig<T extends UserInputConfig = UserInputConfig, MT extends ConfigLayerMeta = ConfigLayerMeta>(options: LoadConfigOptions<T, MT>): Promise<ResolvedConfig<T, MT>>;
 
 type ConfigWatcher<T extends UserInputConfig = UserInputConfig, MT extends ConfigLayerMeta = ConfigLayerMeta> = ResolvedConfig<T, MT> & {
@@ -122,4 +123,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 { type C12InputConfig, type ConfigLayer, type ConfigLayerMeta, type ConfigWatcher, type DefineConfig, type DotenvOptions, type Env, type InputConfig, type LoadConfigOptions, type ResolvedConfig, type SourceOptions, type UserInputConfig, type WatchConfigOptions, createDefineConfig, loadConfig, loadDotenv, setupDotenv, watchConfig };
+export { type C12InputConfig, type ConfigLayer, type ConfigLayerMeta, type ConfigWatcher, type DefineConfig, type DotenvOptions, type Env, type InputConfig, type LoadConfigOptions, type ResolvedConfig, SUPPORTED_EXTENSIONS, type SourceOptions, type UserInputConfig, type WatchConfigOptions, createDefineConfig, loadConfig, loadDotenv, setupDotenv, watchConfig };

package/dist/index.d.ts

@@ -96,6 +96,7 @@ interface LoadConfigOptions<T extends UserInputConfig = UserInputConfig, MT exte
 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>;
 
+declare const SUPPORTED_EXTENSIONS: readonly [".js", ".ts", ".mjs", ".cjs", ".mts", ".cts", ".json", ".jsonc", ".json5", ".yaml", ".yml", ".toml"];
 declare function loadConfig<T extends UserInputConfig = UserInputConfig, MT extends ConfigLayerMeta = ConfigLayerMeta>(options: LoadConfigOptions<T, MT>): Promise<ResolvedConfig<T, MT>>;
 
 type ConfigWatcher<T extends UserInputConfig = UserInputConfig, MT extends ConfigLayerMeta = ConfigLayerMeta> = ResolvedConfig<T, MT> & {
@@ -122,4 +123,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 { type C12InputConfig, type ConfigLayer, type ConfigLayerMeta, type ConfigWatcher, type DefineConfig, type DotenvOptions, type Env, type InputConfig, type LoadConfigOptions, type ResolvedConfig, type SourceOptions, type UserInputConfig, type WatchConfigOptions, createDefineConfig, loadConfig, loadDotenv, setupDotenv, watchConfig };
+export { type C12InputConfig, type ConfigLayer, type ConfigLayerMeta, type ConfigWatcher, type DefineConfig, type DotenvOptions, type Env, type InputConfig, type LoadConfigOptions, type ResolvedConfig, SUPPORTED_EXTENSIONS, type SourceOptions, type UserInputConfig, type WatchConfigOptions, createDefineConfig, loadConfig, loadDotenv, setupDotenv, watchConfig };

package/dist/index.mjs

@@ -8,7 +8,6 @@ import * as rc9 from 'rc9';
 import { defu } from 'defu';
 import { hash, diff } from 'ohash';
 import { findWorkspaceDir, readPackageJSON } from 'pkg-types';
-import { watch } from 'chokidar';
 import { debounce } from 'perfect-debounce';
 
 async function setupDotenv(options) {
@@ -84,6 +83,29 @@ function interpolate(target, source = {}, parse = (v) => v) {
 }
 
 const _normalize = (p) => p?.replace(/\\/g, "/");
+const ASYNC_LOADERS = {
+  ".yaml": () => import('confbox/yaml').then((r) => r.parseYAML),
+  ".yml": () => import('confbox/yaml').then((r) => r.parseYAML),
+  ".jsonc": () => import('confbox/jsonc').then((r) => r.parseJSONC),
+  ".json5": () => import('confbox/json5').then((r) => r.parseJSON5),
+  ".toml": () => import('confbox/toml').then((r) => r.parseTOML)
+};
+const SUPPORTED_EXTENSIONS = [
+  // with jiti
+  ".js",
+  ".ts",
+  ".mjs",
+  ".cjs",
+  ".mts",
+  ".cts",
+  ".json",
+  // with confbox
+  ".jsonc",
+  ".json5",
+  ".yaml",
+  ".yml",
+  ".toml"
+];
 async function loadConfig(options) {
   options.cwd = resolve(process.cwd(), options.cwd || ".");
   options.name = options.name || "config";
@@ -100,17 +122,7 @@ async function loadConfig(options) {
     interopDefault: true,
     requireCache: false,
     esmResolve: true,
-    extensions: [
-      ".js",
-      ".mjs",
-      ".cjs",
-      ".ts",
-      ".mts",
-      ".cts",
-      ".json",
-      ".jsonc",
-      ".json5"
-    ],
+    extensions: [...SUPPORTED_EXTENSIONS],
     ...options.jitiOptions
   });
   const r = {
@@ -131,24 +143,17 @@ async function loadConfig(options) {
   }
   const configRC = {};
   if (options.rcFile) {
+    const rcSources = [];
+    rcSources.push(rc9.read({ name: options.rcFile, dir: options.cwd }));
     if (options.globalRc) {
-      Object.assign(
-        configRC,
-        rc9.readUser({ name: options.rcFile, dir: options.cwd })
-      );
       const workspaceDir = await findWorkspaceDir(options.cwd).catch(() => {
       });
       if (workspaceDir) {
-        Object.assign(
-          configRC,
-          rc9.read({ name: options.rcFile, dir: workspaceDir })
-        );
+        rcSources.push(rc9.read({ name: options.rcFile, dir: workspaceDir }));
       }
+      rcSources.push(rc9.readUser({ name: options.rcFile, dir: options.cwd }));
     }
-    Object.assign(
-      configRC,
-      rc9.read({ name: options.rcFile, dir: options.cwd })
-    );
+    Object.assign(configRC, defu({}, ...rcSources));
   }
   const pkgJson = {};
   if (options.packageJson) {
@@ -289,11 +294,14 @@ async function resolveConfig(source, options, sourceOptions = {}) {
     });
     source = cloned.dir;
   }
-  if (NPM_PACKAGE_RE.test(source)) {
+  const tryResolve = (id) => {
     try {
-      source = options.jiti.resolve(source, { paths: [options.cwd] });
+      return options.jiti.resolve(id, { paths: [options.cwd] });
     } catch {
     }
+  };
+  if (NPM_PACKAGE_RE.test(source)) {
+    source = tryResolve(source) || source;
   }
   const ext = extname(source);
   const isDir = !ext || ext === basename(source);
@@ -303,25 +311,20 @@ async function resolveConfig(source, options, sourceOptions = {}) {
   }
   const res = {
     config: void 0,
+    configFile: void 0,
     cwd,
     source,
     sourceOptions
   };
-  try {
-    res.configFile = options.jiti.resolve(resolve(cwd, source), {
-      paths: [cwd]
-    });
-  } catch {
-  }
+  res.configFile = tryResolve(resolve(cwd, source)) || tryResolve(resolve(cwd, ".config", source.replace(/\.config$/, ""))) || tryResolve(resolve(cwd, ".config", source)) || source;
   if (!existsSync(res.configFile)) {
     return res;
   }
-  if (res.configFile.endsWith(".jsonc")) {
-    const { parse } = await import('jsonc-parser');
-    res.config = parse(await readFile(res.configFile, "utf8"));
-  } else if (res.configFile.endsWith(".json5")) {
-    const { parse } = await import('json5');
-    res.config = parse(await readFile(res.configFile, "utf8"));
+  const configFileExt = extname(res.configFile) || "";
+  if (configFileExt in ASYNC_LOADERS) {
+    const asyncLoader = await ASYNC_LOADERS[configFileExt]();
+    const contents = await readFile(res.configFile, "utf8");
+    res.config = asyncLoader(contents);
   } else {
     res.config = options.jiti(res.configFile);
   }
@@ -363,9 +366,15 @@ async function watchConfig(options) {
   const watchingFiles = [
     ...new Set(
       (config.layers || []).filter((l) => l.cwd).flatMap((l) => [
-        ...["ts", "js", "mjs", "cjs", "cts", "mts", "json"].map(
-          (ext) => resolve(l.cwd, configFileName + "." + ext)
-        ),
+        ...SUPPORTED_EXTENSIONS.flatMap((ext) => [
+          resolve(l.cwd, configFileName + ext),
+          resolve(l.cwd, ".config", configFileName + ext),
+          resolve(
+            l.cwd,
+            ".config",
+            configFileName.replace(/\.config$/, "") + ext
+          )
+        ]),
         l.source && resolve(l.cwd, l.source),
         // TODO: Support watching rc from home and workspace
         options.rcFile && resolve(
@@ -376,6 +385,7 @@ async function watchConfig(options) {
       ]).filter(Boolean)
     )
   ];
+  const watch = await import('chokidar').then((r) => r.watch || r.default || r);
   const _fswatcher = watch(watchingFiles, {
     ignoreInitial: true,
     ...options.chokidarOptions
@@ -430,4 +440,4 @@ async function watchConfig(options) {
   });
 }
 
-export { createDefineConfig, loadConfig, loadDotenv, setupDotenv, watchConfig };
+export { SUPPORTED_EXTENSIONS, createDefineConfig, loadConfig, loadDotenv, setupDotenv, watchConfig };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "c12",
-  "version": "1.7.0",
+  "version": "1.9.0",
   "description": "Smart Config Loader",
   "repository": "unjs/c12",
   "license": "MIT",
@@ -31,12 +31,11 @@
   },
   "dependencies": {
     "chokidar": "^3.5.3",
+    "confbox": "^0.1.3",
     "defu": "^6.1.4",
     "dotenv": "^16.3.2",
     "giget": "^1.2.1",
     "jiti": "^1.21.0",
-    "json5": "^2.2.3",
-    "jsonc-parser": "^3.2.1",
     "mlly": "^1.5.0",
     "ohash": "^1.1.3",
     "pathe": "^1.1.2",
@@ -47,6 +46,7 @@
   "devDependencies": {
     "@types/node": "^20.11.5",
     "@vitest/coverage-v8": "^1.2.1",
+    "automd": "^0.2.0",
     "changelogen": "^0.5.5",
     "eslint": "^8.56.0",
     "eslint-config-unjs": "^0.2.1",