@d1vij/jassm 0.1.18 → 0.1.19-beta.1

package/dist/index.d.ts

@@ -56,6 +56,7 @@ type GlobResult<T> = Record<string, T>;
 * Removes `.mdx` extension from a path
 */
 type StripExtension<T extends string> = T extends `${infer Rest}.mdx` ? Rest : T;
+type ResolveEmptyVirtual<Virtual extends string> = Virtual extends "/" ? "" : Virtual;
 /**
 * Derives the route keys produced by the registry and
 * replace filesystem root with a virtual route prefix
@@ -72,7 +73,7 @@ type RouteKey<
 	Modules extends Record<string, unknown>,
 	Root extends string,
 	Virtual extends string
-> = keyof { [K in keyof Modules as K extends `${string}${Root}/${infer Rest}.mdx` ? `${Virtual}/${Rest}` : never] : true } & string;
+> = keyof { [K in keyof Modules as K extends `${string}${Root}/${infer Rest}.mdx` ? `${ResolveEmptyVirtual<Virtual>}/${Rest}` : never] : true } & string;
 /**
 * Options passed to {@link generateRegistry}
 */
@@ -131,6 +132,7 @@ declare function generateRegistry<
 	*/
 	exports: Record<RouteKey<Modules, Root, Virtual>, Promise<Record<string, unknown>>>;
 };
+type Diffs = { [K in `inComponentsButNotIn${"Exports" | "Metadata"}` | `in${"Metadata" | "Exports"}ButNotInComponents`] : string[] | undefined };
 /**
 * Base class for all registry implementations.
 *
@@ -161,6 +163,14 @@ declare abstract class AbstractRegistry<
 	* Metadata registry
 	*/
 	abstract readonly metadata: Metadata;
+	/**
+	* Compare keys of all registries in to check consistency.
+	* @returns `null` if all keys are consistent.
+	*/
+	diffKeys(): null | {
+		error: Error;
+		diffs: Diffs;
+	};
 	private get;
 	/**
 	* Retrieve a React component by route key

package/dist/index.js

@@ -516,7 +516,6 @@ function generateRegistry({
   const _components = [];
   const _exports = [];
   const _metadata = [];
-  console.log(metadataGlob);
   for (const path of paths) {
     const route = path.replace(root, virtual).replace(".mdx", "");
     const loader = modulesGlob[path];
@@ -536,6 +535,52 @@ function generateRegistry({
 }
 
 class AbstractRegistry {
+  diffKeys() {
+    const keySet = new Set(this.keys);
+    const exportsSet = new Set(Object.keys(this.exports));
+    const metadataSet = new Set(Object.keys(this.metadata));
+    const exportsDiff = keySet.symmetricDifference(exportsSet);
+    const metadataDiff = keySet.symmetricDifference(metadataSet);
+    const errMsg = [];
+    const diffs = {
+      inComponentsButNotInExports: undefined,
+      inComponentsButNotInMetadata: undefined,
+      inExportsButNotInComponents: undefined,
+      inMetadataButNotInComponents: undefined
+    };
+    if (exportsDiff.size !== 0) {
+      diffs.inComponentsButNotInExports = Array.from(keySet.difference(exportsSet));
+      diffs.inExportsButNotInComponents = Array.from(exportsSet.difference(keySet));
+      errMsg.push(`Exports Registry and Component Registry have ${exportsDiff.size} key mismatches.
+                Keys which are present in Component map but not in Exports
+                	${diffs.inComponentsButNotInExports.join(`
+	`)}
+                and the keys present in Exports but not in component map are
+                	${diffs.inExportsButNotInComponents.join(`
+	`)}
+                `);
+    }
+    if (metadataDiff.size !== 0) {
+      diffs.inComponentsButNotInMetadata = Array.from(keySet.difference(metadataSet));
+      diffs.inMetadataButNotInComponents = Array.from(metadataDiff.difference(keySet));
+      errMsg.push(`Metadata Registry and Component Registry have ${metadataDiff.size} key mismatches.
+                Keys which are present in Component map but not in Metadata
+                	${diffs.inComponentsButNotInMetadata.join(`
+	`)}
+                and the keys present in Metadata but not in Component map are
+                	${diffs.inMetadataButNotInComponents.join(`
+	`)}
+                `);
+    }
+    if (errMsg.length === 0)
+      return null;
+    return {
+      diffs,
+      error: new Error(errMsg.join(`
+
+`))
+    };
+  }
   get(_from, key) {
     const value = _from[key];
     if (!value) {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@d1vij/jassm",
-    "version": "0.1.18",
+    "version": "0.1.19-beta.1",
     "description": "Just another static site maker. Create simple content driven sites using MDX and React along with Typescript safety.",
     "homepage": "https://github.com/d1vij/jassm",
     "license": "MIT",