c12 1.4.2 → 1.5.1

package/README.md

@@ -123,6 +123,10 @@ 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.
 
+### `giget`
+
+Options passed to [unjs/giget](https://github.com/unjs/giget) when extending layer from git source.
+
 ### `envName`
 
 Environment name used for [environment specific configuration](#environment-specific-configuration).
@@ -205,6 +209,39 @@ Layers:
 ]
 ```
 
+## Extending Config Layer from Remote Sources
+
+You can also extend configuration from remote sources such as npm or github.
+
+In the repo, there should be a `config.ts` (or `config.{name}.ts`) file to be considered as a valid config layer.
+
+**Example:** Extend from a github repository
+
+```js
+// config.ts
+export default {
+  extends: "gh:repo/owner",
+};
+```
+
+**Example:** Extend from a github repository with branch and subpath
+
+```js
+// config.ts
+export default {
+  extends: "gh:repo/owner/theme#dev",
+};
+```
+
+**Example:** Extend with custom configuration ([giget](https://github.com/unjs/giget) options)
+
+```js
+// config.ts
+export default {
+  extends: ["gh:repo/owner", { giget: { auth: process.env.GITHUB_TOKEN } }],
+};
+```
+
 ## Environment-specific configuration
 
 Users can define environment-specific configuration using these config keys:

package/dist/index.cjs

@@ -8,10 +8,10 @@ const node_os = require('node:os');
 const createJiti = require('jiti');
 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');
-const ohash = require('ohash');
 
 function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e.default : e; }
 
@@ -249,7 +249,7 @@ async function extendConfig(config, options) {
     }
   }
 }
-const GIT_PREFIXES = ["github:", "gitlab:", "bitbucket:", "https://"];
+const GIT_PREFIXES = ["gh:", "github:", "gitlab:", "bitbucket:", "https://"];
 const NPM_PACKAGE_RE = /^(@[\da-z~-][\d._a-z~-]*\/)?[\da-z~-][\d._a-z~-]*($|\/.*)/;
 async function resolveConfig(source, options, sourceOptions = {}) {
   if (options.resolve) {
@@ -260,14 +260,22 @@ async function resolveConfig(source, options, sourceOptions = {}) {
   }
   if (GIT_PREFIXES.some((prefix) => source.startsWith(prefix))) {
     const { downloadTemplate } = await import('giget');
-    const url = new URL(source);
-    const gitRepo = url.protocol + url.pathname.split("/").slice(0, 2).join("/");
-    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.rm(tmpDir, { recursive: true });
+    const cloneName = source.replace(/\W+/g, "_").split("_").splice(0, 3).join("_") + "_" + ohash.hash(source);
+    let cloneDir;
+    const localNodeModules = pathe.resolve(options.cwd, "node_modules");
+    if (node_fs.existsSync(localNodeModules)) {
+      cloneDir = pathe.join(localNodeModules, ".c12", cloneName);
+    } else {
+      cloneDir = process.env.XDG_CACHE_HOME ? pathe.resolve(process.env.XDG_CACHE_HOME, "c12", cloneName) : pathe.resolve(node_os.homedir(), ".cache/c12", cloneName);
     }
-    const cloned = await downloadTemplate(source, { dir: tmpDir });
+    if (node_fs.existsSync(cloneDir)) {
+      await promises.rm(cloneDir, { recursive: true });
+    }
+    const cloned = await downloadTemplate(source, {
+      dir: cloneDir,
+      ...options.giget,
+      ...sourceOptions.giget
+    });
     source = cloned.dir;
   }
   if (NPM_PACKAGE_RE.test(source)) {

package/dist/index.d.cts

@@ -0,0 +1,123 @@
+import { JITI } from 'jiti';
+import { JITIOptions } from 'jiti/dist/types';
+import { DownloadTemplateOptions } from 'giget';
+import { WatchOptions } from 'chokidar';
+import { diff } from 'ohash';
+
+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;
+}
+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(options: DotenvOptions): Promise<Env>;
+
+interface ConfigLayerMeta {
+    name?: string;
+    [key: string]: any;
+}
+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;
+}
+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;
+    giget?: DownloadTemplateOptions;
+    overrides?: T;
+    [key: string]: any;
+}
+interface ConfigLayer<T extends UserInputConfig = UserInputConfig, MT extends ConfigLayerMeta = ConfigLayerMeta> {
+    config: T | null;
+    source?: string;
+    sourceOptions?: SourceOptions<T, MT>;
+    meta?: MT;
+    cwd?: string;
+    configFile?: string;
+}
+interface ResolvedConfig<T extends UserInputConfig = UserInputConfig, MT extends ConfigLayerMeta = ConfigLayerMeta> extends ConfigLayer<T, MT> {
+    layers?: ConfigLayer<T, MT>[];
+    cwd?: string;
+}
+interface LoadConfigOptions<T extends UserInputConfig = UserInputConfig, MT extends ConfigLayerMeta = ConfigLayerMeta> {
+    name?: string;
+    cwd?: string;
+    configFile?: string;
+    rcFile?: false | string;
+    globalRc?: boolean;
+    dotenv?: boolean | DotenvOptions;
+    envName?: string | false;
+    packageJson?: boolean | string | string[];
+    defaults?: T;
+    defaultConfig?: T;
+    overrides?: T;
+    resolve?: (id: string, options: LoadConfigOptions<T, MT>) => null | undefined | ResolvedConfig<T, MT> | Promise<ResolvedConfig<T, MT> | undefined | null>;
+    jiti?: JITI;
+    jitiOptions?: JITIOptions;
+    giget?: DownloadTemplateOptions;
+    extend?: false | {
+        extendKey?: string | string[];
+    };
+}
+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>>;
+
+type ConfigWatcher<T extends UserInputConfig = UserInputConfig, MT extends ConfigLayerMeta = ConfigLayerMeta> = ResolvedConfig<T, MT> & {
+    watchingFiles: string[];
+    unwatch: () => Promise<void>;
+};
+interface WatchConfigOptions<T extends UserInputConfig = UserInputConfig, MT extends ConfigLayerMeta = ConfigLayerMeta> extends LoadConfigOptions<T, MT> {
+    chokidarOptions?: WatchOptions;
+    debounce?: false | number;
+    onWatch?: (event: {
+        type: "created" | "updated" | "removed";
+        path: string;
+    }) => void | Promise<void>;
+    acceptHMR?: (context: {
+        getDiff: () => ReturnType<typeof diff>;
+        newConfig: ResolvedConfig<T, MT>;
+        oldConfig: ResolvedConfig<T, MT>;
+    }) => void | boolean | Promise<void | boolean>;
+    onUpdate?: (context: {
+        getDiff: () => ReturnType<typeof diff>;
+        newConfig: ResolvedConfig<T, MT>;
+        oldConfig: ResolvedConfig<T, MT>;
+    }) => void | Promise<void>;
+}
+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 };

package/dist/index.d.mts

@@ -0,0 +1,123 @@
+import { JITI } from 'jiti';
+import { JITIOptions } from 'jiti/dist/types';
+import { DownloadTemplateOptions } from 'giget';
+import { WatchOptions } from 'chokidar';
+import { diff } from 'ohash';
+
+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;
+}
+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(options: DotenvOptions): Promise<Env>;
+
+interface ConfigLayerMeta {
+    name?: string;
+    [key: string]: any;
+}
+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;
+}
+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;
+    giget?: DownloadTemplateOptions;
+    overrides?: T;
+    [key: string]: any;
+}
+interface ConfigLayer<T extends UserInputConfig = UserInputConfig, MT extends ConfigLayerMeta = ConfigLayerMeta> {
+    config: T | null;
+    source?: string;
+    sourceOptions?: SourceOptions<T, MT>;
+    meta?: MT;
+    cwd?: string;
+    configFile?: string;
+}
+interface ResolvedConfig<T extends UserInputConfig = UserInputConfig, MT extends ConfigLayerMeta = ConfigLayerMeta> extends ConfigLayer<T, MT> {
+    layers?: ConfigLayer<T, MT>[];
+    cwd?: string;
+}
+interface LoadConfigOptions<T extends UserInputConfig = UserInputConfig, MT extends ConfigLayerMeta = ConfigLayerMeta> {
+    name?: string;
+    cwd?: string;
+    configFile?: string;
+    rcFile?: false | string;
+    globalRc?: boolean;
+    dotenv?: boolean | DotenvOptions;
+    envName?: string | false;
+    packageJson?: boolean | string | string[];
+    defaults?: T;
+    defaultConfig?: T;
+    overrides?: T;
+    resolve?: (id: string, options: LoadConfigOptions<T, MT>) => null | undefined | ResolvedConfig<T, MT> | Promise<ResolvedConfig<T, MT> | undefined | null>;
+    jiti?: JITI;
+    jitiOptions?: JITIOptions;
+    giget?: DownloadTemplateOptions;
+    extend?: false | {
+        extendKey?: string | string[];
+    };
+}
+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>>;
+
+type ConfigWatcher<T extends UserInputConfig = UserInputConfig, MT extends ConfigLayerMeta = ConfigLayerMeta> = ResolvedConfig<T, MT> & {
+    watchingFiles: string[];
+    unwatch: () => Promise<void>;
+};
+interface WatchConfigOptions<T extends UserInputConfig = UserInputConfig, MT extends ConfigLayerMeta = ConfigLayerMeta> extends LoadConfigOptions<T, MT> {
+    chokidarOptions?: WatchOptions;
+    debounce?: false | number;
+    onWatch?: (event: {
+        type: "created" | "updated" | "removed";
+        path: string;
+    }) => void | Promise<void>;
+    acceptHMR?: (context: {
+        getDiff: () => ReturnType<typeof diff>;
+        newConfig: ResolvedConfig<T, MT>;
+        oldConfig: ResolvedConfig<T, MT>;
+    }) => void | boolean | Promise<void | boolean>;
+    onUpdate?: (context: {
+        getDiff: () => ReturnType<typeof diff>;
+        newConfig: ResolvedConfig<T, MT>;
+        oldConfig: ResolvedConfig<T, MT>;
+    }) => void | Promise<void>;
+}
+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 };

package/dist/index.d.ts

@@ -1,5 +1,6 @@
 import { JITI } from 'jiti';
 import { JITIOptions } from 'jiti/dist/types';
+import { DownloadTemplateOptions } from 'giget';
 import { WatchOptions } from 'chokidar';
 import { diff } from 'ohash';
 
@@ -54,6 +55,7 @@ interface C12InputConfig<T extends UserInputConfig = UserInputConfig, MT extends
 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;
+    giget?: DownloadTemplateOptions;
     overrides?: T;
     [key: string]: any;
 }
@@ -84,6 +86,7 @@ interface LoadConfigOptions<T extends UserInputConfig = UserInputConfig, MT exte
     resolve?: (id: string, options: LoadConfigOptions<T, MT>) => null | undefined | ResolvedConfig<T, MT> | Promise<ResolvedConfig<T, MT> | undefined | null>;
     jiti?: JITI;
     jitiOptions?: JITIOptions;
+    giget?: DownloadTemplateOptions;
     extend?: false | {
         extendKey?: string | string[];
     };
@@ -117,4 +120,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 { C12InputConfig, ConfigLayer, ConfigLayerMeta, ConfigWatcher, DefineConfig, DotenvOptions, Env, InputConfig, LoadConfigOptions, ResolvedConfig, SourceOptions, UserInputConfig, 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, type SourceOptions, type UserInputConfig, type WatchConfigOptions, createDefineConfig, loadConfig, loadDotenv, setupDotenv, watchConfig };

package/dist/index.mjs

@@ -1,15 +1,15 @@
 import { existsSync, promises } from 'node:fs';
-import { resolve, extname, basename, dirname } from 'pathe';
+import { resolve, join, extname, basename, dirname } from 'pathe';
 import * as dotenv from 'dotenv';
 import { rm } from 'node:fs/promises';
 import { homedir } from 'node:os';
 import createJiti from 'jiti';
 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';
-import { diff } from 'ohash';
 
 async function setupDotenv(options) {
   const targetEnvironment = options.env ?? process.env;
@@ -229,7 +229,7 @@ async function extendConfig(config, options) {
     }
   }
 }
-const GIT_PREFIXES = ["github:", "gitlab:", "bitbucket:", "https://"];
+const GIT_PREFIXES = ["gh:", "github:", "gitlab:", "bitbucket:", "https://"];
 const NPM_PACKAGE_RE = /^(@[\da-z~-][\d._a-z~-]*\/)?[\da-z~-][\d._a-z~-]*($|\/.*)/;
 async function resolveConfig(source, options, sourceOptions = {}) {
   if (options.resolve) {
@@ -240,14 +240,22 @@ async function resolveConfig(source, options, sourceOptions = {}) {
   }
   if (GIT_PREFIXES.some((prefix) => source.startsWith(prefix))) {
     const { downloadTemplate } = await import('giget');
-    const url = new URL(source);
-    const gitRepo = url.protocol + url.pathname.split("/").slice(0, 2).join("/");
-    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 rm(tmpDir, { recursive: true });
+    const cloneName = source.replace(/\W+/g, "_").split("_").splice(0, 3).join("_") + "_" + hash(source);
+    let cloneDir;
+    const localNodeModules = resolve(options.cwd, "node_modules");
+    if (existsSync(localNodeModules)) {
+      cloneDir = join(localNodeModules, ".c12", cloneName);
+    } else {
+      cloneDir = process.env.XDG_CACHE_HOME ? resolve(process.env.XDG_CACHE_HOME, "c12", cloneName) : resolve(homedir(), ".cache/c12", cloneName);
     }
-    const cloned = await downloadTemplate(source, { dir: tmpDir });
+    if (existsSync(cloneDir)) {
+      await rm(cloneDir, { recursive: true });
+    }
+    const cloned = await downloadTemplate(source, {
+      dir: cloneDir,
+      ...options.giget,
+      ...sourceOptions.giget
+    });
     source = cloned.dir;
   }
   if (NPM_PACKAGE_RE.test(source)) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "c12",
-  "version": "1.4.2",
+  "version": "1.5.1",
   "description": "Smart Config Loader",
   "repository": "unjs/c12",
   "license": "MIT",
@@ -25,7 +25,7 @@
     "lint": "eslint --ext .ts,.js,.mjs,.cjs . && prettier -c src test",
     "lint:fix": "eslint --ext .ts,.js,.mjs,.cjs . --fix && prettier -w src test",
     "prepack": "unbuild",
-    "release": "changelogen --release && npm publish && git push --follow-tags",
+    "release": "pnpm test && changelogen --release && npm publish && git push --follow-tags",
     "test": "pnpm lint && vitest run --coverage && pnpm test:types",
     "test:types": "tsc --noEmit"
   },
@@ -33,25 +33,25 @@
     "chokidar": "^3.5.3",
     "defu": "^6.1.2",
     "dotenv": "^16.3.1",
-    "giget": "^1.1.2",
-    "jiti": "^1.18.2",
-    "mlly": "^1.4.0",
-    "ohash": "^1.1.2",
+    "giget": "^1.1.3",
+    "jiti": "^1.20.0",
+    "mlly": "^1.4.2",
+    "ohash": "^1.1.3",
     "pathe": "^1.1.1",
     "perfect-debounce": "^1.0.0",
     "pkg-types": "^1.0.3",
     "rc9": "^2.1.1"
   },
   "devDependencies": {
-    "@vitest/coverage-v8": "^0.32.2",
-    "changelogen": "^0.5.3",
-    "eslint": "^8.43.0",
+    "@vitest/coverage-v8": "^0.34.6",
+    "changelogen": "^0.5.5",
+    "eslint": "^8.51.0",
     "eslint-config-unjs": "^0.2.1",
-    "expect-type": "^0.16.0",
-    "prettier": "^2.8.8",
-    "typescript": "^5.1.3",
-    "unbuild": "^1.2.1",
-    "vitest": "^0.32.2"
+    "expect-type": "^0.17.3",
+    "prettier": "^3.0.3",
+    "typescript": "^5.2.2",
+    "unbuild": "^2.0.0",
+    "vitest": "^0.34.6"
   },
-  "packageManager": "pnpm@8.6.3"
+  "packageManager": "pnpm@8.8.0"
 }