c12 - npm Package Compare versions

Comparing version 1.5.0 to 1.5.1

dist/index.d.ts

 import { JITI } from 'jiti';
 import { JITIOptions } from 'jiti/dist/types';
+import { DownloadTemplateOptions } from 'giget';
 import { WatchOptions } from 'chokidar';
@@ -57,2 +58,3 @@ import { diff } from 'ohash';
     meta?: MT;
+    giget?: DownloadTemplateOptions;
     overrides?: T;
@@ -88,2 +90,3 @@ [key: string]: any;
     jitiOptions?: JITIOptions;
+    giget?: DownloadTemplateOptions;
     extend?: false | {
@@ -90,0 +93,0 @@ extendKey?: string | string[];

package.json

 {
   "name": "c12",
-  "version": "1.5.0",
+  "version": "1.5.1",
   "description": "Smart Config Loader",
@@ -28,3 +28,3 @@ "repository": "unjs/c12",
     "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",
@@ -31,0 +31,0 @@ "test:types": "tsc --noEmit"

README.md

@@ -126,2 +126,6 @@ # ⚙️ c12
 
+### `giget`
+
+Options passed to [unjs/giget](https://github.com/unjs/giget) when extending layer from git source.
+
 ### `envName`
@@ -209,2 +213,35 @@
 
+## 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
@@ -211,0 +248,0 @@

No alert changes

Improved metrics

Total package byte prevSize

51693

increased by2.68%

Lines of code

913

increased by1.22%

Number of lines in readme file

336

increased by12.37%

No dependency changes