ghtml 3.0.2 → 3.0.4

package/bench/index.js

@@ -104,6 +104,10 @@ bench.add("mixed escaped and unescaped expressions", () => {
   `;
 });
 
+bench.add("sparse escape", () => {
+  result = html`<p>${`${"noescape".repeat(250)}<>`.repeat(5)}</p>`;
+});
+
 await bench.warmup();
 await bench.run();
 

package/package.json

@@ -3,7 +3,7 @@
   "description": "Replace your template engine with fast JavaScript by leveraging the power of tagged templates.",
   "author": "Gürgün Dayıoğlu",
   "license": "MIT",
-  "version": "3.0.2",
+  "version": "3.0.4",
   "type": "module",
   "bin": "./bin/src/index.js",
   "main": "./src/index.js",
@@ -27,8 +27,8 @@
   "devDependencies": {
     "@fastify/pre-commit": "^2.1.0",
     "c8": "^10.1.2",
-    "grules": "^0.23.0",
-    "tinybench": "^2.8.0",
+    "grules": "^0.23.3",
+    "tinybench": "^2.9.0",
     "typescript": ">=5.5.4"
   },
   "repository": {

package/src/html.d.ts

@@ -1,24 +1,3 @@
-/**
- * @param {{ raw: Readonly<string[]> }} literals Tagged template literals.
- * @param {...any} expressions Expressions to interpolate.
- * @returns {string} The HTML string.
- */
-export function html({ raw: literals }: {
-    raw: Readonly<string[]>;
-}, ...expressions: any[]): string;
-/**
- * @param {{ raw: Readonly<string[]> }} literals Tagged template literals.
- * @param {...any} expressions Expressions to interpolate.
- * @yields {string} The HTML strings.
- */
-export function htmlGenerator({ raw: literals }: {
-    raw: Readonly<string[]>;
-}, ...expressions: any[]): {};
-/**
- * @param {{ raw: Readonly<string[]> }} literals Tagged template literals.
- * @param {...any} expressions Expressions to interpolate.
- * @yields {string} The HTML strings.
- */
-export function htmlAsyncGenerator({ raw: literals }: {
-    raw: Readonly<string[]>;
-}, ...expressions: any[]): {};
+export function html({ raw: literals }: TemplateStringsArray, ...expressions: any[]): string;
+export function htmlGenerator({ raw: literals }: TemplateStringsArray, ...expressions: any[]): Generator<string, void, void>;
+export function htmlAsyncGenerator({ raw: literals }: TemplateStringsArray, ...expressions: any[]): AsyncGenerator<string, void, void>;

package/src/html.js

@@ -1,49 +1,49 @@
-const escapeRegExp = /["&'<=>]/;
+const escapeRegExp = /["&'<=>]/g;
 
 const escapeFunction = (string) => {
+  if (!string || !escapeRegExp.test(string)) {
+    return string;
+  }
+
   let escaped = "";
   let start = 0;
 
-  for (let end = 0; end !== string.length; ++end) {
-    switch (string.charCodeAt(end)) {
+  do {
+    const i = escapeRegExp.lastIndex - 1;
+
+    switch (string.charCodeAt(i)) {
       case 34: // "
-        escaped += string.slice(start, end) + "&#34;";
-        start = end + 1;
-        continue;
+        escaped += string.slice(start, i) + "&#34;";
+        break;
       case 38: // &
-        escaped += string.slice(start, end) + "&#38;";
-        start = end + 1;
-        continue;
+        escaped += string.slice(start, i) + "&#38;";
+        break;
       case 39: // '
-        escaped += string.slice(start, end) + "&#39;";
-        start = end + 1;
-        continue;
+        escaped += string.slice(start, i) + "&#39;";
+        break;
       case 60: // <
-        escaped += string.slice(start, end) + "&#60;";
-        start = end + 1;
-        continue;
+        escaped += string.slice(start, i) + "&#60;";
+        break;
       case 61: // =
-        escaped += string.slice(start, end) + "&#61;";
-        start = end + 1;
-        continue;
+        escaped += string.slice(start, i) + "&#61;";
+        break;
       case 62: // >
-        escaped += string.slice(start, end) + "&#62;";
-        start = end + 1;
-        continue;
+        escaped += string.slice(start, i) + "&#62;";
+        break;
     }
-  }
 
-  escaped += string.slice(start);
+    start = escapeRegExp.lastIndex;
+  } while (escapeRegExp.test(string));
 
-  return escaped;
+  return escaped + string.slice(start);
 };
 
 /**
- * @param {{ raw: Readonly<string[]> }} literals Tagged template literals.
+ * @param {TemplateStringsArray} literals Tagged template literals.
  * @param {...any} expressions Expressions to interpolate.
- * @returns {string} The HTML string.
+ * @returns {string} The processed HTML string.
  */
-const html = ({ raw: literals }, ...expressions) => {
+export const html = ({ raw: literals }, ...expressions) => {
   let accumulator = "";
 
   for (let i = 0; i !== expressions.length; ++i) {
@@ -59,24 +59,23 @@ const html = ({ raw: literals }, ...expressions) => {
 
     if (literal && literal.charCodeAt(literal.length - 1) === 33) {
       literal = literal.slice(0, -1);
-    } else if (string && escapeRegExp.test(string)) {
+    } else {
       string = escapeFunction(string);
     }
 
     accumulator += literal + string;
   }
 
-  accumulator += literals[expressions.length];
-
-  return accumulator;
+  return accumulator + literals[expressions.length];
 };
 
 /**
- * @param {{ raw: Readonly<string[]> }} literals Tagged template literals.
+ * @param {TemplateStringsArray} literals Tagged template literals.
  * @param {...any} expressions Expressions to interpolate.
- * @yields {string} The HTML strings.
+ * @yields Processed HTML strings.
+ * @returns {Generator<string, void, void>} The HTML generator.
  */
-const htmlGenerator = function* ({ raw: literals }, ...expressions) {
+export const htmlGenerator = function* ({ raw: literals }, ...expressions) {
   for (let i = 0; i !== expressions.length; ++i) {
     let expression = expressions[i];
     let literal = literals[i];
@@ -119,11 +118,11 @@ const htmlGenerator = function* ({ raw: literals }, ...expressions) {
                   string = `${expression}`;
                 }
 
-                if (string) {
-                  if (!isRaw && escapeRegExp.test(string)) {
-                    string = escapeFunction(string);
-                  }
+                if (!isRaw) {
+                  string = escapeFunction(string);
+                }
 
+                if (string) {
                   yield string;
                 }
               }
@@ -134,11 +133,11 @@ const htmlGenerator = function* ({ raw: literals }, ...expressions) {
             string = `${expression}`;
           }
 
-          if (string) {
-            if (!isRaw && escapeRegExp.test(string)) {
-              string = escapeFunction(string);
-            }
+          if (!isRaw) {
+            string = escapeFunction(string);
+          }
 
+          if (string) {
             yield string;
           }
         }
@@ -151,7 +150,7 @@ const htmlGenerator = function* ({ raw: literals }, ...expressions) {
 
     if (literal && literal.charCodeAt(literal.length - 1) === 33) {
       literal = literal.slice(0, -1);
-    } else if (string && escapeRegExp.test(string)) {
+    } else {
       string = escapeFunction(string);
     }
 
@@ -166,11 +165,15 @@ const htmlGenerator = function* ({ raw: literals }, ...expressions) {
 };
 
 /**
- * @param {{ raw: Readonly<string[]> }} literals Tagged template literals.
+ * @param {TemplateStringsArray} literals Tagged template literals.
  * @param {...any} expressions Expressions to interpolate.
- * @yields {string} The HTML strings.
+ * @yields Processed HTML strings.
+ * @returns {AsyncGenerator<string, void, void>} The HTML generator.
  */
-const htmlAsyncGenerator = async function* ({ raw: literals }, ...expressions) {
+export const htmlAsyncGenerator = async function* (
+  { raw: literals },
+  ...expressions
+) {
   for (let i = 0; i !== expressions.length; ++i) {
     let expression = await expressions[i];
     let literal = literals[i];
@@ -216,11 +219,11 @@ const htmlAsyncGenerator = async function* ({ raw: literals }, ...expressions) {
                   string = `${expression}`;
                 }
 
-                if (string) {
-                  if (!isRaw && escapeRegExp.test(string)) {
-                    string = escapeFunction(string);
-                  }
+                if (!isRaw) {
+                  string = escapeFunction(string);
+                }
 
+                if (string) {
                   yield string;
                 }
               }
@@ -231,11 +234,11 @@ const htmlAsyncGenerator = async function* ({ raw: literals }, ...expressions) {
             string = `${expression}`;
           }
 
-          if (string) {
-            if (!isRaw && escapeRegExp.test(string)) {
-              string = escapeFunction(string);
-            }
+          if (!isRaw) {
+            string = escapeFunction(string);
+          }
 
+          if (string) {
             yield string;
           }
         }
@@ -248,7 +251,7 @@ const htmlAsyncGenerator = async function* ({ raw: literals }, ...expressions) {
 
     if (literal && literal.charCodeAt(literal.length - 1) === 33) {
       literal = literal.slice(0, -1);
-    } else if (string && escapeRegExp.test(string)) {
+    } else {
       string = escapeFunction(string);
     }
 
@@ -261,5 +264,3 @@ const htmlAsyncGenerator = async function* ({ raw: literals }, ...expressions) {
     yield literals[expressions.length];
   }
 };
-
-export { html, htmlGenerator, htmlAsyncGenerator };

package/src/includeFile.d.ts

@@ -1,5 +1 @@
-/**
- * @param {string} path The path to the file to render.
- * @returns {string} The cached content of the file.
- */
 export function includeFile(path: string): string;

package/src/includeFile.js

@@ -4,9 +4,9 @@ const cache = new Map();
 
 /**
  * @param {string} path The path to the file to render.
- * @returns {string} The cached content of the file.
+ * @returns {string} The content of the file.
  */
-const includeFile = (path) => {
+export const includeFile = (path) => {
   let file = cache.get(path);
 
   if (file === undefined) {
@@ -16,5 +16,3 @@ const includeFile = (path) => {
 
   return file;
 };
-
-export { includeFile };