monorepo-config 0.1.4 → 0.2.1

package/README.md

@@ -35,44 +35,39 @@ Actually setting the config happens in yet another place. Using `setConfig(confi
 
 ## Profile-based usage
 
-This allows you to replace the mess of untyped, unchecked env vars across packages with something more manageable (inspired by [Django](https://docs.djangoproject.com/en/6.0/topics/settings/)).
+**Still being worked on! Typescript imports may lead to dependency cycles, which breaks some tools.**
 
-First you can (optionally) set `profileDir` on your configuration definition:
-
-```ts
-export const configDef = makeConfig({
-  package: 'your-package',
-  schema: z.object({
-    foobar: z.string(),
-  }),
-  depedencies: [ otherConfigDef ],
-  profileDir: import.meta.dirname,
-});
-```
-
-You can then load the chosen configuration based on a single environment variable like so:
+This allows you to replace the mess of untyped, unchecked env vars across packages with something more manageable (inspired by [Django](https://docs.djangoproject.com/en/6.0/topics/settings/)). You can load the chosen configuration based on a single environment variable like so:
 
 ```ts
 import { loadConfigProfile } from "monorepo-config";
 import { configDef } from "./config-def.ts";
 
-export const FOOBAR_CONFIG = await loadConfigProfile(configDef, 'FOOBAR_CONFIG');
+export const loader = loadProfileByEnvVar('FOOBAR_CONFIG', (profile) => import(`./${profile}.js`).then(x => x.default))
+
+export const FOOBAR_CONFIG = await loadConfigProfile(configDef, loader);
 ```
 
 Profiles are just typescript files like this:
 
 ```ts
+import type { MergeConfigTypes } from "monorepo-config";
 import type { configDef } from "./config-def.ts";
