c12 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 - UnJS
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,118 @@
+# 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]
+
+> Smart Config Loader
+
+## Features
+
+- 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)
+
+## Usage
+
+Install package:
+
+```sh
+# npm
+npm install c12
+
+# yarn
+yarn install c12
+
+# pnpm
+pnpm install c12
+```
+
+Import:
+
+```js
+// ESM
+import { loadConfig } from 'c12'
+
+// CommonJS
+const { loadConfig } = require('c12')
+```
+
+Load configuration:
+
+```js
+const { config } = 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
+3. RC file in CWD
+4. global RC file in user's home directory
+5. default config passed by options
+
+## Options
+
+### `cwd`
+
+Resolve configuration from this working directory. Default is `process.cwd()`
+
+### `name`
+
+Configuration base name. Default is `config`.
+
+### `configName`
+
+Configuration file name without extension . Default is generated from `name` (name=foo => `foo.config`).
+
+Set to `false` to avoid loading config file.
+
+### `rcFile`
+
+RC Config file name. Default is generated from `name` (name=foo => `.foorc`).
+
+Set to `false` to disable loading RC config.
+
+### `globalRC`
+
+Load RC config from 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.
+
+### `defaults`
+
+Specify default configuration. It has the **lowest** priority.
+
+### `overides`
+
+Specify override configuration. It has the **highest** priority.
+
+## 💻 Development
+
+- Clone this repository
+- Enable [Corepack](https://github.com/nodejs/corepack) using `corepack enable` (use `npm i -g corepack` for Node.js < 16.10)
+- Install dependencies using `yarn install`
+- Run interactive tests using `yarn dev`
+
+## License
+
+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-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

@@ -0,0 +1,147 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+const fs = require('fs');
+const pathe = require('pathe');
+const dotenv = require('dotenv');
+const createJiti = require('jiti');
+const rc9 = require('rc9');
+const defu = require('defu');
+
+function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e["default"] : e; }
+
+function _interopNamespace(e) {
+  if (e && e.__esModule) return e;
+  const n = Object.create(null);
+  if (e) {
+    for (const k in e) {
+      n[k] = e[k];
+    }
+  }
+  n["default"] = e;
+  return n;
+}
+
+const dotenv__namespace = /*#__PURE__*/_interopNamespace(dotenv);
+const createJiti__default = /*#__PURE__*/_interopDefaultLegacy(createJiti);
+const rc9__namespace = /*#__PURE__*/_interopNamespace(rc9);
+const defu__default = /*#__PURE__*/_interopDefaultLegacy(defu);
+
+async function setupDotenv(options) {
+  const targetEnv = options.env ?? process.env;
+  const env = await loadDotenv({
+    cwd: options.cwd,
+    fileName: options.fileName ?? ".env",
+    env: targetEnv,
+    interpolate: options.interpolate ?? true
+  });
+  for (const key in env) {
+    if (!key.startsWith("_") && targetEnv[key] === void 0) {
+      targetEnv[key] = env[key];
+    }
+  }
+  return env;
+}
+async function loadDotenv(opts) {
+  const env = /* @__PURE__ */ Object.create(null);
+  const dotenvFile = pathe.resolve(opts.cwd, opts.fileName);
+  if (fs.existsSync(dotenvFile)) {
+    const parsed = dotenv__namespace.parse(await fs.promises.readFile(dotenvFile, "utf-8"));
+    Object.assign(env, parsed);
+  }
+  if (!opts.env._applied) {
+    Object.assign(env, opts.env);
+    env._applied = true;
+  }
+  if (opts.interpolate) {
+    interpolate(env);
+  }
+  return env;
+}
+function interpolate(target, source = {}, parse = (v) => v) {
+  function getValue(key) {
+    return source[key] !== void 0 ? source[key] : target[key];
+  }
+  function interpolate2(value, parents = []) {
+    if (typeof value !== "string") {
+      return value;
+    }
+    const matches = value.match(/(.?\${?(?:[a-zA-Z0-9_:]+)?}?)/g) || [];
+    return parse(matches.reduce((newValue, match) => {
+      const parts = /(.?)\${?([a-zA-Z0-9_:]+)?}?/g.exec(match);
+      const prefix = parts[1];
+      let value2, replacePart;
+      if (prefix === "\\") {
+        replacePart = parts[0];
+        value2 = replacePart.replace("\\$", "$");
+      } else {
+        const key = parts[2];
+        replacePart = parts[0].substring(prefix.length);
+        if (parents.includes(key)) {
+          console.warn(`Please avoid recursive environment variables ( loop: ${parents.join(" > ")} > ${key} )`);
+          return "";
+        }
+        value2 = getValue(key);
+        value2 = interpolate2(value2, [...parents, key]);
+      }
+      return value2 !== void 0 ? newValue.replace(replacePart, value2) : newValue;
+    }, value));
+  }
+  for (const key in target) {
+    target[key] = interpolate2(getValue(key));
+  }
+}
+
+async function loadConfig(opts) {
+  opts.cwd = pathe.resolve(process.cwd(), opts.cwd || ".");
+  opts.name = opts.name || "config";
+  opts.configFile = opts.configFile ?? (opts.name !== "config" ? `${opts.name}.config` : "config");
+  opts.rcFile = opts.rcFile ?? `.${opts.name}rc`;
+  const ctx = {
+    config: {}
+  };
+  if (opts.dotenv) {
+    ctx.env = await setupDotenv({
+      cwd: opts.cwd,
+      ...opts.dotenv === true ? {} : opts.dotenv
+    });
+  }
+  const { config, configPath } = await loadConfigFile(opts);
+  ctx.configPath = configPath;
+  const configRC = {};
+  if (opts.rcFile) {
+    if (opts.globalRc) {
+      Object.assign(configRC, rc9__namespace.readUser({ name: opts.rcFile, dir: opts.cwd }));
+    }
+    Object.assign(configRC, rc9__namespace.read({ name: opts.rcFile, dir: opts.cwd }));
+  }
+  ctx.config = defu__default(opts.overrides, config, configRC, opts.defaults);
+  return ctx;
+}
+const jiti = createJiti__default(null, { cache: false, interopDefault: true });
+async function loadConfigFile(opts) {
+  const res = {
+    configPath: null,
+    config: null
+  };
+  if (!opts.configFile) {
+    return res;
+  }
+  try {
+    res.configPath = jiti.resolve(pathe.resolve(opts.cwd, opts.configFile), { paths: [opts.cwd] });
+    res.config = jiti(res.configPath);
+    if (typeof res.config === "function") {
+      res.config = await res.config();
+    }
+  } catch (err) {
+    if (err.code !== "MODULE_NOT_FOUND") {
+      throw err;
+    }
+  }
+  return res;
+}
+
+exports.loadConfig = loadConfig;
+exports.loadDotenv = loadDotenv;
+exports.setupDotenv = setupDotenv;

package/dist/index.d.ts

@@ -0,0 +1,55 @@
+interface DotenvOptions {
+    /**
+     * The project root directory (either absolute or relative to the current working directory).
+    */
+    cwd: string;
+    /**
+     * What file to look in for environment variables (either absolute or relative
+     * to the current working directory). For example, `.env`.
+    */
+    fileName?: string;
+    /**
+     * Whether to interpolate variables within .env.
+     *
+     * @example
+     * ```env
+     * BASE_DIR="/test"
+     * # resolves to "/test/further"
+     * ANOTHER_DIR="${BASE_DIR}/further"
+     * ```
+     */
+    interpolate?: boolean;
+    /**
+     * An object describing environment variables (key, value pairs).
+    */
+    env?: NodeJS.ProcessEnv;
+}
+declare type Env = typeof process.env;
+/**
+ * Load and interpolate environment variables into `process.env`.
+ * If you need more control (or access to the values), consider using `loadDotenv` instead
+ *
+ */
+declare function setupDotenv(options: DotenvOptions): Promise<Env>;
+/** Load environment variables into an object. */
+declare function loadDotenv(opts: DotenvOptions): Promise<Env>;
+
+declare type ConfigT = Record<string, any>;
+interface LoadConfigOptions<T extends ConfigT = ConfigT> {
+    name?: string;
+    cwd?: string;
+    configFile?: false | string;
+    rcFile?: false | string;
+    globalRc?: boolean;
+    dotenv?: boolean | DotenvOptions;
+    defaults?: T;
+    overrides?: T;
+}
+interface ResolvedConfig<T extends ConfigT = ConfigT> {
+    config: T;
+    configPath?: string;
+    env?: Record<string, any>;
+}
+declare function loadConfig<T extends ConfigT = ConfigT>(opts: LoadConfigOptions<T>): Promise<ResolvedConfig<T>>;
+
+export { ConfigT, DotenvOptions, Env, LoadConfigOptions, ResolvedConfig, loadConfig, loadDotenv, setupDotenv };

package/dist/index.mjs

@@ -0,0 +1,122 @@
+import { existsSync, promises } from 'fs';
+import { resolve } from 'pathe';
+import * as dotenv from 'dotenv';
+import createJiti from 'jiti';
+import * as rc9 from 'rc9';
+import defu from 'defu';
+
+async function setupDotenv(options) {
+  const targetEnv = options.env ?? process.env;
+  const env = await loadDotenv({
+    cwd: options.cwd,
+    fileName: options.fileName ?? ".env",
+    env: targetEnv,
+    interpolate: options.interpolate ?? true
+  });
+  for (const key in env) {
+    if (!key.startsWith("_") && targetEnv[key] === void 0) {
+      targetEnv[key] = env[key];
+    }
+  }
+  return env;
+}
+async function loadDotenv(opts) {
+  const env = /* @__PURE__ */ Object.create(null);
+  const dotenvFile = resolve(opts.cwd, opts.fileName);
+  if (existsSync(dotenvFile)) {
+    const parsed = dotenv.parse(await promises.readFile(dotenvFile, "utf-8"));
+    Object.assign(env, parsed);
+  }
+  if (!opts.env._applied) {
+    Object.assign(env, opts.env);
+    env._applied = true;
+  }
+  if (opts.interpolate) {
+    interpolate(env);
+  }
+  return env;
+}
+function interpolate(target, source = {}, parse = (v) => v) {
+  function getValue(key) {
+    return source[key] !== void 0 ? source[key] : target[key];
+  }
+  function interpolate2(value, parents = []) {
+    if (typeof value !== "string") {
+      return value;
+    }
+    const matches = value.match(/(.?\${?(?:[a-zA-Z0-9_:]+)?}?)/g) || [];
+    return parse(matches.reduce((newValue, match) => {
+      const parts = /(.?)\${?([a-zA-Z0-9_:]+)?}?/g.exec(match);
+      const prefix = parts[1];
+      let value2, replacePart;
+      if (prefix === "\\") {
+        replacePart = parts[0];
+        value2 = replacePart.replace("\\$", "$");
+      } else {
+        const key = parts[2];
+        replacePart = parts[0].substring(prefix.length);
+        if (parents.includes(key)) {
+          console.warn(`Please avoid recursive environment variables ( loop: ${parents.join(" > ")} > ${key} )`);
+          return "";
+        }
+        value2 = getValue(key);
+        value2 = interpolate2(value2, [...parents, key]);
+      }
+      return value2 !== void 0 ? newValue.replace(replacePart, value2) : newValue;
+    }, value));
+  }
+  for (const key in target) {
+    target[key] = interpolate2(getValue(key));
+  }
+}
+
+async function loadConfig(opts) {
+  opts.cwd = resolve(process.cwd(), opts.cwd || ".");
+  opts.name = opts.name || "config";
+  opts.configFile = opts.configFile ?? (opts.name !== "config" ? `${opts.name}.config` : "config");
+  opts.rcFile = opts.rcFile ?? `.${opts.name}rc`;
+  const ctx = {
+    config: {}
+  };
+  if (opts.dotenv) {
+    ctx.env = await setupDotenv({
+      cwd: opts.cwd,
+      ...opts.dotenv === true ? {} : opts.dotenv
+    });
+  }
+  const { config, configPath } = await loadConfigFile(opts);
+  ctx.configPath = configPath;
+  const configRC = {};
+  if (opts.rcFile) {
+    if (opts.globalRc) {
+      Object.assign(configRC, rc9.readUser({ name: opts.rcFile, dir: opts.cwd }));
+    }
+    Object.assign(configRC, rc9.read({ name: opts.rcFile, dir: opts.cwd }));
+  }
+  ctx.config = defu(opts.overrides, config, configRC, opts.defaults);
+  return ctx;
+}
+const jiti = createJiti(null, { cache: false, interopDefault: true });
+async function loadConfigFile(opts) {
+  const res = {
+    configPath: null,
+    config: null
+  };
+  if (!opts.configFile) {
+    return res;
+  }
+  try {
+    res.configPath = jiti.resolve(resolve(opts.cwd, opts.configFile), { paths: [opts.cwd] });
+    res.config = jiti(res.configPath);
+    if (typeof res.config === "function") {
+      res.config = await res.config();
+    }
+  } catch (err) {
+    if (err.code !== "MODULE_NOT_FOUND") {
+      throw err;
+    }
+  }
+  return res;
+}
+
+export { loadConfig, loadDotenv, setupDotenv };

package/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "c12",
+  "version": "0.1.0",
+  "description": "Smart Config Loader",
+  "repository": "unjs/c12",
+  "license": "MIT",
+  "sideEffects": false,
+  "type": "module",
+  "exports": {
+    ".": {
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "unbuild",
+    "dev": "vitest dev",
+    "lint": "eslint --ext .ts,.js,.mjs,.cjs .",
+    "prepack": "unbuild",
+    "release": "yarn test && standard-version && git push --follow-tags && npm publish",
+    "test": "vitest run --coverage"
+  },
+  "dependencies": {
+    "defu": "^5.0.1",
+    "dotenv": "^14.3.2",
+    "jiti": "^1.12.14",
+    "mlly": "^0.4.1",
+    "pathe": "^0.2.0",
+    "rc9": "^1.2.0"
+  },
+  "devDependencies": {
+    "@nuxtjs/eslint-config-typescript": "latest",
+    "c8": "latest",
+    "eslint": "latest",
+    "standard-version": "latest",
+    "typescript": "latest",
+    "unbuild": "latest",
+    "vitest": "latest"
+  }
+}