ghtml 3.0.6 → 3.0.8

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2024 Gürgün Dayıoğlu
+Copyright (c) 2023 Gürgün Dayıoğlu
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/bench/index.js

@@ -1,10 +1,12 @@
 /* eslint-disable no-unused-vars */
+
 import { html } from "../src/index.js";
 import { Bench } from "tinybench";
 import { writeFileSync } from "node:fs";
 import { Buffer } from "node:buffer";
 
 let result = "";
+
 const bench = new Bench({ time: 500 });
 
 bench.add("simple HTML formatting", () => {
@@ -112,7 +114,7 @@ await bench.warmup();
 await bench.run();
 
 const table = bench.table();
-console.table(table);
+globalThis.console.table(table);
 
 writeFileSync(
   "bench/results.json",

package/bin/example/assets/script.js

@@ -1 +1 @@
-console.warn("Hello World!");
+globalThis.console.warn("Hello World!");

package/bin/example/package.json

@@ -6,8 +6,8 @@
     "build": "ghtml --roots=assets/ --refs=routes/ --prefix=/p/assets/"
   },
   "dependencies": {
-    "@fastify/static": "^7.0.1",
-    "fastify": "^4.26.1",
+    "@fastify/static": "^8.0.1",
+    "fastify": "^5.0.0",
     "ghtml": "file:../../"
   }
 }

package/bin/example/routes/index.js

@@ -1,3 +1,5 @@
+/* eslint-disable n/no-missing-import, require-await */
+
 import { html } from "ghtml";
 
 export default async (fastify) => {

package/bin/example/server.js

@@ -1,10 +1,12 @@
+/* eslint-disable n/no-missing-import */
+
 import Fastify from "fastify";
 
 const fastify = Fastify();
 
 // Plugins
 await fastify.register(import("@fastify/static"), {
-  root: new URL("assets/", import.meta.url).pathname,
+  root: new globalThis.URL("assets/", import.meta.url).pathname,
   prefix: "/p/assets/",
   wildcard: false,
   index: false,
@@ -20,5 +22,5 @@ fastify.listen({ port: 5050 }, (err, address) => {
     throw err;
   }
 
-  console.warn(`Server listening at ${address}`);
+  globalThis.console.warn(`Server listening at ${address}`);
 });

package/bin/src/index.js

@@ -18,7 +18,7 @@ const parseArguments = (args) => {
   }
 
   if (!roots || !refs) {
-    console.error(
+    globalThis.console.error(
       'Usage: npx ghtml --roots="base/path/to/scan/assets/1/,base/path/to/scan/assets/2/" --refs="views/path/to/append/hashes/1/,views/path/to/append/hashes/2/" [--prefix="/optional/prefix/"]',
     );
     process.exit(1);
@@ -31,10 +31,10 @@ const main = async () => {
   const { roots, refs, prefix } = parseArguments(process.argv.slice(2));
 
   try {
-    console.warn(`Generating hashes and updating file paths...`);
-    console.warn(`Scanning files in: ${roots}`);
-    console.warn(`Updating files in: ${refs}`);
-    console.warn(`Using prefix: ${prefix}`);
+    globalThis.console.warn(`Generating hashes and updating file paths...`);
+    globalThis.console.warn(`Scanning files in: ${roots}`);
+    globalThis.console.warn(`Updating files in: ${refs}`);
+    globalThis.console.warn(`Using prefix: ${prefix}`);
 
     await generateHashesAndReplace({
       roots,
@@ -42,9 +42,11 @@ const main = async () => {
       prefix,
     });
 
-    console.warn("Hash generation and file updates completed successfully.");
+    globalThis.console.warn(
+      "Hash generation and file updates completed successfully.",
+    );
   } catch (error) {
-    console.error(`Error occurred: ${error.message}`);
+    globalThis.console.error(`Error occurred: ${error.message}`);
     process.exit(1);
   }
 };

package/bin/src/utils.js

@@ -1,3 +1,5 @@
+/* eslint-disable no-await-in-loop */
+
 import { Glob } from "glob";
 import { createHash } from "node:crypto";
 import { readFile, writeFile } from "node:fs/promises";
@@ -44,12 +46,12 @@ const updateFilePathsWithHashes = async (
       for (const [path, hash] of fileHashes) {
         const fullPath = prefix + path;
         const escapedPath = fullPath.replace(
-          /[$()*+.?[\\\]^{|}]/g,
+          /[$()*+.?[\\\]^{|}]/gu,
           String.raw`\$&`,
         );
         const regex = new RegExp(
           `(?<path>${escapedPath})(\\?(?<queryString>[^#"'\`]*))?`,
-          "g",
+          "gu",
         );
 
         content = content.replace(
@@ -74,7 +76,7 @@ const updateFilePathsWithHashes = async (
   }
 };
 
-const generateHashesAndReplace = async ({
+export const generateHashesAndReplace = async ({
   roots,
   refs,
   prefix,
@@ -124,5 +126,3 @@ const generateHashesAndReplace = async ({
     skipPatterns,
   );
 };
-
-export { generateHashesAndReplace };

package/eslint.config.js

@@ -0,0 +1,3 @@
+import grules from "grules";
+
+export default [...grules];

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.6",
+  "version": "3.0.8",
   "type": "module",
   "bin": "./bin/src/index.js",
   "main": "./src/index.js",
@@ -27,9 +27,9 @@
   "devDependencies": {
     "@fastify/pre-commit": "^2.1.0",
     "c8": "^10.1.2",
-    "grules": "^0.23.3",
+    "grules": "^0.25.0",
     "tinybench": "^2.9.0",
-    "typescript": ">=5.5.4"
+    "typescript": ">=5.6.2"
   },
   "repository": {
     "type": "git",

package/src/html.d.ts

@@ -1,3 +1,3 @@
-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>;
+export function html(literals: TemplateStringsArray, ...expressions: any[]): string;
+export function htmlGenerator(literals: TemplateStringsArray, ...expressions: any[]): Generator<string, void, void>;
+export function htmlAsyncGenerator(literals: TemplateStringsArray, ...expressions: any[]): AsyncGenerator<string, void, void>;

package/src/html.js

@@ -1,14 +1,12 @@
+/* eslint-disable no-await-in-loop, require-unicode-regexp */
+
 const escapeRegExp = /["&'<=>]/g;
 
 const escapeFunction = (string) => {
-  if (!string || !escapeRegExp.test(string)) {
-    return string;
-  }
-
   let escaped = "";
   let start = 0;
 
-  do {
+  while (escapeRegExp.test(string)) {
     const i = escapeRegExp.lastIndex - 1;
 
     switch (string.charCodeAt(i)) {
@@ -33,62 +31,57 @@ const escapeFunction = (string) => {
     }
 
     start = escapeRegExp.lastIndex;
-  } while (escapeRegExp.test(string));
+  }
 
   return escaped + string.slice(start);
 };
 
 /**
- * @param {TemplateStringsArray} literals Tagged template literals.
- * @param {...any} expressions Expressions to interpolate.
- * @returns {string} The processed HTML string.
+ * @param {TemplateStringsArray} literals literals
+ * @param {...any} expressions expressions
+ * @returns {string} string
  */
-export const html = ({ raw: literals }, ...expressions) => {
+export const html = (literals, ...expressions) => {
   let accumulator = "";
 
   for (let i = 0; i !== expressions.length; ++i) {
-    let literal = literals[i];
-    let string =
-      typeof expressions[i] === "string"
-        ? expressions[i]
-        : expressions[i] == null
-          ? ""
-          : Array.isArray(expressions[i])
-            ? expressions[i].join("")
-            : `${expressions[i]}`;
+    let literal = literals.raw[i];
+    let string = Array.isArray(expressions[i])
+      ? expressions[i].join("")
+      : String(expressions[i] ?? "");
 
     if (literal && literal.charCodeAt(literal.length - 1) === 33) {
       literal = literal.slice(0, -1);
     } else {
-      string = escapeFunction(string);
+      string &&= escapeFunction(string);
     }
 
     accumulator += literal + string;
   }
 
-  return accumulator + literals[expressions.length];
+  return accumulator + literals.raw[expressions.length];
 };
 
 /**
- * @param {TemplateStringsArray} literals Tagged template literals.
- * @param {...any} expressions Expressions to interpolate.
- * @yields Processed HTML strings.
- * @returns {Generator<string, void, void>} The HTML generator.
+ * @param {TemplateStringsArray} literals literals
+ * @param {...any} expressions expressions
+ * @yields {string} string
+ * @returns {Generator<string, void, void>} Generator<string, void, void>
  */
-export const htmlGenerator = function* ({ raw: literals }, ...expressions) {
+export const htmlGenerator = function* (literals, ...expressions) {
   for (let i = 0; i !== expressions.length; ++i) {
     let expression = expressions[i];
-    let literal = literals[i];
+    let literal = literals.raw[i];
     let string;
 
     if (typeof expression === "string") {
       string = expression;
-    } else if (expression == null) {
+    } else if (expression === undefined || expression === null) {
       string = "";
     } else {
       if (expression[Symbol.iterator]) {
         const isRaw =
-          literal !== "" && literal.charCodeAt(literal.length - 1) === 33;
+          Boolean(literal) && literal.charCodeAt(literal.length - 1) === 33;
 
         if (isRaw) {
           literal = literal.slice(0, -1);
@@ -102,27 +95,23 @@ export const htmlGenerator = function* ({ raw: literals }, ...expressions) {
           if (typeof expression === "string") {
             string = expression;
           } else {
-            if (expression == null) {
+            if (expression === undefined || expression === null) {
               continue;
             }
 
             if (expression[Symbol.iterator]) {
               for (expression of expression) {
-                if (typeof expression === "string") {
-                  string = expression;
-                } else {
-                  if (expression == null) {
-                    continue;
-                  }
-
-                  string = `${expression}`;
+                if (expression === undefined || expression === null) {
+                  continue;
                 }
 
-                if (!isRaw) {
-                  string = escapeFunction(string);
-                }
+                string = String(expression);
 
                 if (string) {
+                  if (!isRaw) {
+                    string = escapeFunction(string);
+                  }
+
                   yield string;
                 }
               }
@@ -130,14 +119,14 @@ export const htmlGenerator = function* ({ raw: literals }, ...expressions) {
               continue;
             }
 
-            string = `${expression}`;
-          }
-
-          if (!isRaw) {
-            string = escapeFunction(string);
+            string = String(expression);
           }
 
           if (string) {
+            if (!isRaw) {
+              string = escapeFunction(string);
+            }
+
             yield string;
           }
         }
@@ -145,13 +134,13 @@ export const htmlGenerator = function* ({ raw: literals }, ...expressions) {
         continue;
       }
 
-      string = `${expression}`;
+      string = String(expression);
     }
 
     if (literal && literal.charCodeAt(literal.length - 1) === 33) {
       literal = literal.slice(0, -1);
     } else {
-      string = escapeFunction(string);
+      string &&= escapeFunction(string);
     }
 
     if (literal || string) {
@@ -159,34 +148,31 @@ export const htmlGenerator = function* ({ raw: literals }, ...expressions) {
     }
   }
 
-  if (literals[expressions.length]) {
-    yield literals[expressions.length];
+  if (literals.raw[expressions.length]) {
+    yield literals.raw[expressions.length];
   }
 };
 
 /**
- * @param {TemplateStringsArray} literals Tagged template literals.
- * @param {...any} expressions Expressions to interpolate.
- * @yields Processed HTML strings.
- * @returns {AsyncGenerator<string, void, void>} The HTML generator.
+ * @param {TemplateStringsArray} literals literals
+ * @param {...any} expressions expressions
+ * @yields {string} string
+ * @returns {AsyncGenerator<string, void, void>} AsyncGenerator<string, void, void>
  */
-export const htmlAsyncGenerator = async function* (
-  { raw: literals },
-  ...expressions
-) {
+export const htmlAsyncGenerator = async function* (literals, ...expressions) {
   for (let i = 0; i !== expressions.length; ++i) {
     let expression = await expressions[i];
-    let literal = literals[i];
+    let literal = literals.raw[i];
     let string;
 
     if (typeof expression === "string") {
       string = expression;
-    } else if (expression == null) {
+    } else if (expression === undefined || expression === null) {
       string = "";
     } else {
       if (expression[Symbol.iterator] || expression[Symbol.asyncIterator]) {
         const isRaw =
-          literal !== "" && literal.charCodeAt(literal.length - 1) === 33;
+          Boolean(literal) && literal.charCodeAt(literal.length - 1) === 33;
 
         if (isRaw) {
           literal = literal.slice(0, -1);
@@ -200,7 +186,7 @@ export const htmlAsyncGenerator = async function* (
           if (typeof expression === "string") {
             string = expression;
           } else {
-            if (expression == null) {
+            if (expression === undefined || expression === null) {
               continue;
             }
 
@@ -209,21 +195,17 @@ export const htmlAsyncGenerator = async function* (
               expression[Symbol.asyncIterator]
             ) {
               for await (expression of expression) {
-                if (typeof expression === "string") {
-                  string = expression;
-                } else {
-                  if (expression == null) {
-                    continue;
-                  }
-
-                  string = `${expression}`;
+                if (expression === undefined || expression === null) {
+                  continue;
                 }
 
-                if (!isRaw) {
-                  string = escapeFunction(string);
-                }
+                string = String(expression);
 
                 if (string) {
+                  if (!isRaw) {
+                    string = escapeFunction(string);
+                  }
+
                   yield string;
                 }
               }
@@ -231,14 +213,14 @@ export const htmlAsyncGenerator = async function* (
               continue;
             }
 
-            string = `${expression}`;
-          }
-
-          if (!isRaw) {
-            string = escapeFunction(string);
+            string = String(expression);
           }
 
           if (string) {
+            if (!isRaw) {
+              string = escapeFunction(string);
+            }
+
             yield string;
           }
         }
@@ -246,13 +228,13 @@ export const htmlAsyncGenerator = async function* (
         continue;
       }
 
-      string = `${expression}`;
+      string = String(expression);
     }
 
     if (literal && literal.charCodeAt(literal.length - 1) === 33) {
       literal = literal.slice(0, -1);
     } else {
-      string = escapeFunction(string);
+      string &&= escapeFunction(string);
     }
 
     if (literal || string) {
@@ -260,7 +242,7 @@ export const htmlAsyncGenerator = async function* (
     }
   }
 
-  if (literals[expressions.length]) {
-    yield literals[expressions.length];
+  if (literals.raw[expressions.length]) {
+    yield literals.raw[expressions.length];
   }
 };

package/src/includeFile.js

@@ -3,8 +3,8 @@ import { readFileSync } from "node:fs";
 const cache = new Map();
 
 /**
- * @param {string} path The path to the file to render.
- * @returns {string} The content of the file.
+ * @param {string} path path
+ * @returns {string} string
  */
 export const includeFile = (path) => {
   let file = cache.get(path);

package/test/index.js

@@ -22,6 +22,11 @@ const generatorExample = function* () {
   yield "</p>";
 };
 
+const generatorExample2 = function* () {
+  yield ["", "<p>"];
+  yield "";
+};
+
 const generatorPromiseExample = function* () {
   yield [
     new Promise((resolve) => {
@@ -33,6 +38,17 @@ const generatorPromiseExample = function* () {
   yield;
 };
 
+const generatorPromiseExample2 = function* () {
+  yield [
+    new Promise((resolve) => {
+      resolve("<p>");
+    }),
+    null,
+    "",
+  ];
+  yield "";
+};
+
 test("renders empty input", () => {
   assert.strictEqual(html({ raw: [""] }), "");
 });
@@ -204,6 +220,18 @@ test("htmlGenerator works with other generators (raw)", () => {
   assert.strictEqual(generator.next().done, true);
 });
 
+test("htmlGenerator works with other generators (raw) /2", () => {
+  const generator = htmlGenerator`<div>!${generatorExample2()}</div>`;
+  let accumulator = "";
+
+  for (const value of generator) {
+    accumulator += value;
+  }
+
+  assert.strictEqual(accumulator, "<div><p></div>");
+  assert.strictEqual(generator.next().done, true);
+});
+
 test("htmlGenerator works with other generators (escaped)", () => {
   const generator = htmlGenerator`<div>${generatorExample()}</div>`;
   let accumulator = "";
@@ -291,6 +319,17 @@ test("htmlAsyncGenerator works with other generators (raw)", async () => {
   );
 });
 
+test("htmlAsyncGenerator works with other generators (raw) /2", async () => {
+  const generator = htmlAsyncGenerator`<div>!${generatorPromiseExample2()}</div>`;
+  let accumulator = "";
+
+  for await (const value of generator) {
+    accumulator += value;
+  }
+
+  assert.strictEqual(accumulator, "<div><p></div>");
+});
+
 test("htmlAsyncGenerator works with other generators (escaped)", async () => {
   const generator = htmlAsyncGenerator`<div>${generatorExample()}</div>`;
   let accumulator = "";

package/.eslintrc.json

@@ -1,8 +0,0 @@
-{
-  "root": true,
-  "extends": ["plugin:grules/all"],
-  "rules": {
-    "no-await-in-loop": "off",
-    "require-unicode-regexp": "off"
-  }
-}

package/bin/example/.eslintrc.json

@@ -1,6 +0,0 @@
-{
-  "rules": {
-    "require-await": "off",
-    "n/no-missing-import": "off"
-  }
-}