chore(docs): v0.6.0 API docs & examples

Author: FranckFreiburger

docs/api/README.md

@@ -12,6 +12,7 @@
 * [CustomBlock](README.md#customblock)
 * [CustomBlockCallback](README.md#customblockcallback)
 * [File](README.md#file)
+* [LangProcessor](README.md#langprocessor)
 * [Module](README.md#module)
 * [ModuleExport](README.md#moduleexport)
 * [ModuleHandler](README.md#modulehandler)
@@ -27,8 +28,10 @@
 
 ### Functions
 
+* [buildTemplateProcessor](README.md#buildtemplateprocessor)
 * [createSFCModule](README.md#createsfcmodule)
 * [defaultGetResource](README.md#defaultgetresource)
+* [defaultHandleModule](README.md#defaulthandlemodule)
 * [loadModule](README.md#loadmodule)
 * [loadModuleInternal](README.md#loadmoduleinternal)
 
@@ -42,7 +45,7 @@
 
 Ƭ  **Cache**: { get: (key: string) => Promise<string\> ; set: (key: string, value: string) => Promise<void\>  }
 
-*Defined in [types.ts:15](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/893f1d4/src/types.ts#L15)*
+*Defined in [types.ts:15](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/be82822/src/types.ts#L15)*
 
 #### Type declaration:
 
@@ -57,7 +60,7 @@ ___
 
 Ƭ  **CustomBlock**: { attrs: Record<string, string \| true\> ; content: string ; type: string  }
 
-*Defined in [types.ts:95](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/893f1d4/src/types.ts#L95)*
+*Defined in [types.ts:95](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/be82822/src/types.ts#L95)*
 
 A custom block
 
@@ -75,7 +78,7 @@ ___
 
 Ƭ  **CustomBlockCallback**: (component: [ModuleExport](README.md#moduleexport)) => void
 
-*Defined in [types.ts:89](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/893f1d4/src/types.ts#L89)*
+*Defined in [types.ts:89](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/be82822/src/types.ts#L89)*
 
 CustomBlockCallback function type
 
@@ -85,7 +88,7 @@ ___
 
 Ƭ  **File**: { content: string \| ArrayBuffer ; extname: string  }
 
-*Defined in [types.ts:66](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/893f1d4/src/types.ts#L66)*
+*Defined in [types.ts:66](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/be82822/src/types.ts#L66)*
 
 Represents a file content and the extension name.
 
@@ -98,11 +101,19 @@ Name | Type | Description |
 
 ___
 
+### LangProcessor
+
+Ƭ  **LangProcessor**: (source: string, preprocessOptions?: any) => Promise<string\> \| string
+
+*Defined in [types.ts:368](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/be82822/src/types.ts#L368)*
+
+___
+
 ### Module
 
 Ƭ  **Module**: { exports: [ModuleExport](README.md#moduleexport)  }
 
-*Defined in [types.ts:115](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/893f1d4/src/types.ts#L115)*
+*Defined in [types.ts:115](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/be82822/src/types.ts#L115)*
 
 This just represents a loaded js module
 
@@ -118,20 +129,20 @@ ___
 
 Ƭ  **ModuleExport**: {}
 
-*Defined in [types.ts:109](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/893f1d4/src/types.ts#L109)*
+*Defined in [types.ts:109](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/be82822/src/types.ts#L109)*
 
 This just represents a loaded js module exports
 
 ___
 
 ### ModuleHandler
 
-Ƭ  **ModuleHandler**: (source: string, path: string, options: [Options](README.md#options)) => Promise<[ModuleExport](README.md#moduleexport)\>
+Ƭ  **ModuleHandler**: (extname: string, source: string, path: string, options: [Options](README.md#options)) => Promise<[ModuleExport](README.md#moduleexport) \| null\>
 
-*Defined in [types.ts:60](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/893f1d4/src/types.ts#L60)*
+*Defined in [types.ts:60](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/be82822/src/types.ts#L60)*
 
 Used by the library when it does not know how to handle a given file type (eg. `.json` files).
-see [moduleHandlers](README.md#modulehandlers)
+see [[moduleHandlers]]
 
 **`param`** The content of the file
 
@@ -153,9 +164,9 @@ ___
 
 ### Options
 
-Ƭ  **Options**: { additionalBabelPlugins?: any[] ; compiledCache?: [Cache](README.md#cache) ; delimiters?: [string, string] ; moduleCache?: Record<string, LoadingType<[ModuleExport](README.md#moduleexport)\> \| [ModuleExport](README.md#moduleexport)\> ; moduleHandlers?: Record<string, [ModuleHandler](README.md#modulehandler)\> ; pathHandlers: [PathHandlers](README.md#pathhandlers) ; addStyle: (style: string, scopeId: string \| undefined) => void ; customBlockHandler?: (block: [CustomBlock](README.md#customblock), filename: string, options: [Options](README.md#options)) => Promise<[CustomBlockCallback](README.md#customblockcallback) \| undefined\> ; getFile: (path: string) => Promise<[File](README.md#file)\> ; getResource: (pathCx: [PathContext](README.md#pathcontext), options: [Options](README.md#options)) => [Resource](README.md#resource) ; loadModule?: (path: string, options: [Options](README.md#options)) => Promise<[ModuleExport](README.md#moduleexport) \| undefined\> ; log?: (type: string, ...data: any[]) => void  }
+Ƭ  **Options**: { additionalBabelPlugins?: any[] ; compiledCache?: [Cache](README.md#cache) ; delimiters?: [string, string] ; handleModule?: [ModuleHandler](README.md#modulehandler) ; moduleCache?: Record<string, LoadingType<[ModuleExport](README.md#moduleexport)\> \| [ModuleExport](README.md#moduleexport)\> ; pathHandlers: [PathHandlers](README.md#pathhandlers) ; addStyle: (style: string, scopeId: string \| undefined) => void ; customBlockHandler?: (block: [CustomBlock](README.md#customblock), filename: string, options: [Options](README.md#options)) => Promise<[CustomBlockCallback](README.md#customblockcallback) \| undefined\> ; getFile: (path: string) => Promise<[File](README.md#file)\> ; getResource: (pathCx: [PathContext](README.md#pathcontext), options: [Options](README.md#options)) => [Resource](README.md#resource) ; loadModule?: (path: string, options: [Options](README.md#options)) => Promise<[ModuleExport](README.md#moduleexport) \| undefined\> ; log?: (type: string, ...data: any[]) => void  }
 
-*Defined in [types.ts:126](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/893f1d4/src/types.ts#L126)*
+*Defined in [types.ts:126](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/be82822/src/types.ts#L126)*
 
 #### Type declaration:
 
@@ -164,8 +175,8 @@ Name | Type | Description |
 `additionalBabelPlugins?` | any[] | Additional babel plugins. [TBD]   ```javascript   ...   ...  ```  |
 `compiledCache?` | [Cache](README.md#cache) | [get](README.md#get)() and [set](README.md#set)() functions of this object are called when the lib needs to save or load already compiled code. get and set functions must return a `Promise` (or can be `async`). Since compilation consume a lot of CPU, is is always a good idea to provide this object.  **example:**  In the following example, we cache the compiled code in the browser's local storage. Note that local storage is a limited place (usually 5MB). Here we handle space limitation in a very basic way. Maybe (not tested), the following libraries may help you to gain more space [pako](https://github.com/nodeca/pako), [lz-string](https://github.com/pieroxy/lz-string/) ```javascript  ...  compiledCache: {   set(key, str) {     // naive storage space management    for (;;) {      try {       // doc: https://developer.mozilla.org/en-US/docs/Web/API/Storage      window.localStorage.setItem(key, str);      break;     } catch(ex) {      // here we handle DOMException: Failed to execute 'setItem' on 'Storage': Setting the value of 'XXX' exceeded the quota       window.localStorage.removeItem(window.localStorage.key(0));     }    }   },   get(key) {     return window.localStorage.getItem(key);   },  },  ... ```  |
 `delimiters?` | [string, string] | Sets the delimiters used for text interpolation within the template. Typically this is used to avoid conflicting with server-side frameworks that also use mustache syntax.   ```javascript   ...   <script>     // <!--    const vueContent = `     <template> Hello [[[[ who ]]]] !</template>     <script>     export default {      data() {       return {        who: 'world'       }      }     }     </script>    `;    // -->     const options = {     moduleCache: { vue: Vue },     getFile: () => vueContent,     addStyle: () => {},     delimiters: ['[[[[', ']]]]'],    }     const app = Vue.createApp(Vue.defineAsyncComponent(() => window['vue3-sfc-loader'].loadModule('file.vue', options)));    app.mount(document.body);    </script>   ...  ```  |
+`handleModule?` | [ModuleHandler](README.md#modulehandler) | Handle additional module types (eg. '.svg', '.json' ). see [ModuleHandler](README.md#modulehandler) |
 `moduleCache?` | Record<string, LoadingType<[ModuleExport](README.md#moduleexport)\> \| [ModuleExport](README.md#moduleexport)\> | Initial cache that will contain resolved dependencies. All new modules go here. `vue` must initially be contained in this object. [moduleCache](README.md#modulecache) is mandatory for the lib. If you do not provide it, the library will create one. It is recommended to provide a prototype-less object (`Object.create(null)`) to avoid potential conflict with `Object` properties (constructor, __proto__, hasOwnProperty, ...). ​ * See also [[options.loadModule]].  **example:** ```javascript  ...  moduleCache: Object.assign(Object.create(null), {   vue: Vue,  }),  ... ```   |
-`moduleHandlers?` | Record<string, [ModuleHandler](README.md#modulehandler)\> | Additional module type handlers. see [ModuleHandler](README.md#modulehandler) |
 `pathHandlers` | [PathHandlers](README.md#pathhandlers) | Abstact path handling |
 `addStyle` | (style: string, scopeId: string \| undefined) => void | - |
 `customBlockHandler?` | (block: [CustomBlock](README.md#customblock), filename: string, options: [Options](README.md#options)) => Promise<[CustomBlockCallback](README.md#customblockcallback) \| undefined\> | - |
@@ -180,7 +191,7 @@ ___
 
 Ƭ  **PathContext**: { refPath: string ; relPath: string  }
 
-*Defined in [types.ts:25](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/893f1d4/src/types.ts#L25)*
+*Defined in [types.ts:25](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/be82822/src/types.ts#L25)*
 
 A PathContext represents a path (relPath) relative to an abolute path (refPath)
 Note that relPath is not necessary relative, but it is, relPath is relative to refPath.
@@ -198,7 +209,7 @@ ___
 
 Ƭ  **PathHandlers**: { extname: (filepath: string) => string ; resolve: (pathCx: [PathContext](README.md#pathcontext)) => string  }
 
-*Defined in [types.ts:33](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/893f1d4/src/types.ts#L33)*
+*Defined in [types.ts:33](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/be82822/src/types.ts#L33)*
 
 #### Type declaration:
 
@@ -213,7 +224,7 @@ ___
 
 Ƭ  **Resource**: { getContent: () => Promise<[File](README.md#file)\> ; id: string ; path: string  }
 
-*Defined in [types.ts:77](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/893f1d4/src/types.ts#L77)*
+*Defined in [types.ts:77](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/be82822/src/types.ts#L77)*
 
 Represents a resource.
 
@@ -231,9 +242,9 @@ Name | Type | Description |
 
 • `Const` **version**: string = process.env.VERSION
 
-*Defined in [tools.ts:42](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/893f1d4/src/tools.ts#L42)*
+*Defined in [tools.ts:45](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/be82822/src/tools.ts#L45)*
 
-*Defined in [index.ts:11](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/893f1d4/src/index.ts#L11)*
+*Defined in [index.ts:22](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/be82822/src/index.ts#L22)*
 
 the version of the library (process.env.VERSION is set by webpack, at compile-time)
 
@@ -243,15 +254,37 @@ ___
 
 • `Const` **vueVersion**: string
 
-*Defined in [createSFCModule.ts:4](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/893f1d4/src/createSFCModule.ts#L4)*
+*Defined in [createSFCModule.ts:4](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/be82822/src/createSFCModule.ts#L4)*
 
 ## Functions
 
+### buildTemplateProcessor
+
+▸ **buildTemplateProcessor**(`processor`: [LangProcessor](README.md#langprocessor)): object
+
+*Defined in [index.ts:144](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/be82822/src/index.ts#L144)*
+
+Convert a function to template processor interface (consolidate)
+
+#### Parameters:
+
+Name | Type |
+------ | ------ |
+`processor` | [LangProcessor](README.md#langprocessor) |
+
+**Returns:** object
+
+Name | Type |
+------ | ------ |
+`render` | (source: string, preprocessOptions: string, cb: (\_err: any, \_res: any) => void) => void |
+
+___
+
 ### createSFCModule
 
 ▸ **createSFCModule**(`source`: string, `filename`: string, `options`: [Options](README.md#options)): Promise<[ModuleExport](README.md#moduleexport)\>
 
-*Defined in [createSFCModule.ts:3](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/893f1d4/src/createSFCModule.ts#L3)*
+*Defined in [createSFCModule.ts:3](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/be82822/src/createSFCModule.ts#L3)*
 
 #### Parameters:
 
@@ -269,7 +302,7 @@ ___
 
 ▸ **defaultGetResource**(`pathCx`: [PathContext](README.md#pathcontext), `options`: [Options](README.md#options)): [Resource](README.md#resource)
 
-*Defined in [index.ts:58](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/893f1d4/src/index.ts#L58)*
+*Defined in [index.ts:59](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/be82822/src/index.ts#L59)*
 
 #### Parameters:
 
@@ -282,11 +315,32 @@ Name | Type |
 
 ___
 
+### defaultHandleModule
+
+▸ **defaultHandleModule**(`extname`: string, `source`: string, `path`: string, `options`: [Options](README.md#options)): Promise<[ModuleExport](README.md#moduleexport) \| null\>
+
+*Defined in [tools.ts:360](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/be82822/src/tools.ts#L360)*
+
+Default implementation of handleModule
+
+#### Parameters:
+
+Name | Type |
+------ | ------ |
+`extname` | string |
+`source` | string |
+`path` | string |
+`options` | [Options](README.md#options) |
+
+**Returns:** Promise<[ModuleExport](README.md#moduleexport) \| null\>
+
+___
+
 ### loadModule
 
 ▸ **loadModule**(`path`: string, `options_?`: [Options](README.md#options)): Promise<[ModuleExport](README.md#moduleexport)\>
 
-*Defined in [index.ts:111](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/893f1d4/src/index.ts#L111)*
+*Defined in [index.ts:112](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/be82822/src/index.ts#L112)*
 
 This is the main function.
 This function is intended to be used only to load the entry point of your application.
@@ -340,7 +394,7 @@ ___
 
 ▸ **loadModuleInternal**(`pathCx`: [PathContext](README.md#pathcontext), `options`: [Options](README.md#options)): Promise<[ModuleExport](README.md#moduleexport)\>
 
-*Defined in [tools.ts:242](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/893f1d4/src/tools.ts#L242)*
+*Defined in [tools.ts:245](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/be82822/src/tools.ts#L245)*
 
 #### Parameters:
 
@@ -357,7 +411,7 @@ Name | Type |
 
 ▪ `Const` **defaultPathHandlers**: object
 
-*Defined in [index.ts:43](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/893f1d4/src/index.ts#L43)*
+*Defined in [index.ts:44](https://github.com/FranckFreiburger/vue3-sfc-loader/blob/be82822/src/index.ts#L44)*
 
 Default implementation of PathHandlers