c12 1.1.2 → 1.2.0

package/README.md

@@ -9,10 +9,11 @@
 
 ## Features
 
-- JSON, CJS, Typescript and ESM config loader with [unjs/jiti](https://github.com/unjs/jiti)
+- JSON, CJS, Typescript, and ESM config loader with [unjs/jiti](https://github.com/unjs/jiti)
 - 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
 
 ## Usage
@@ -34,48 +35,49 @@ Import:
 
 ```js
 // ESM
-import { loadConfig } from 'c12'
+import { loadConfig } from "c12";
 
 // CommonJS
-const { loadConfig } = require('c12')
+const { loadConfig } = require("c12");
 ```
 
 Load configuration:
 
 ```js
 // Get loaded config
-const { config } = await loadConfig({})
+const { config } = await loadConfig({});
 
 // Get resolved config and extended layers
-const { config, configFile, layers } = await loadConfig({})
+const { config, configFile, layers } = await loadConfig({});
 ```
 
 ## Loading priority
 
 c12 merged config sources with [unjs/defu](https://github.com/unjs/defu) by below order:
 
-1. config overrides passed by options
-2. config file in CWD
+1. Config overrides passed by options
+2. Config file in CWD
 3. RC file in CWD
-4. global RC file in user's home directory
-5. default config passed by options
-6. Extended config layers
+4. Global RC file in user's home directory
+5. Config from `package.json`
+6. Default config passed by options
+7. Extended config layers
 
 ## Options
 
 ### `cwd`
 
-Resolve configuration from this working directory. Default is `process.cwd()`
+Resolve configuration from this working directory. The default is `process.cwd()`
 
 ### `name`
 
-Configuration base name. Default is `config`.
+Configuration base name. The default is `config`.
 
 ### `configName`
 
-Configuration file name without extension . Default is generated from `name` (name=foo => `foo.config`).
+Configuration file name without extension. Default is generated from `name` (name=foo => `foo.config`).
 
-Set to `false` to avoid loading config file.
+Set to `false` to avoid loading the config file.
 
 ### `rcFile`
 
@@ -85,12 +87,20 @@ Set to `false` to disable loading RC config.
 
 ### `globalRC`
 
-Load RC config from the workspace directory and user's home directory. Only enabled when `rcFile` is provided. Set to `false` to disable this functionality.
+Load RC config from the workspace directory and the user's home directory. Only enabled when `rcFile` is provided. Set to `false` to disable this functionality.
 
 ### `dotenv`
 
 Loads `.env` file if enabled. It is disabled by default.
 
+### `packageJson`
+
+Loads config from nearest `package.json` file. It is disabled by default.
+
+If `true` value is passed, c12 uses `name` field from `package.json`.
+
+You can also pass either a string or an array of strings as a value to use those fields.
+
 ### `defaults`
 
 Specify default configuration. It has the **lowest** priority and is applied **after extending** config.
@@ -99,7 +109,7 @@ Specify default configuration. It has the **lowest** priority and is applied **a
 
 Specify default configuration. It is applied **before** extending config.
 
-### `overides`
+### `overrides`
 
 Specify override configuration. It has the **highest** priority and is applied **before extending** config.
 
@@ -111,16 +121,22 @@ Custom [unjs/jiti](https://github.com/unjs/jiti) instance used to import configu
 
 Custom [unjs/jiti](https://github.com/unjs/jiti) options to import configuration files.
 
+### `envName`
+
+Environment name used for [environment specific configuration](#environment-specific-configuration).
+
+The default is `process.env.NODE_ENV`. You can set `envName` to `false` or an empty string to disable the feature.
+
 ## Extending configuration
 
-If resolved config contains a `extends` key, it will be used to extend configuration.
+If resolved config contains a `extends` key, it will be used to extend the configuration.
 
 Extending can be nested and each layer can extend from one base or more.
 
-Final config is merged result of extended options and user options with [unjs/defu](https://github.com/unjs/defu).
+The final config is merged result of extended options and user options with [unjs/defu](https://github.com/unjs/defu).
 
-Each item in extends, is a string that can be either an absolute or relative path to current config file pointing to a config file for extending or directory containing config file.
-If it starts with either of `github:`, `gitlab:`, `bitbucket:` or `https:`, c12 autmatically clones it.
+Each item in extends is a string that can be either an absolute or relative path to the current config file pointing to a config file for extending or the directory containing the config file.
+If it starts with either `github:`, `gitlab:`, `bitbucket:`, or `https:`, c12 automatically clones it.
 
 For custom merging strategies, you can directly access each layer with `layers` property.
 
@@ -130,31 +146,28 @@ For custom merging strategies, you can directly access each layer with `layers`
 // config.ts
 export default {
   colors: {
-    primary: 'user_primary'
+    primary: "user_primary",
   },
-  extends: [
-    './theme',
-    './config.dev.ts'
-  ]
-}
+  extends: ["./theme"],
+};
 ```
 
 ```js
 // config.dev.ts
 export default {
-  dev: true
-}
+  dev: true,
+};
 ```
 
 ```js
 // theme/config.ts
 export default {
-  extends: '../base',
+  extends: "../base",
   colors: {
-    primary: 'theme_primary',
-    secondary: 'theme_secondary'
-  }
-}
+    primary: "theme_primary",
+    secondary: "theme_secondary",
+  },
+};
 ```
 
 ```js
@@ -167,7 +180,7 @@ export default {
 }
 ```
 
-Loaded configuration would look like this:
+The loaded configuration would look like this:
 
 ```js
 {
@@ -190,6 +203,36 @@ Layers:
 ]
 ```
 
+## Environment-specific configuration
+
+Users can define environment-specific configuration using these config keys:
+
+- `$test: {...}`
+- `$development: {...}`
+- `$production: {...}`
+- `$env: { [env]: {...} }`
+
+c12 tries to match [`envName`](#envname) and override environment config if specified.
+
+**Note:** Environment will be applied when extending each configuration layer. This way layers can provide environment-specific configuration.
+
+**Example:**
+
+```js
+{
+  // Default configuration
+  logLevel: 'info',
+
+  // Environment overrides
+  $test: { logLevel: 'silent' },
+  $development: { logLevel: 'warning' },
+  $production: { logLevel: 'error' },
+  $env: {
+    staging: { logLevel: 'debug' }
+  }
+}
+```
+
 ## 💻 Development
 
 - Clone this repository
@@ -202,14 +245,12 @@ Layers:
 Made with 💛 Published under [MIT License](./LICENSE).
 
 <!-- Badges -->
+
 [npm-version-src]: https://img.shields.io/npm/v/c12?style=flat-square
 [npm-version-href]: https://npmjs.com/package/c12
-
 [npm-downloads-src]: https://img.shields.io/npm/dm/c12?style=flat-square
 [npm-downloads-href]: https://npmjs.com/package/c12
-
-[github-actions-src]: https://img.shields.io/github/workflow/status/unjs/c12/ci/main?style=flat-square
+[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-href]: https://codecov.io/gh/unjs/c12

package/dist/index.cjs

@@ -99,6 +99,7 @@ function interpolate(target, source = {}, parse = (v) => v) {
 async function loadConfig(options) {
   options.cwd = pathe.resolve(process.cwd(), options.cwd || ".");
   options.name = options.name || "config";
+  options.envName = options.envName ?? process.env.NODE_ENV;
   options.configFile = options.configFile ?? (options.name !== "config" ? `${options.name}.config` : "config");
   options.rcFile = options.rcFile ?? `.${options.name}rc`;
   if (options.extend !== false) {
@@ -150,10 +151,21 @@ async function loadConfig(options) {
       rc9__namespace.read({ name: options.rcFile, dir: options.cwd })
     );
   }
+  const pkgJson = {};
+  if (options.packageJson) {
+    const keys = (Array.isArray(options.packageJson) ? options.packageJson : [
+      typeof options.packageJson === "string" ? options.packageJson : options.name
+    ]).filter((t) => t && typeof t === "string");
+    const pkgJsonFile = await pkgTypes.readPackageJSON(options.cwd).catch(() => {
+    });
+    const values = keys.map((key) => pkgJsonFile?.[key]);
+    Object.assign(pkgJson, defu.defu({}, ...values));
+  }
   r.config = defu.defu(
     options.overrides,
     config,
     configRC,
+    pkgJson,
     options.defaultConfig
   );
   if (options.extend) {
@@ -169,7 +181,8 @@ async function loadConfig(options) {
       cwd: void 0
     },
     { config, configFile: options.configFile, cwd: options.cwd },
-    options.rcFile && { config: configRC, configFile: options.rcFile }
+    options.rcFile && { config: configRC, configFile: options.rcFile },
+    options.packageJson && { config: pkgJson, configFile: "package.json" }
   ].filter((l) => l && l.config);
   r.layers = [...baseLayers, ...r.layers];
   if (options.defaults) {
@@ -195,16 +208,26 @@ async function extendConfig(config, options) {
     );
     delete config[key];
   }
-  for (const extendSource of extendSources) {
+  for (let extendSource of extendSources) {
+    const originalExtendSource = extendSource;
+    let sourceOptions = {};
+    if (extendSource.source) {
+      sourceOptions = extendSource.options || {};
+      extendSource = extendSource.source;
+    }
+    if (Array.isArray(extendSource)) {
+      sourceOptions = extendSource[1] || {};
+      extendSource = extendSource[0];
+    }
     if (typeof extendSource !== "string") {
       console.warn(
         `Cannot extend config from \`${JSON.stringify(
-          extendSource
-        )}\` (which should be a string) in ${options.cwd}`
+          originalExtendSource
+        )}\` in ${options.cwd}`
       );
       continue;
     }
