c12 1.5.0 → 1.6.0

package/README.md

@@ -5,7 +5,7 @@
 [![Codecov][codecov-src]][codecov-href]
 [![License][license-src]][license-href]
 
-Smart Configuration Loader.
+c12 (pronounced as /siːtwelv/, like c-twelve) is a smart configuration loader.
 
 ## Features
 
@@ -115,6 +115,10 @@ Specify default configuration. It is applied **before** extending config.
 
 Specify override configuration. It has the **highest** priority and is applied **before extending** config.
 
+### `omit$Keys`
+
+Exclude environment-specific and built-in keys start with `$` in the resolved config. The default is `false`.
+
 ### `jiti`
 
 Custom [unjs/jiti](https://github.com/unjs/jiti) instance used to import configuration files.
@@ -123,6 +127,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 +213,41 @@ 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:user/repo",
+};
+```
+
+**Example:** Extend from a github repository with branch and subpath
+
+```js
+// config.ts
+export default {
+  extends: "gh:user/repo/theme#dev",
+};
+```
+
+**Example:** Extend with clone configuration
+
+```js
+// config.ts
+export default {
+  extends: ["gh:user/repo", { giget: { auth: process.env.GITHUB_TOKEN } }],
+};
+```
+
+Refer to [unjs/giget](https://giget.unjs.io) for more information.
+
 ## Environment-specific configuration
 
 Users can define environment-specific configuration using these config keys:

package/dist/index.cjs

@@ -103,6 +103,7 @@ function interpolate(target, source = {}, parse = (v) => v) {
   }
 }
 
+const _normalize = (p) => p?.replace(/\\/g, "/");
 async function loadConfig(options) {
   options.cwd = pathe.resolve(process.cwd(), options.cwd || ".");
   options.name = options.name || "config";
@@ -195,6 +196,13 @@ async function loadConfig(options) {
   if (options.defaults) {
     r.config = defu.defu(r.config, options.defaults);
   }
+  if (options.omit$Keys) {
+    for (const key in r.config) {
+      if (key.startsWith("$")) {
+        delete r.config[key];
+      }
+    }
+  }
   return r;
 }
 async function extendConfig(config, options) {
@@ -249,7 +257,14 @@ async function extendConfig(config, options) {
     }
   }
 }
-const GIT_PREFIXES = ["gh:", "github:", "gitlab:", "bitbucket:", "https://"];
+const GIGET_PREFIXES = [
+  "gh:",
+  "github:",
+  "gitlab:",
+  "bitbucket:",
+  "https://",
+  "http://"
+];
 const NPM_PACKAGE_RE = /^(@[\da-z~-][\d._a-z~-]*\/)?[\da-z~-][\d._a-z~-]*($|\/.*)/;
 async function resolveConfig(source, options, sourceOptions = {}) {
   if (options.resolve) {
@@ -258,12 +273,15 @@ async function resolveConfig(source, options, sourceOptions = {}) {
       return res2;
     }
   }
-  if (GIT_PREFIXES.some((prefix) => source.startsWith(prefix))) {
+  if (GIGET_PREFIXES.some((prefix) => source.startsWith(prefix))) {
     const { downloadTemplate } = await import('giget');
     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)) {
+    const parentDir = pathe.dirname(options.cwd);
+    if (pathe.basename(parentDir) === ".c12") {
+      cloneDir = pathe.join(parentDir, cloneName);
+    } else 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);
@@ -271,7 +289,12 @@ async function resolveConfig(source, options, sourceOptions = {}) {
     if (node_fs.existsSync(cloneDir)) {
       await promises.rm(cloneDir, { recursive: true });
     }
-    const cloned = await downloadTemplate(source, { dir: cloneDir });
+    const cloned = await downloadTemplate(source, {
+      dir: cloneDir,
+      install: sourceOptions.install,
+      ...options.giget,
+      ...sourceOptions.giget
+    });
     source = cloned.dir;
   }
   if (NPM_PACKAGE_RE.test(source)) {
@@ -319,6 +342,8 @@ async function resolveConfig(source, options, sourceOptions = {}) {
   if (res.sourceOptions.overrides) {
     res.config = defu.defu(res.sourceOptions.overrides, res.config);
   }
+  res.configFile = _normalize(res.configFile);
+  res.source = _normalize(res.source);
   return res;
 }
 

package/dist/index.d.cts

@@ -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,8 @@ 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;
+    install?: boolean;
     overrides?: T;
     [key: string]: any;
 }
@@ -81,9 +84,11 @@ interface LoadConfigOptions<T extends UserInputConfig = UserInputConfig, MT exte
     defaults?: T;
     defaultConfig?: T;
     overrides?: T;
+    omit$Keys?: boolean;
     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[];
     };

package/dist/index.d.mts

@@ -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,8 @@ 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;
+    install?: boolean;
     overrides?: T;
     [key: string]: any;
 }
@@ -81,9 +84,11 @@ interface LoadConfigOptions<T extends UserInputConfig = UserInputConfig, MT exte
     defaults?: T;
     defaultConfig?: T;
     overrides?: T;
+    omit$Keys?: boolean;
     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[];
     };

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,8 @@ 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;
+    install?: boolean;
     overrides?: T;
     [key: string]: any;
 }
@@ -81,9 +84,11 @@ interface LoadConfigOptions<T extends UserInputConfig = UserInputConfig, MT exte
     defaults?: T;
     defaultConfig?: T;
     overrides?: T;
+    omit$Keys?: boolean;
     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[];
     };

package/dist/index.mjs

@@ -1,5 +1,5 @@
 import { existsSync, promises } from 'node:fs';
-import { resolve, join, extname, basename, dirname } from 'pathe';
+import { resolve, dirname, basename, join, extname } from 'pathe';
 import * as dotenv from 'dotenv';
 import { rm } from 'node:fs/promises';
 import { homedir } from 'node:os';
@@ -83,6 +83,7 @@ function interpolate(target, source = {}, parse = (v) => v) {
   }
 }
 
+const _normalize = (p) => p?.replace(/\\/g, "/");
 async function loadConfig(options) {
   options.cwd = resolve(process.cwd(), options.cwd || ".");
   options.name = options.name || "config";
@@ -175,6 +176,13 @@ async function loadConfig(options) {
   if (options.defaults) {
     r.config = defu(r.config, options.defaults);
   }
+  if (options.omit$Keys) {
+    for (const key in r.config) {
+      if (key.startsWith("$")) {
+        delete r.config[key];
+      }
+    }
+  }
   return r;
 }
 async function extendConfig(config, options) {
@@ -229,7 +237,14 @@ async function extendConfig(config, options) {
     }
   }
 }
-const GIT_PREFIXES = ["gh:", "github:", "gitlab:", "bitbucket:", "https://"];
+const GIGET_PREFIXES = [
+  "gh:",
+  "github:",
+  "gitlab:",
+  "bitbucket:",
+  "https://",
+  "http://"
+];
 const NPM_PACKAGE_RE = /^(@[\da-z~-][\d._a-z~-]*\/)?[\da-z~-][\d._a-z~-]*($|\/.*)/;
 async function resolveConfig(source, options, sourceOptions = {}) {
   if (options.resolve) {
@@ -238,12 +253,15 @@ async function resolveConfig(source, options, sourceOptions = {}) {
       return res2;
     }
   }
-  if (GIT_PREFIXES.some((prefix) => source.startsWith(prefix))) {
+  if (GIGET_PREFIXES.some((prefix) => source.startsWith(prefix))) {
     const { downloadTemplate } = await import('giget');
     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)) {
+    const parentDir = dirname(options.cwd);
+    if (basename(parentDir) === ".c12") {
+      cloneDir = join(parentDir, cloneName);
+    } else 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);
@@ -251,7 +269,12 @@ async function resolveConfig(source, options, sourceOptions = {}) {
     if (existsSync(cloneDir)) {
       await rm(cloneDir, { recursive: true });
     }
-    const cloned = await downloadTemplate(source, { dir: cloneDir });
+    const cloned = await downloadTemplate(source, {
+      dir: cloneDir,
+      install: sourceOptions.install,
+      ...options.giget,
+      ...sourceOptions.giget
+    });
     source = cloned.dir;
   }
   if (NPM_PACKAGE_RE.test(source)) {
@@ -299,6 +322,8 @@ async function resolveConfig(source, options, sourceOptions = {}) {
   if (res.sourceOptions.overrides) {
     res.config = defu(res.sourceOptions.overrides, res.config);
   }
+  res.configFile = _normalize(res.configFile);
+  res.source = _normalize(res.source);
   return res;
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "c12",
-  "version": "1.5.0",
+  "version": "1.6.0",
   "description": "Smart Config Loader",
   "repository": "unjs/c12",
   "license": "MIT",
@@ -25,16 +25,16 @@
     "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"
   },
   "dependencies": {
     "chokidar": "^3.5.3",
-    "defu": "^6.1.2",
+    "defu": "^6.1.3",
     "dotenv": "^16.3.1",
-    "giget": "^1.1.3",
-    "jiti": "^1.20.0",
+    "giget": "^1.2.1",
+    "jiti": "^1.21.0",
     "mlly": "^1.4.2",
     "ohash": "^1.1.3",
     "pathe": "^1.1.1",
@@ -43,15 +43,16 @@
     "rc9": "^2.1.1"
   },
   "devDependencies": {
-    "@vitest/coverage-v8": "^0.34.6",
+    "@types/node": "^20.10.5",
+    "@vitest/coverage-v8": "^1.1.0",
     "changelogen": "^0.5.5",
-    "eslint": "^8.51.0",
+    "eslint": "^8.56.0",
     "eslint-config-unjs": "^0.2.1",
     "expect-type": "^0.17.3",
-    "prettier": "^3.0.3",
-    "typescript": "^5.2.2",
+    "prettier": "^3.1.1",
+    "typescript": "^5.3.3",
     "unbuild": "^2.0.0",
-    "vitest": "^0.34.6"
+    "vitest": "^1.1.0"
   },
-  "packageManager": "pnpm@8.8.0"
+  "packageManager": "pnpm@8.13.1"
 }