feat: add html-validator:check nitro hook (#372)

Author: huang-julien

src/config.ts

@@ -29,10 +29,18 @@ export interface ModuleOptions {
   logLevel?: LogLevel
   failOnError?: boolean
   options?: ConfigData
+  /**
+   * allow to hook into `html-validator`
+   * enabling this option block the response until the HTML check and the hook has finished
+   *
+   * @default false
+   */
+  hookable: boolean
 }
 
 export const DEFAULTS: Required<Omit<ModuleOptions, 'logLevel'>> & { logLevel?: LogLevel } = {
   usePrettier: false,
   failOnError: false,
-  options: defaultHtmlValidateConfig
+  options: defaultHtmlValidateConfig,
+  hookable: false
 }

src/runtime/nitro.ts

@@ -7,10 +7,13 @@ export default <NitroAppPlugin> function (nitro) {
   const validator = getValidator(config.options)
   const { checkHTML } = useChecker(validator, config.usePrettier, config.logLevel)
 
-  nitro.hooks.hook('render:response', (response: RenderResponse, { event }) => {
+  nitro.hooks.hook('render:response', async (response: RenderResponse, { event }) => {
     if (typeof response.body === 'string' && (response.headers['Content-Type'] || response.headers['content-type'])?.includes('html')) {
-      // We deliberately do not await so as not to block the response
-      checkHTML(event.req.url, response.body)
+      // Block the response only if it's not hookable
+      const promise = checkHTML(event.req.url, response.body)
+      if (config.hookable) {
+        await nitro.hooks.callHook('html-validator:check', await promise, response, { event })
+      }
     }
   })
 }

src/runtime/validator.ts

@@ -34,7 +34,7 @@ export const useChecker = (
         console.log(`No HTML validation errors found for ${chalk.bold(url)}`)
       }
 
-      return
+      return { valid, results }
     }
 
     if (!valid) { invalidPages.push(url) }
@@ -54,6 +54,8 @@ export const useChecker = (
     } else {
       console.error(message)
     }
+
+    return { valid, results }
   }
 
   return { checkHTML, invalidPages }