c12 1.2.0 → 1.3.0

package/README.md

@@ -1,11 +1,11 @@
-# c12
+# ⚙️ c12
 
 [![npm version][npm-version-src]][npm-version-href]
 [![npm downloads][npm-downloads-src]][npm-downloads-href]
-[![Github Actions][github-actions-src]][github-actions-href]
 [![Codecov][codecov-src]][codecov-href]
+[![License][license-src]][license-href]
 
-> Smart Configuration Loader
+Smart Configuration Loader.
 
 ## Features
 
@@ -13,8 +13,9 @@
 - 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 reading config from the nearest `package.json` file
-- Support extending nested configurations from multiple local or git sources
+- Reads config from the nearest `package.json` file
+- [Extends configurations](https://github.com/unjs/c12#extending-configuration) from multiple local or git sources
+- Overwrite with [environment-specific configuration](#environment-specific-configuration)
 
 ## Usage
 
@@ -246,11 +247,11 @@ Made with 💛 Published under [MIT License](./LICENSE).
 
 <!-- Badges -->
 
-[npm-version-src]: https://img.shields.io/npm/v/c12?style=flat-square
+[npm-version-src]: https://img.shields.io/npm/v/c12?style=flat&colorA=18181B&colorB=F0DB4F
 [npm-version-href]: https://npmjs.com/package/c12
-[npm-downloads-src]: https://img.shields.io/npm/dm/c12?style=flat-square
+[npm-downloads-src]: https://img.shields.io/npm/dm/c12?style=flat&colorA=18181B&colorB=F0DB4F
 [npm-downloads-href]: https://npmjs.com/package/c12
-[github-actions-src]: https://img.shields.io/github/actions/workflow/status/unjs/c12/ci.yml?branch=main&style=flat-square
-[github-actions-href]: https://github.com/unjs/c12/actions?query=workflow%3Aci
-[codecov-src]: https://img.shields.io/codecov/c/gh/unjs/c12/main?style=flat-square
+[codecov-src]: https://img.shields.io/codecov/c/gh/unjs/c12/main?style=flat&colorA=18181B&colorB=F0DB4F
 [codecov-href]: https://codecov.io/gh/unjs/c12
+[license-src]: https://img.shields.io/github/license/unjs/c12.svg?style=flat&colorA=18181B&colorB=F0DB4F
+[license-href]: https://github.com/unjs/c12/blob/main/LICENSE

package/dist/index.cjs

@@ -10,7 +10,10 @@ const rc9 = require('rc9');
 const defu = require('defu');
 const pkgTypes = require('pkg-types');
 
-function _interopNamespaceDefault(e) {
+function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e.default : e; }
+
+function _interopNamespaceCompat(e) {
+  if (e && typeof e === 'object' && 'default' in e) return e;
   const n = Object.create(null);
   if (e) {
     for (const k in e) {
@@ -21,8 +24,9 @@ function _interopNamespaceDefault(e) {
   return n;
 }
 
-const dotenv__namespace = /*#__PURE__*/_interopNamespaceDefault(dotenv);
-const rc9__namespace = /*#__PURE__*/_interopNamespaceDefault(rc9);
+const dotenv__namespace = /*#__PURE__*/_interopNamespaceCompat(dotenv);
+const createJiti__default = /*#__PURE__*/_interopDefaultCompat(createJiti);
+const rc9__namespace = /*#__PURE__*/_interopNamespaceCompat(rc9);
 
 async function setupDotenv(options) {
   const targetEnvironment = options.env ?? process.env;
@@ -46,7 +50,7 @@ async function loadDotenv(options) {
     const parsed = dotenv__namespace.parse(await node_fs.promises.readFile(dotenvFile, "utf8"));
     Object.assign(environment, parsed);
   }
-  if (!options.env._applied) {
+  if (!options.env?._applied) {
     Object.assign(environment, options.env);
     environment._applied = true;
   }
@@ -67,15 +71,15 @@ function interpolate(target, source = {}, parse = (v) => v) {
     return parse(
       // eslint-disable-next-line unicorn/no-array-reduce
       matches.reduce((newValue, match) => {
-        const parts = /(.?)\${?([\w:]+)?}?/g.exec(match);
+        const parts = /(.?)\${?([\w:]+)?}?/g.exec(match) || [];
         const prefix = parts[1];
         let value2, replacePart;
         if (prefix === "\\") {
-          replacePart = parts[0];
+          replacePart = parts[0] || "";
           value2 = replacePart.replace("\\$", "$");
         } else {
           const key = parts[2];
-          replacePart = parts[0].slice(prefix.length);
+          replacePart = (parts[0] || "").slice(prefix.length);
           if (parents.includes(key)) {
             console.warn(
               `Please avoid recursive environment variables ( loop: ${parents.join(
@@ -108,7 +112,7 @@ async function loadConfig(options) {
       ...options.extend
     };
   }
-  options.jiti = options.jiti || createJiti(void 0, {
+  options.jiti = options.jiti || createJiti__default(void 0, {
     interopDefault: true,
     requireCache: false,
     esmResolve: true,
@@ -258,7 +262,7 @@ async function resolveConfig(source, options, sourceOptions = {}) {
     const name = gitRepo.replace(/[#/:@\\]/g, "_");
     const tmpDir = process.env.XDG_CACHE_HOME ? pathe.resolve(process.env.XDG_CACHE_HOME, "c12", name) : pathe.resolve(node_os.homedir(), ".cache/c12", name);
     if (node_fs.existsSync(tmpDir)) {
-      await promises.rmdir(tmpDir, { recursive: true });
+      await promises.rm(tmpDir, { recursive: true });
     }
     const cloned = await downloadTemplate(source, { dir: tmpDir });
     source = cloned.dir;
@@ -274,7 +278,12 @@ async function resolveConfig(source, options, sourceOptions = {}) {
   if (isDir) {
     source = options.configFile;
   }
-  const res = { config: void 0, cwd, source, sourceOptions };
+  const res = {
+    config: void 0,
+    cwd,
+    source,
+    sourceOptions
+  };
   try {
     res.configFile = options.jiti.resolve(pathe.resolve(cwd, source), {
       paths: [cwd]
@@ -305,6 +314,11 @@ async function resolveConfig(source, options, sourceOptions = {}) {
   return res;
 }
 
+function createDefineConfig() {
+  return (input) => input;
+}
+
+exports.createDefineConfig = createDefineConfig;
 exports.loadConfig = loadConfig;
 exports.loadDotenv = loadDotenv;
 exports.setupDotenv = setupDotenv;

package/dist/index.d.ts

@@ -37,41 +37,37 @@ declare function setupDotenv(options: DotenvOptions): Promise<Env>;
 /** Load environment variables into an object. */
 declare function loadDotenv(options: DotenvOptions): Promise<Env>;
 
-type UserInputConfig = Record<string, any>;
 interface ConfigLayerMeta {
     name?: string;
     [key: string]: any;
 }
-interface C12InputConfig {
-    $test?: UserInputConfig;
-    $development?: UserInputConfig;
-    $production?: UserInputConfig;
-    $env?: Record<string, UserInputConfig>;
-    $meta?: ConfigLayerMeta;
-}
-interface InputConfig extends C12InputConfig, UserInputConfig {
+type UserInputConfig = Record<string, any>;
+interface C12InputConfig<T extends UserInputConfig = UserInputConfig, MT extends ConfigLayerMeta = ConfigLayerMeta> {
+    $test?: T;
+    $development?: T;
+    $production?: T;
+    $env?: Record<string, T>;
+    $meta?: MT;
 }
-interface SourceOptions {
-    meta?: ConfigLayerMeta;
-    overrides?: UserInputConfig;
+type InputConfig<T extends UserInputConfig = UserInputConfig, MT extends ConfigLayerMeta = ConfigLayerMeta> = C12InputConfig<T, MT> & T;
+interface SourceOptions<T extends UserInputConfig = UserInputConfig, MT extends ConfigLayerMeta = ConfigLayerMeta> {
+    meta?: MT;
+    overrides?: T;
     [key: string]: any;
 }
-interface ConfigLayer<T extends InputConfig = InputConfig> {
+interface ConfigLayer<T extends UserInputConfig = UserInputConfig, MT extends ConfigLayerMeta = ConfigLayerMeta> {
     config: T | null;
     source?: string;
-    sourceOptions?: SourceOptions;
-    meta?: ConfigLayerMeta;
+    sourceOptions?: SourceOptions<T, MT>;
+    meta?: MT;
     cwd?: string;
     configFile?: string;
 }
-interface ResolvedConfig<T extends InputConfig = InputConfig> extends ConfigLayer<T> {
-    layers?: ConfigLayer<T>[];
+interface ResolvedConfig<T extends UserInputConfig = UserInputConfig, MT extends ConfigLayerMeta = ConfigLayerMeta> extends ConfigLayer<T, MT> {
+    layers?: ConfigLayer<T, MT>[];
     cwd?: string;
 }
-interface ResolveConfigOptions {
-    cwd: string;
-}
-interface LoadConfigOptions<T extends InputConfig = InputConfig> {
+interface LoadConfigOptions<T extends UserInputConfig = UserInputConfig, MT extends ConfigLayerMeta = ConfigLayerMeta> {
     name?: string;
     cwd?: string;
     configFile?: string;
@@ -83,13 +79,16 @@ interface LoadConfigOptions<T extends InputConfig = InputConfig> {
     defaults?: T;
     defaultConfig?: T;
     overrides?: T;
-    resolve?: (id: string, options: LoadConfigOptions) => null | ResolvedConfig | Promise<ResolvedConfig | null>;
+    resolve?: (id: string, options: LoadConfigOptions<T, MT>) => null | undefined | ResolvedConfig<T, MT> | Promise<ResolvedConfig<T, MT> | undefined | null>;
     jiti?: JITI;
     jitiOptions?: JITIOptions;
     extend?: false | {
         extendKey?: string | string[];
     };
 }
-declare function loadConfig<T extends InputConfig = InputConfig>(options: LoadConfigOptions<T>): Promise<ResolvedConfig<T>>;
+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 function loadConfig<T extends UserInputConfig = UserInputConfig, MT extends ConfigLayerMeta = ConfigLayerMeta>(options: LoadConfigOptions<T, MT>): Promise<ResolvedConfig<T, MT>>;
 
-export { C12InputConfig, ConfigLayer, ConfigLayerMeta, DotenvOptions, Env, InputConfig, LoadConfigOptions, ResolveConfigOptions, ResolvedConfig, SourceOptions, UserInputConfig, loadConfig, loadDotenv, setupDotenv };
+export { C12InputConfig, ConfigLayer, ConfigLayerMeta, DefineConfig, DotenvOptions, Env, InputConfig, LoadConfigOptions, ResolvedConfig, SourceOptions, UserInputConfig, createDefineConfig, loadConfig, loadDotenv, setupDotenv };

package/dist/index.mjs

@@ -1,7 +1,7 @@
 import { existsSync, promises } from 'node:fs';
 import { resolve, extname, dirname } from 'pathe';
 import * as dotenv from 'dotenv';
-import { rmdir } from 'node:fs/promises';
+import { rm } from 'node:fs/promises';
 import { homedir } from 'node:os';
 import createJiti from 'jiti';
 import * as rc9 from 'rc9';
@@ -30,7 +30,7 @@ async function loadDotenv(options) {
     const parsed = dotenv.parse(await promises.readFile(dotenvFile, "utf8"));
     Object.assign(environment, parsed);
   }
-  if (!options.env._applied) {
+  if (!options.env?._applied) {
     Object.assign(environment, options.env);
     environment._applied = true;
   }
@@ -51,15 +51,15 @@ function interpolate(target, source = {}, parse = (v) => v) {
     return parse(
       // eslint-disable-next-line unicorn/no-array-reduce
       matches.reduce((newValue, match) => {
-        const parts = /(.?)\${?([\w:]+)?}?/g.exec(match);
+        const parts = /(.?)\${?([\w:]+)?}?/g.exec(match) || [];
         const prefix = parts[1];
         let value2, replacePart;
         if (prefix === "\\") {
-          replacePart = parts[0];
+          replacePart = parts[0] || "";
           value2 = replacePart.replace("\\$", "$");
         } else {
           const key = parts[2];
-          replacePart = parts[0].slice(prefix.length);
+          replacePart = (parts[0] || "").slice(prefix.length);
           if (parents.includes(key)) {
             console.warn(
               `Please avoid recursive environment variables ( loop: ${parents.join(
@@ -242,7 +242,7 @@ async function resolveConfig(source, options, sourceOptions = {}) {
     const name = gitRepo.replace(/[#/:@\\]/g, "_");
     const tmpDir = process.env.XDG_CACHE_HOME ? resolve(process.env.XDG_CACHE_HOME, "c12", name) : resolve(homedir(), ".cache/c12", name);
     if (existsSync(tmpDir)) {
-      await rmdir(tmpDir, { recursive: true });
+      await rm(tmpDir, { recursive: true });
     }
     const cloned = await downloadTemplate(source, { dir: tmpDir });
     source = cloned.dir;
@@ -258,7 +258,12 @@ async function resolveConfig(source, options, sourceOptions = {}) {
   if (isDir) {
     source = options.configFile;
   }
-  const res = { config: void 0, cwd, source, sourceOptions };
+  const res = {
+    config: void 0,
+    cwd,
+    source,
+    sourceOptions
+  };
   try {
     res.configFile = options.jiti.resolve(resolve(cwd, source), {
       paths: [cwd]
@@ -289,4 +294,8 @@ async function resolveConfig(source, options, sourceOptions = {}) {
   return res;
 }
 
-export { loadConfig, loadDotenv, setupDotenv };
+function createDefineConfig() {
+  return (input) => input;
+}
+
+export { createDefineConfig, loadConfig, loadDotenv, setupDotenv };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "c12",
-  "version": "1.2.0",
+  "version": "1.3.0",
   "description": "Smart Config Loader",
   "repository": "unjs/c12",
   "license": "MIT",
@@ -26,27 +26,29 @@
     "lint:fix": "eslint --ext .ts,.js,.mjs,.cjs . --fix && prettier -w src test",
     "prepack": "unbuild",
     "release": "changelogen --release && npm publish && git push --follow-tags",
-    "test": "vitest run --coverage"
+    "test": "vitest run --coverage && pnpm test:types",
+    "test:types": "tsc --noEmit"
   },
   "dependencies": {
     "defu": "^6.1.2",
     "dotenv": "^16.0.3",
     "giget": "^1.1.2",
-    "jiti": "^1.17.2",
+    "jiti": "^1.18.2",
     "mlly": "^1.2.0",
     "pathe": "^1.1.0",
     "pkg-types": "^1.0.2",
-    "rc9": "^2.0.1"
+    "rc9": "^2.1.0"
   },
   "devDependencies": {
-    "@vitest/coverage-c8": "^0.29.2",
-    "changelogen": "^0.5.1",
-    "eslint": "^8.36.0",
+    "@vitest/coverage-c8": "^0.30.1",
+    "changelogen": "^0.5.3",
+    "eslint": "^8.38.0",
     "eslint-config-unjs": "^0.1.0",
-    "prettier": "^2.8.4",
-    "typescript": "^4.9.5",
-    "unbuild": "^1.1.2",
-    "vitest": "^0.29.2"
+    "expect-type": "^0.15.0",
+    "prettier": "^2.8.7",
+    "typescript": "^5.0.4",
+    "unbuild": "^1.2.1",
+    "vitest": "^0.30.1"
   },
-  "packageManager": "pnpm@7.29.1"
-}
+  "packageManager": "pnpm@8.2.0"
+}