-    const _config = await resolveConfig(extendSource, options);
+    const _config = await resolveConfig(extendSource, options, sourceOptions);
     if (!_config.config) {
       console.warn(
         `Cannot extend config from \`${extendSource}\` in ${options.cwd}`
@@ -220,8 +243,8 @@ async function extendConfig(config, options) {
   }
 }
 const GIT_PREFIXES = ["github:", "gitlab:", "bitbucket:", "https://"];
-const NPM_PACKAGE_RE = /^(@[\da-z~-][\d._a-z~-]*\/)?[\da-z~-][\d._a-z~-]*$/;
-async function resolveConfig(source, options) {
+const NPM_PACKAGE_RE = /^(@[\da-z~-][\d._a-z~-]*\/)?[\da-z~-][\d._a-z~-]*($|\/.*)/;
+async function resolveConfig(source, options, sourceOptions = {}) {
   if (options.resolve) {
     const res2 = await options.resolve(source, options);
     if (res2) {
@@ -237,8 +260,8 @@ async function resolveConfig(source, options) {
     if (node_fs.existsSync(tmpDir)) {
       await promises.rmdir(tmpDir, { recursive: true });
     }
-    const clonned = await downloadTemplate(source, { dir: tmpDir });
-    source = clonned.dir;
+    const cloned = await downloadTemplate(source, { dir: tmpDir });
+    source = cloned.dir;
   }
   if (NPM_PACKAGE_RE.test(source)) {
     try {
@@ -251,7 +274,7 @@ async function resolveConfig(source, options) {
   if (isDir) {
     source = options.configFile;
   }
-  const res = { config: void 0, cwd };
+  const res = { config: void 0, cwd, source, sourceOptions };
   try {
     res.configFile = options.jiti.resolve(pathe.resolve(cwd, source), {
       paths: [cwd]
@@ -262,9 +285,23 @@ async function resolveConfig(source, options) {
     return res;
   }
   res.config = options.jiti(res.configFile);
-  if (typeof res.config === "function") {
+  if (res.config instanceof Function) {
     res.config = await res.config();
   }
+  if (options.envName) {
+    const envConfig = {
+      ...res.config["$" + options.envName],
+      ...res.config.$env?.[options.envName]
+    };
+    if (Object.keys(envConfig).length > 0) {
+      res.config = defu.defu(envConfig, res.config);
+    }
+  }
+  res.meta = defu.defu(res.sourceOptions.meta, res.config.$meta);
+  delete res.config.$meta;
+  if (res.sourceOptions.overrides) {
+    res.config = defu.defu(res.sourceOptions.overrides, res.config);
+  }
   return res;
 }
 

package/dist/index.d.ts

@@ -37,10 +37,30 @@ declare function setupDotenv(options: DotenvOptions): Promise<Env>;
 /** Load environment variables into an object. */
 declare function loadDotenv(options: DotenvOptions): Promise<Env>;
 
-interface InputConfig extends Record<string, any> {
+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 {
+}
+interface SourceOptions {
+    meta?: ConfigLayerMeta;
+    overrides?: UserInputConfig;
+    [key: string]: any;
 }
 interface ConfigLayer<T extends InputConfig = InputConfig> {
     config: T | null;
+    source?: string;
+    sourceOptions?: SourceOptions;
+    meta?: ConfigLayerMeta;
     cwd?: string;
     configFile?: string;
 }
@@ -58,6 +78,8 @@ interface LoadConfigOptions<T extends InputConfig = InputConfig> {
     rcFile?: false | string;
     globalRc?: boolean;
     dotenv?: boolean | DotenvOptions;
+    envName?: string | false;
+    packageJson?: boolean | string | string[];
     defaults?: T;
     defaultConfig?: T;
     overrides?: T;
@@ -70,4 +92,4 @@ interface LoadConfigOptions<T extends InputConfig = InputConfig> {
 }
 declare function loadConfig<T extends InputConfig = InputConfig>(options: LoadConfigOptions<T>): Promise<ResolvedConfig<T>>;
 
-export { ConfigLayer, DotenvOptions, Env, InputConfig, LoadConfigOptions, ResolveConfigOptions, ResolvedConfig, loadConfig, loadDotenv, setupDotenv };
+export { C12InputConfig, ConfigLayer, ConfigLayerMeta, DotenvOptions, Env, InputConfig, LoadConfigOptions, ResolveConfigOptions, ResolvedConfig, SourceOptions, UserInputConfig, loadConfig, loadDotenv, setupDotenv };

package/dist/index.mjs

@@ -6,7 +6,7 @@ import { homedir } from 'node:os';
 import createJiti from 'jiti';
 import * as rc9 from 'rc9';
 import { defu } from 'defu';
-import { findWorkspaceDir } from 'pkg-types';
+import { findWorkspaceDir, readPackageJSON } from 'pkg-types';
 
 async function setupDotenv(options) {
   const targetEnvironment = options.env ?? process.env;
@@ -83,6 +83,7 @@ function interpolate(target, source = {}, parse = (v) => v) {
 async function loadConfig(options) {
   options.cwd = resolve(process.cwd(), options.cwd || ".");
   options.name = options.name || "config";
+  options.envName = options.envName ?? process.env.NODE_ENV;
   options.configFile = options.configFile ?? (options.name !== "config" ? `${options.name}.config` : "config");
   options.rcFile = options.rcFile ?? `.${options.name}rc`;
   if (options.extend !== false) {
@@ -134,10 +135,21 @@ async function loadConfig(options) {
       rc9.read({ name: options.rcFile, dir: options.cwd })
     );
   }
+  const pkgJson = {};
+  if (options.packageJson) {
+    const keys = (Array.isArray(options.packageJson) ? options.packageJson : [
+      typeof options.packageJson === "string" ? options.packageJson : options.name
+    ]).filter((t) => t && typeof t === "string");
+    const pkgJsonFile = await readPackageJSON(options.cwd).catch(() => {
+    });
+    const values = keys.map((key) => pkgJsonFile?.[key]);
+    Object.assign(pkgJson, defu({}, ...values));
+  }
   r.config = defu(
     options.overrides,
     config,
     configRC,
+    pkgJson,
     options.defaultConfig
   );
   if (options.extend) {
@@ -153,7 +165,8 @@ async function loadConfig(options) {
       cwd: void 0
     },
     { config, configFile: options.configFile, cwd: options.cwd },
-    options.rcFile && { config: configRC, configFile: options.rcFile }
+    options.rcFile && { config: configRC, configFile: options.rcFile },
+    options.packageJson && { config: pkgJson, configFile: "package.json" }
   ].filter((l) => l && l.config);
   r.layers = [...baseLayers, ...r.layers];
   if (options.defaults) {
@@ -179,16 +192,26 @@ async function extendConfig(config, options) {
     );
     delete config[key];
   }
-  for (const extendSource of extendSources) {
+  for (let extendSource of extendSources) {
+    const originalExtendSource = extendSource;
+    let sourceOptions = {};
+    if (extendSource.source) {
+      sourceOptions = extendSource.options || {};
+      extendSource = extendSource.source;
+    }
+    if (Array.isArray(extendSource)) {
+      sourceOptions = extendSource[1] || {};
+      extendSource = extendSource[0];
+    }
     if (typeof extendSource !== "string") {
       console.warn(
         `Cannot extend config from \`${JSON.stringify(
-          extendSource
-        )}\` (which should be a string) in ${options.cwd}`
+          originalExtendSource
+        )}\` in ${options.cwd}`
       );
       continue;
     }
-    const _config = await resolveConfig(extendSource, options);
+    const _config = await resolveConfig(extendSource, options, sourceOptions);
     if (!_config.config) {
       console.warn(
         `Cannot extend config from \`${extendSource}\` in ${options.cwd}`
@@ -204,8 +227,8 @@ async function extendConfig(config, options) {
   }
 }
 const GIT_PREFIXES = ["github:", "gitlab:", "bitbucket:", "https://"];
-const NPM_PACKAGE_RE = /^(@[\da-z~-][\d._a-z~-]*\/)?[\da-z~-][\d._a-z~-]*$/;
-async function resolveConfig(source, options) {
+const NPM_PACKAGE_RE = /^(@[\da-z~-][\d._a-z~-]*\/)?[\da-z~-][\d._a-z~-]*($|\/.*)/;
+async function resolveConfig(source, options, sourceOptions = {}) {
   if (options.resolve) {
     const res2 = await options.resolve(source, options);
     if (res2) {
@@ -221,8 +244,8 @@ async function resolveConfig(source, options) {
     if (existsSync(tmpDir)) {
       await rmdir(tmpDir, { recursive: true });
     }
-    const clonned = await downloadTemplate(source, { dir: tmpDir });
-    source = clonned.dir;
+    const cloned = await downloadTemplate(source, { dir: tmpDir });
+    source = cloned.dir;
   }
   if (NPM_PACKAGE_RE.test(source)) {
     try {
@@ -235,7 +258,7 @@ async function resolveConfig(source, options) {
   if (isDir) {
     source = options.configFile;
   }
-  const res = { config: void 0, cwd };
+  const res = { config: void 0, cwd, source, sourceOptions };
   try {
     res.configFile = options.jiti.resolve(resolve(cwd, source), {
       paths: [cwd]
@@ -246,9 +269,23 @@ async function resolveConfig(source, options) {
     return res;
   }
   res.config = options.jiti(res.configFile);
-  if (typeof res.config === "function") {
+  if (res.config instanceof Function) {
     res.config = await res.config();
   }
+  if (options.envName) {
+    const envConfig = {
+      ...res.config["$" + options.envName],
+      ...res.config.$env?.[options.envName]
+    };
+    if (Object.keys(envConfig).length > 0) {
+      res.config = defu(envConfig, res.config);
+    }
+  }
+  res.meta = defu(res.sourceOptions.meta, res.config.$meta);
+  delete res.config.$meta;
+  if (res.sourceOptions.overrides) {
+    res.config = defu(res.sourceOptions.overrides, res.config);
+  }
   return res;
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "c12",
-  "version": "1.1.2",
+  "version": "1.2.0",
   "description": "Smart Config Loader",
   "repository": "unjs/c12",
   "license": "MIT",
@@ -31,22 +31,22 @@
   "dependencies": {
     "defu": "^6.1.2",
     "dotenv": "^16.0.3",
-    "giget": "^1.1.0",
-    "jiti": "^1.17.1",
-    "mlly": "^1.1.1",
+    "giget": "^1.1.2",
+    "jiti": "^1.17.2",
+    "mlly": "^1.2.0",
     "pathe": "^1.1.0",
     "pkg-types": "^1.0.2",
     "rc9": "^2.0.1"
   },
   "devDependencies": {
-    "@vitest/coverage-c8": "^0.28.5",
-    "changelogen": "^0.4.1",
-    "eslint": "^8.34.0",
+    "@vitest/coverage-c8": "^0.29.2",
+    "changelogen": "^0.5.1",
+    "eslint": "^8.36.0",
     "eslint-config-unjs": "^0.1.0",
     "prettier": "^2.8.4",
     "typescript": "^4.9.5",
-    "unbuild": "^1.1.1",
-    "vitest": "^0.28.5"
+    "unbuild": "^1.1.2",
+    "vitest": "^0.29.2"
   },
-  "packageManager": "pnpm@7.27.0"
+  "packageManager": "pnpm@7.29.1"
 }