Add schema option to glob-modules

.changeset/modern-points-invent.md

@@ -0,0 +1,5 @@
+---
+'glob-modules': minor
+---
+
+Added a `schema` option to validate the shape of globbed modules

packages/glob-modules/README.md

@@ -10,7 +10,7 @@ npm install glob-modules
 
 ## Usage
 
-**Example directory structure:**
+The examples below assume the following directory structure:
 
 ```
 src/
@@ -21,14 +21,20 @@ src/
     |__ baz.txt
 ```
 
+Where the modules are defined as follows:
+
 ```js
 // src/commands/foo.js
 export default 'foo'
 
 // src/commands/bar.js
 export default 'bar'
 export const baz = 'baz'
+```
+
+### Example: Basic
 
+```js
 // src/main.js
 import { globModules } from 'glob-modules'
 
@@ -37,14 +43,45 @@ const { commands } = await globModules('./commands/*.js', {
 })
 /*
 commands === {
-	foo: {
-		default: 'foo',
-	},
-	bar: {
-		default: 'bar',
-		baz: 'baz',
-	},
+  foo: {
+    default: 'foo',
+  },
+  bar: {
+    default: 'bar',
+    baz: 'baz',
+  },
 }
 */
+```
+
+### Example: TypeScript
+
+```ts
+// src/main.js
+import { globModules } from 'glob-modules'
 
+const { commands } = await globModules<{
+  foo: string
+  bar: { default: string; baz: string }
+}>('./commands/*.js', { importMeta: import.meta })
+```
+
+### Example: Zod
+
+```ts
+import { globModules } from 'glob-modules'
+import { z } from 'zod'
+
+const { commands } = await globModules('./commands/*.js', {
+  importMeta: import.meta,
+  schema: z.object({
+    foo: z.object({
+      default: z.string(),
+    }),
+    bar: z.object({
+      default: z.string(),
+      baz: z.string(),
+    }),
+  }),
+})
 ```

packages/glob-modules/src/glob-modules.ts

@@ -28,7 +28,10 @@ type GlobModulesCWDOptions =
     }
 
 export type GlobModulesPatterns = GlobbyParameters[0]
-export type GlobModulesOptions = GlobModulesCWDOptions
+export type GlobModulesOptions<T extends GlobModulesResult> =
+  GlobModulesCWDOptions & {
+    schema?: { parse: (globbedModules: unknown) => T }
+  }
 
 // TODO: Add import-lazy
 // - lib: https://www.npmjs.com/package/import-lazy
@@ -37,7 +40,7 @@ type GlobModulesResult = { [globModuleNames: string]: any }
 
 export async function globModules<T extends GlobModulesResult>(
   patterns: GlobModulesPatterns,
-  options: GlobModulesOptions,
+  options: GlobModulesOptions<T>,
 ): Promise<T> {
   const cwd = getCWD(options)
 
@@ -72,6 +75,10 @@ export async function globModules<T extends GlobModulesResult>(
     }
   }
 
+  if (options.schema) {
+    return options.schema.parse(modules)
+  }
+
   return modules as T
 }