test: added test fixes

arthurfiorette · arthurfiorette · commit d233e3ed961c · 2023-09-14T20:10:50.000-03:00
diff --git a/src/html.ts b/src/html.ts
@@ -1,34 +1,55 @@
-import { Elysia } from 'elysia';
-import { isHtml } from './is-html';
-import { HtmlOptions } from './options';
+import { Elysia } from 'elysia'
+import { isHtml, isTagHtml } from './utils'
+import { HtmlOptions } from './options'
 
 export function html(options: HtmlOptions = {}) {
-  // Defaults
-  options.contentType ??= 'text/html; charset=utf8';
-  options.autoDetect ??= true;
-  options.isHtml ??= isHtml;
-  options.autoDoctype ??= true;
-
-  let instance = new Elysia({ name: '@elysiajs/html' }).derive(() => ({
-    html(value: string) {
-      if (options.autoDoctype && !isHtml(value)) {
-        value = '<!doctype html>' + value;
-      }
-
-      return new Response(value, {
-        headers: { 'content-type': options.contentType! }
-      });
-    }
-  }));
-
-  if (options.autoDetect) {
-    instance = instance.onAfterHandle(({ set }, response) => {
-      if (typeof response === 'string' && isHtml(response)) {
-        set.headers['content-type'] = options.contentType!;
-        return new Response(response, set);
-      }
-    });
-  }
-
-  return instance;
+	// Defaults
+	options.contentType ??= 'text/html; charset=utf8'
+	options.autoDetect ??= true
+	options.isHtml ??= isHtml
+	options.autoDoctype ??= true
+
+	let instance = new Elysia({ name: '@elysiajs/html' }).derive(() => ({
+		html(value: string) {
+			if (
+				options.autoDoctype &&
+				isHtml(value) &&
+				// Avoids double adding !doctype or adding to non root html tags.
+				isTagHtml(value)
+			) {
+				value = '<!doctype html>' + value
+			}
+
+			return new Response(value, {
+				headers: { 'content-type': options.contentType! }
+			})
+		}
+	}))
+
+	if (options.autoDetect) {
+		instance = instance.onAfterHandle(
+			// onAfterHandle should be present on a lot of stack traces, so we should not
+			// use anonymous functions here.
+			function htmlHandle({ set }, response) {
+				if (!isHtml(response)) {
+					return
+				}
+
+				// Full means that we should only try to convert raw string responses
+				if (options.autoDoctype === 'full' && isTagHtml(response)) {
+					response = '<!doctype html>' + response
+				}
+
+				set.headers['content-type'] = options.contentType!
+
+				return new Response(
+					// @ts-expect-error - We know this is a string.
+					response,
+					set
+				)
+			}
+		)
+	}
+
+	return instance
 }
diff --git a/src/index.ts b/src/index.ts
@@ -1,6 +1,9 @@
-export * from './html';
-export * from './options';
-export * from './is-html';
+// Adds @kitajs/html's Html globally.
+import '@kitajs/html/register'
+
+export * from './html'
+export * from './options'
+export * from './utils'
 
 // We cannot use `export * as Html` because @kitajs/html uses `export =`
-export const Html = require('@kitajs/html') as typeof import('@kitajs/html');
+export const Html = require('@kitajs/html') as typeof import('@kitajs/html')
diff --git a/src/is-html.ts b/src/is-html.ts
diff --git a/src/options.ts b/src/options.ts
@@ -4,38 +4,48 @@
  * @link https://elysiajs.com/plugins/html.html
  */
 export interface HtmlOptions {
-  /**
-   * The content-type of the response.
-   *
-   * @default 'text/html; charset=utf8'
-   */
-  contentType?: string;
+	/**
+	 * The content-type of the response.
+	 *
+	 * @default 'text/html; charset=utf8'
+	 */
+	contentType?: string
 
-  /**
-   * Whether to automatically detect HTML content and set the content-type.
-   *
-   * @default true
-   */
-  autoDetect?: boolean;
+	/**
+	 * Whether to automatically detect HTML content and set the content-type.
+	 *
+	 * @default true
+	 */
+	autoDetect?: boolean
 
-  /**
-   * Whether to automatically add `<!doctype html>` to the response, if not found.
-   *
-   * @default true
-   */
-  autoDoctype?: boolean;
+	/**
+	 * Whether to automatically add `<!doctype html>` to a response starting with <html>, if not found.
+	 *
+   * Use `full` to also automatically add doctypes on responses returned without this plugin
+   * 
+   * ```ts
+   * // without the plugin
+   * app.get('/', () => '<html></html>')
+   * 
+   * // With the plugin
+   * app.get('/', ({ html }) => html('<html></html>')	
+   * ```
+   * 
+	 * @default true
+	 */
+	autoDoctype?: boolean | 'full'
 
-  /**
-   * The function used to detect if a string is a html or not. Default
-   * implementation if length is greater than 3, starts with `<` and ends
-   * with `>`.
-   *
-   * There's no real way to validate HTML, so this is a best guess.
-   *
-   * @see https://stackoverflow.com/q/1732348
-   * @see https://stackoverflow.com/q/11229831
-   *
-   * @default isHtml
-   */
-  isHtml?: (this: void, value: string) => boolean;
+	/**
+	 * The function used to detect if a string is a html or not. Default
+	 * implementation if length is greater than 3, starts with `<` and ends
+	 * with `>`.
+	 *
+	 * There's no real way to validate HTML, so this is a best guess.
+	 *
+	 * @see https://stackoverflow.com/q/1732348
+	 * @see https://stackoverflow.com/q/11229831
+	 *
+	 * @default isHtml
+	 */
+	isHtml?: (this: void, value: string) => boolean
 }
diff --git a/src/utils.ts b/src/utils.ts
@@ -0,0 +1,31 @@
+/**
+ * There's no real way to validate HTML, so this is a best guess.
+ *
+ * @see https://stackoverflow.com/q/1732348
+ * @see https://stackoverflow.com/q/11229831
+ */
+export function isHtml(this: void, value?: any): value is string {
+	if (typeof value !== 'string') {
+		return false
+	}
+
+	value = value.trim()
+	const length = value.length
+
+	return (
+		// Minimum html is 7 characters long: <a></a>
+		length >= 7 &&
+		// open tag
+		value[0] === '<' &&
+		// close tag
+		value[length - 1] === '>'
+	)
+}
+
+/**
+ * Returns true if the string starts with `<html`, **ignores whitespaces and
+ * casing**.
+ */
+export function isTagHtml(this: void, value: string) {
+  return value.trimStart().slice(0, 5).startsWith('<html')
+}