+import type { otherConfigDef } from "other-package/config-def.ts";
+
+type Config = MergeConfigTypes<[
+  typeof configDef, typeof otherConfig, ...
+]>;
 
 export default {
   'your-package': {
     foobar: 'quuz'
   },
   'other-config': { ... }
-} satisfies typeof configDef.input;
+} satisfies Config;
 ```
 
-You can choose, like the example, to use the same name the configuration object as the environment variable. The idea is to use the same environment variable for all packages in your monorepo (this mirrors `DJANGO_SETTINGS_MODULE`).
+You can split up the above as you wish. You can choose, like the example, to use the same name for the configuration object as the environment variable. The idea is to use the same environment variable for all packages in your monorepo (this mirrors `DJANGO_SETTINGS_MODULE`).
 
 
 ## Which to use?
@@ -80,6 +75,13 @@ You can choose, like the example, to use the same name the configuration object
 You can mix both in your monorepo! Packages representing reusable libraries probably want to stick with the basic usage and let other packages define their config. Packages that represent apps probably want to define their own config using profiles.
 
 
+## Common errors
+
+### Package name '...' is used for two different config definitions
+
+Your package manager may have included two different copies of the same code. Run `pnpm dedupe`, or manually inspect your lockfile to verify this. If not, add `console.trace()` calls to the `defineConfig` function to figure out exactly where the configs are defined.
+
+
 ## TODO
 
 - [ ] Vite plugin

package/dist/index.d.ts

@@ -1,4 +1,4 @@
 export { defineConfig, setConfig, getConfig } from "./basic.js";
 export type { MergeConfigTypes } from "./basic.js";
-export { loadConfigProfile } from "./profile.js";
+export { loadConfigProfile, loadProfileByEnvVar } from "./profile.js";
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAChE,YAAY,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AACnD,OAAO,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAChE,YAAY,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AACnD,OAAO,EAAE,iBAAiB,EAAE,mBAAmB,EAAE,MAAM,cAAc,CAAC"}

package/dist/index.js

@@ -1,3 +1,3 @@
 export { defineConfig, setConfig, getConfig } from "./basic.js";
-export { loadConfigProfile } from "./profile.js";
+export { loadConfigProfile, loadProfileByEnvVar } from "./profile.js";
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAEhE,OAAO,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAEhE,OAAO,EAAE,iBAAiB,EAAE,mBAAmB,EAAE,MAAM,cAAc,CAAC"}

package/dist/profile.d.ts

@@ -1,10 +1,9 @@
 import type { output, ZodObject } from "zod";
 import { ConfigDefinition } from "./basic.js";
+export type ProfileLoader = (profile: string) => Promise<object>;
+export declare function loadProfileByEnvVar(envVar: string, importer: ProfileLoader): () => Promise<object>;
 export declare function loadConfigProfile<PackageName extends string, ConfigSchema extends ZodObject, SubSchemas extends Record<string, ZodObject>>(config: ConfigDefinition<PackageName, ConfigSchema, SubSchemas> & {
-    profileDir: string;
-    profileSuffix?: string;
-}, envVar: string, profileDir?: string): Promise<output<ConfigSchema>>;
-export declare function loadConfigProfile<PackageName extends string, ConfigSchema extends ZodObject, SubSchemas extends Record<string, ZodObject>>(config: ConfigDefinition<PackageName, ConfigSchema, SubSchemas> & {
-    profileSuffix?: string;
-}, envVar: string, profileDir: string): Promise<output<ConfigSchema>>;
+    loader: () => Promise<object>;
+}, loader?: () => Promise<object>): Promise<output<ConfigSchema>>;
+export declare function loadConfigProfile<PackageName extends string, ConfigSchema extends ZodObject, SubSchemas extends Record<string, ZodObject>>(config: ConfigDefinition<PackageName, ConfigSchema, SubSchemas>, loader: () => Promise<object>): Promise<output<ConfigSchema>>;
 //# sourceMappingURL=profile.d.ts.map

package/dist/profile.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"profile.d.ts","sourceRoot":"","sources":["../src/profile.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,KAAK,CAAC;AAC7C,OAAO,EAAe,gBAAgB,EAAa,MAAM,YAAY,CAAC;AAGtE,wBAAsB,iBAAiB,CACrC,WAAW,SAAS,MAAM,EAC1B,YAAY,SAAS,SAAS,EAC9B,UAAU,SAAS,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,EAE5C,MAAM,EAAE,gBAAgB,CAAC,WAAW,EAAE,YAAY,EAAE,UAAU,CAAC,GAAG;IAAE,UAAU,EAAE,MAAM,CAAC;IAAC,aAAa,CAAC,EAAE,MAAM,CAAA;CAAE,EAChH,MAAM,EAAE,MAAM,EACd,UAAU,CAAC,EAAE,MAAM,GAClB,OAAO,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,CAAA;AAEhC,wBAAsB,iBAAiB,CACrC,WAAW,SAAS,MAAM,EAC1B,YAAY,SAAS,SAAS,EAC9B,UAAU,SAAS,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,EAE5C,MAAM,EAAE,gBAAgB,CAAC,WAAW,EAAE,YAAY,EAAE,UAAU,CAAC,GAAG;IAAE,aAAa,CAAC,EAAE,MAAM,CAAA;CAAE,EAC5F,MAAM,EAAE,MAAM,EACd,UAAU,EAAE,MAAM,GACjB,OAAO,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,CAAA"}
+{"version":3,"file":"profile.d.ts","sourceRoot":"","sources":["../src/profile.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,KAAK,CAAC;AAC7C,OAAO,EAAe,gBAAgB,EAAa,MAAM,YAAY,CAAC;AAEtE,MAAM,MAAM,aAAa,GAAG,CAAC,OAAO,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC;AAIjE,wBAAgB,mBAAmB,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,aAAa,GAAG,MAAM,OAAO,CAAC,MAAM,CAAC,CAWlG;AAED,wBAAsB,iBAAiB,CACrC,WAAW,SAAS,MAAM,EAC1B,YAAY,SAAS,SAAS,EAC9B,UAAU,SAAS,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,EAE5C,MAAM,EAAE,gBAAgB,CAAC,WAAW,EAAE,YAAY,EAAE,UAAU,CAAC,GAAG;IAAE,MAAM,EAAE,MAAM,OAAO,CAAC,MAAM,CAAC,CAAA;CAAE,EACnG,MAAM,CAAC,EAAE,MAAM,OAAO,CAAC,MAAM,CAAC,GAC7B,OAAO,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,CAAA;AAEhC,wBAAsB,iBAAiB,CACrC,WAAW,SAAS,MAAM,EAC1B,YAAY,SAAS,SAAS,EAC9B,UAAU,SAAS,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,EAE5C,MAAM,EAAE,gBAAgB,CAAC,WAAW,EAAE,YAAY,EAAE,UAAU,CAAC,EAC/D,MAAM,EAAE,MAAM,OAAO,CAAC,MAAM,CAAC,GAC5B,OAAO,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,CAAA"}

package/dist/profile.js

@@ -1,19 +1,28 @@
 import { ConfigError, setConfig } from "./basic.js";
-import { join } from "path";
-export async function loadConfigProfile(config, envVar, profileDir) {
-    const configName = process.env[envVar];
-    if (configName === undefined) {
-        throw new ConfigError(`Please set the environment variable ${envVar}`);
-    }
-    profileDir = profileDir ?? config.profileDir;
-    if (profileDir === undefined) {
-        throw new ConfigError(`Either give profileDir as an argument or set profileDir in the config metadata`);
+const ProfileName = Symbol('monorepo-config:ProfileName');
+export function loadProfileByEnvVar(envVar, importer) {
+    return async () => {
+        const profileName = process.env[envVar];
+        if (profileName === undefined) {
+            throw new ConfigError(`Please set the environment variable ${envVar}`);
+        }
+        const res = await importer(profileName);
+        res[ProfileName] = profileName;
+        return res;
+    };
+}
+export async function loadConfigProfile(config, loader) {
+    loader = loader ?? config.loader;
+    if (loader === undefined) {
+        throw new ConfigError(`Either give loader as an argument or set loader in the config metadata`);
     }
-    const path = join(profileDir, `${configName}.${config.profileSuffix ?? 'js'}`);
-    const data = (await import(path)).default;
+    console.debug("LOADER IS", loader);
+    //const path = join(loader, `${configName}.${config.profileSuffix ?? 'js'}`);
+    const data = await loader();
     setConfig(config, data);
     if (!config.isLoaded) {
-        console.warn(`WARNING: Imported ${path} into ${config.package} but config was still not marked as set`);
+        const profileName = data[ProfileName];
+        console.warn(`WARNING: Imported config (profile ${profileName}) for ${config.package} but config was still not marked as set`);
     }
     return config.output;
 }

package/dist/profile.js.map

@@ -1 +1 @@
-{"version":3,"file":"profile.js","sourceRoot":"","sources":["../src/profile.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAoB,SAAS,EAAE,MAAM,YAAY,CAAC;AACtE,OAAO,EAAE,IAAI,EAAE,MAAM,MAAM,CAAC;AAsB5B,MAAM,CAAC,KAAK,UAAU,iBAAiB,CAKrC,MAAiH,EACjH,MAAc,EACd,UAAmB;IAEnB,MAAM,UAAU,GAAG,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IACvC,IAAI,UAAU,KAAK,SAAS,EAAE,CAAC;QAC7B,MAAM,IAAI,WAAW,CAAC,uCAAuC,MAAM,EAAE,CAAC,CAAC;IACzE,CAAC;IACD,UAAU,GAAG,UAAU,IAAI,MAAM,CAAC,UAAU,CAAC;IAC7C,IAAI,UAAU,KAAK,SAAS,EAAE,CAAC;QAC7B,MAAM,IAAI,WAAW,CAAC,gFAAgF,CAAC,CAAC;IAC1G,CAAC;IACD,MAAM,IAAI,GAAG,IAAI,CAAC,UAAU,EAAE,GAAG,UAAU,IAAI,MAAM,CAAC,aAAa,IAAI,IAAI,EAAE,CAAC,CAAC;IAC/E,MAAM,IAAI,GAAG,CAAC,MAAM,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC;IAC1C,SAAS,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IAExB,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC;QACrB,OAAO,CAAC,IAAI,CAAC,qBAAqB,IAAI,SAAS,MAAM,CAAC,OAAO,yCAAyC,CAAC,CAAC;IAC1G,CAAC;IAED,OAAO,MAAM,CAAC,MAAM,CAAC;AACvB,CAAC"}
+{"version":3,"file":"profile.js","sourceRoot":"","sources":["../src/profile.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAoB,SAAS,EAAE,MAAM,YAAY,CAAC;AAItE,MAAM,WAAW,GAAkB,MAAM,CAAC,6BAA6B,CAAC,CAAC;AAEzE,MAAM,UAAU,mBAAmB,CAAC,MAAc,EAAE,QAAuB;IACzE,OAAO,KAAK,IAAI,EAAE;QAChB,MAAM,WAAW,GAAG,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QACxC,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;YAC9B,MAAM,IAAI,WAAW,CAAC,uCAAuC,MAAM,EAAE,CAAC,CAAC;QACzE,CAAC;QAED,MAAM,GAAG,GAAG,MAAM,QAAQ,CAAC,WAAW,CAAC,CAAC;QACvC,GAAW,CAAC,WAAW,CAAC,GAAG,WAAW,CAAC;QACxC,OAAO,GAAG,CAAC;IACb,CAAC,CAAA;AACH,CAAC;AAoBD,MAAM,CAAC,KAAK,UAAU,iBAAiB,CAKrC,MAAoG,EACpG,MAA8B;IAE9B,MAAM,GAAG,MAAM,IAAI,MAAM,CAAC,MAAM,CAAC;IACjC,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;QACzB,MAAM,IAAI,WAAW,CAAC,wEAAwE,CAAC,CAAC;IAClG,CAAC;IACD,OAAO,CAAC,KAAK,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;IACnC,6EAA6E;IAC7E,MAAM,IAAI,GAAG,MAAM,MAAM,EAAE,CAAC;IAC5B,SAAS,CAAC,MAAM,EAAE,IAAW,CAAC,CAAC;IAE/B,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC;QACrB,MAAM,WAAW,GAAI,IAAY,CAAC,WAAW,CAAC,CAAC;QAC/C,OAAO,CAAC,IAAI,CAAC,qCAAqC,WAAW,SAAS,MAAM,CAAC,OAAO,yCAAyC,CAAC,CAAC;IACjI,CAAC;IAED,OAAO,MAAM,CAAC,MAAM,CAAC;AACvB,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "monorepo-config",
-  "version": "0.1.4",
+  "version": "0.2.1",
   "description": "Managed and validated configs across packages (no deps, but bring your own zod)",
   "main": "./dist/index.js",
   "type": "module",