c12 - npm Package Compare versions

Comparing version 0.1.0 to 0.1.1

dist/index.d.ts

@@ -37,7 +37,14 @@ interface DotenvOptions {
 
-declare type ConfigT = Record<string, any>;
-interface LoadConfigOptions<T extends ConfigT = ConfigT> {
+interface InputConfig extends Record<string, any> {
+}
+interface ResolvedConfig<T extends InputConfig = InputConfig> {
+    config: T;
+    cwd: string;
+    configFile: string;
+    layers: ResolvedConfig<T>[];
+}
+interface LoadConfigOptions<T extends InputConfig = InputConfig> {
     name?: string;
     cwd?: string;
-    configFile?: false | string;
+    configFile?: string;
     rcFile?: false | string;
@@ -49,9 +56,4 @@ globalRc?: boolean;
 }
-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>>;
+declare function loadConfig<T extends InputConfig = InputConfig>(opts: LoadConfigOptions<T>): Promise<ResolvedConfig<T>>;
 
-export { ConfigT, DotenvOptions, Env, LoadConfigOptions, ResolvedConfig, loadConfig, loadDotenv, setupDotenv };
+export { DotenvOptions, Env, InputConfig, LoadConfigOptions, ResolvedConfig, loadConfig, loadDotenv, setupDotenv };

package.json

 {
   "name": "c12",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Smart Config Loader",
@@ -32,2 +32,3 @@ "repository": "unjs/c12",
     "dotenv": "^14.3.2",
+    "gittar": "^0.1.1",
     "jiti": "^1.12.14",
@@ -34,0 +35,0 @@ "mlly": "^0.4.1",

README.md

@@ -8,3 +8,3 @@ # c12
 
-> Smart Config Loader
+> Smart Configuration Loader
 
@@ -17,2 +17,3 @@ ## Features
 - `.env` support with [dotenv](https://www.npmjs.com/package/dotenv)
+- Support extending nested configurations from multiple local or git sourecs
 
@@ -47,3 +48,7 @@ ## Usage
 ```js
+// Get loaded config
 const { config } = await loadConfig({})
+
+// Get resolved config and extended layers
+const { config, configFile, layers } = await loadConfig({})
 ```
@@ -60,2 +65,3 @@
 5. default config passed by options
+6. Extended config layers
 
@@ -100,2 +106,81 @@ ## Options
 
+## Extending configuration
+
+If resolved config contains a `extends` key, it will be used to extend configuration.
+
+Extending can be nested and each layer can extend from one base or more.
+
+Final config is merged result of extended options and user options with [unjs/defu](https://github.com/unjs/defu).
+
+Each item in extends, is a string that can be either an absolute or relative path to current config file pointing to a config file for extending or directory containing config file.
+If it starts with either of `github:`, `gitlab:`, `bitbucket:` or `https:`, c12 autmatically clones it.
+
+For custom merging strategies, you can directly access each layer with `layers` property.
+
+**Example:**
+
+```js
+// config.ts
+export default {
+  colors: {
+    primary: 'user_primary'
+  },
+  extends: [
+    './theme',
+    './config.dev.ts'
+  ]
+}
+```
+
+```js
+// config.dev.ts
+export default {
+  dev: true
+}
+```
+
+```js
+// theme/config.ts
+export default {
+  extends: '../base',
+  colors: {
+    primary: 'theme_primary',
+    secondary: 'theme_secondary'
+  }
+}
+```
+
+```js
+// base/config.ts
+export default {
+  colors: {
+    primary: 'base_primary'
+    text: 'base_text'
+  }
+}
+```
+
+Loaded configuration would look like this:
+
+```js
+{
+  dev: true,
+  colors: {
+    primary: 'user_primary',
+    secondary: 'theme_secondary',
+    text: 'base_text'
+  }
+}
+```
+
+Layers:
+
+```js
+[
+ { config: /* theme config */, configFile: /* path/to/theme/config.ts */, cwd: /* path/to/theme */ },
+ { config: /* base  config */, configFile: /* path/to/base/config.ts  */, cwd: /* path/to/base */ },
+ { config: /* dev   config */, configFile: /* path/to/config.dev.ts  */, cwd: /* path/ */ },
+]
+```
+
 ## 💻 Development
@@ -102,0 +187,0 @@

No alert changes

Improved metrics

Total package byte prevSize

20781

increased by39.05%

Lines of code

406

increased by30.55%

Number of lines in readme file

204

increased by71.43%

Worsened metrics

Dependency count

7

increased by16.67%

Dependency changes

• + Addedgittar@^0.1.1

• + Addedchownr@1.1.4(transitive)

• + Addedfs-minipass@1.2.7(transitive)

• + Addedgittar@0.1.1(transitive)

• + Addedminimist@1.2.8(transitive)

• + Addedminipass@2.9.0(transitive)

• + Addedminizlib@1.3.3(transitive)

• + Addedmkdirp@0.5.6(transitive)

• + Addedsafe-buffer@5.2.1(transitive)

• + Addedtar@4.4.19(transitive)

• + Addedyallist@3.1.1(transitive)