c12 1.5.0 → 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

@@ -271,7 +271,11 @@ 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,
+      ...options.giget,
+      ...sourceOptions.giget
+    });
     source = cloned.dir;
   }
   if (NPM_PACKAGE_RE.test(source)) {

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,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[];
     };

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,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[];
     };

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[];
     };

package/dist/index.mjs

@@ -251,7 +251,11 @@ 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,
+      ...options.giget,
+      ...sourceOptions.giget
+    });
     source = cloned.dir;
   }
   if (NPM_PACKAGE_RE.test(source)) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "c12",
-  "version": "1.5.0",
+  "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"
   },