wip(core)!: replace Options.moduleHandler object with Options.handleModule()

replace
  ModuleHandler : Record<string, ModuleHandler>
with
  ModuleHandler = (extname : string, source : FileContent, path : string, options : Options) => Promise<ModuleExport | null>

Author: FranckFreiburger

docs/examples.md

@@ -161,8 +161,10 @@ node -e "require('express')().use(require('express').static(__dirname, {index:'i
         },
       },
 
-      additionalModuleHandlers: {
-        '.json': (source, path, options) => JSON.parse(source),
+      handleModule(extname, source, path, options) {
+        
+        if ( extname === '.json' )
+          return JSON.parse(source);
       }
     }
 

src/index.ts

@@ -1,9 +1,8 @@
 import { posix as Path } from 'path'
 
-import { createJSModule, loadModuleInternal } from './tools'
-import { createSFCModule } from './createSFCModule'
+import { loadModuleInternal } from './tools'
 
-import { ModuleExport, ModuleHandler, PathHandlers, Options, File, Resource, PathContext, LangProcessor } from './types'
+import { ModuleExport, PathHandlers, Options, File, Resource, PathContext, LangProcessor } from './types'
 
 /**
  * the version of the library (process.env.VERSION is set by webpack, at compile-time)
@@ -27,16 +26,6 @@ function throwNotDefined(details : string) : never {
 }
 
 
-/**
- * @internal
- */
-const defaultModuleHandlers : Record<string, ModuleHandler> = {
-	'.vue': (source, path, options) => createSFCModule(source, path, options),
-	'.js': (source, path, options) => createJSModule(source, false, path, options),
-	'.mjs': (source, path, options) => createJSModule(source, true, path, options),
-};
-
-
 /**
  * Default implementation of PathHandlers
  */
@@ -114,7 +103,6 @@ export async function loadModule(path : string, options_ : Options = throwNotDef
 		moduleCache = Object.create(null),
 		getFile = throwNotDefined('options.getFile()'),
 		addStyle = throwNotDefined('options.addStyle()'),
-		moduleHandlers = null,
 		pathHandlers = defaultPathHandlers,
 		getResource = defaultGetResource,
 	} = options_;
@@ -133,7 +121,6 @@ export async function loadModule(path : string, options_ : Options = throwNotDef
 		getResource,
 		...options_,
 		getFile: normalizedGetFile,
-		moduleHandlers: { ...defaultModuleHandlers, ...moduleHandlers },
 	};
 
 	return await loadModuleInternal( { refPath: '/', relPath: path }, options);

src/tools.ts

@@ -34,6 +34,9 @@ import {
 	PathContext,
 } from './types'
 
+import { createSFCModule } from './createSFCModule'
+
+
 /**
  * @internal
  */
@@ -241,7 +244,7 @@ export async function transformJSCode(source : string, moduleSourceType : boolea
 
 export async function loadModuleInternal(pathCx : PathContext, options : Options) : Promise<ModuleExport> {
 
-	const { moduleCache, loadModule, moduleHandlers } = options;
+	const { moduleCache, loadModule, handleModule } = options;
 
 	const { id, path, getContent } = options.getResource(pathCx, options);
 
@@ -265,13 +268,20 @@ export async function loadModuleInternal(pathCx : PathContext, options : Options
 
 		const { content, extname } = await getContent();
 
-		if ( !(extname in moduleHandlers) )
-			throw new TypeError(`Unable to handle ${ extname } files (${ path }), see moduleHandlers`);
-
 		if ( typeof content !== 'string' )
 			throw new TypeError(`Invalid module content (${ path }): ${ content }`);
 
-		const module = await moduleHandlers[extname](content, path, options);
+		// note: null module is accepted
+		let module : ModuleExport | undefined | null = undefined;
+
+		if ( handleModule !== undefined )
+			module = await handleModule(extname, content, path, options);
+
+		if ( module === undefined )
+			module = await defaultHandleModule(extname, content, path, options);
+
+		if ( module === undefined )
+			throw new TypeError(`Unable to handle ${ extname } files (${ path })`);
 
 		return moduleCache[id] = module;
 
@@ -343,3 +353,17 @@ export async function loadDeps(filename : string, deps : string[], options : Opt
 	await Promise.all(deps.map(dep => loadModuleInternal({ refPath: filename, relPath: dep }, options)))
 }
 
+
+/**
+ * Default implementation of handleModule
+ */
+ async function defaultHandleModule(extname : string, source : string, path : string, options : Options) : Promise<ModuleExport | null> {
+
+	switch (extname) {
+		case '.vue': return createSFCModule(source.toString(), path, options);
+		case '.js': return createJSModule(source.toString(), false, path, options);
+		case '.mjs': return createJSModule(source.toString(), true, path, options);
+	}
+
+	return null;
+}

src/types.ts

@@ -57,7 +57,7 @@ export type PathHandlers = {
  *	...
  * ```
  */
-export type ModuleHandler = (source : string, path : string, options : Options) => Promise<ModuleExport>;
+export type ModuleHandler = (extname : string, source : string, path : string, options : Options) => Promise<ModuleExport | null>;
 
 
 /**
@@ -241,10 +241,10 @@ export type Options = {
 
 
 /**
- * Additional module type handlers. see [[ModuleHandler]]
+ * Handle additional module types (eg. '.svg', '.json' ). see [[ModuleHandler]]
  *
 */
-	moduleHandlers?: Record<string, ModuleHandler>,
+	handleModule?: ModuleHandler,
 
 
 /**

tests/basic.test.js

@@ -705,8 +705,11 @@ const { defaultFilesFactory, createPage } = require('./testsTools.js');
 					'/optionsOverride.js': `
 						export default (options) => {
 
-							options.moduleHandlers = {
-								'.svg': (source, path, options) => 'data:image/svg+xml,' + source,
+							options.handleModule = (extname, source, path, options) => {
+
+								switch (extname) {
+									case '.svg': return 'data:image/svg+xml,' + source.toString();
+								}
 							};
 						};
 					`,