ghtml 3.0.13 → 3.1.1

package/bench/index.js

@@ -1,10 +1,12 @@
-/* eslint-disable no-unused-vars */
-import { html } from "ghtml";
-import { Bench } from "tinybench";
-import { writeFileSync } from "node:fs";
-import { Buffer } from "node:buffer";
+"use strict";
+
+const { html } = require("..");
+const { Bench } = require("tinybench");
+const { writeFileSync } = require("node:fs");
 
 const bench = new Bench({ time: 500 });
+
+// eslint-disable-next-line no-unused-vars
 let result = "";
 
 bench.add("simple HTML formatting", () => {
@@ -27,18 +29,14 @@ bench.add("multiple string expressions", () => {
 const items1 = ["Item 1", undefined, "Item 2", null, 2000, 1500.5];
 bench.add("array expressions", () => {
   result = html`<ul>
-    ${items1.map((item) => {
-      return html`<li>${item}</li>`;
-    })}
+    ${items1.map((item) => html`<li>${item}</li>`)}
   </ul>`;
 });
 
 const items2 = ["Item 1", "Item <1.5>", "Item 2", "Item <2.5>", "Item 3"];
 bench.add("array expressions with escapable chars", () => {
   result = html`<ul>
-    ${items2.map((item) => {
-      return html`<li>"${item}" & '${item}'</li>`;
-    })}
+    ${items2.map((item) => html`<li>"${item}" & '${item}'</li>`)}
   </ul>`;
 });
 
@@ -57,9 +55,7 @@ bench.add("multiple types of expressions", () => {
     <div>Id: <span>${user.id}</span></div>
     ${null}${123}${456n}
     <ul>
-      !${items2.map((item) => {
-        return html`<li>${item}</li>`;
-      })}
+      !${items2.map((item) => html`<li>${item}</li>`)}
     </ul>
   `;
 });
@@ -108,13 +104,15 @@ bench.add("sparse escape", () => {
   result = html`<p>${`${"noescape".repeat(250)}<>`.repeat(5)}</p>`;
 });
 
-await bench.warmup();
-await bench.run();
+(async () => {
+  await bench.warmup();
+  await bench.run();
 
-const table = bench.table();
-globalThis.console.table(table);
+  const table = bench.table();
+  globalThis.console.table(table);
 
-writeFileSync(
-  "bench/results.json",
-  Buffer.from(JSON.stringify(table), "utf8").toString("base64"),
-);
+  writeFileSync(
+    "bench/results.json",
+    Buffer.from(JSON.stringify(table), "utf8").toString("base64"),
+  );
+})();

package/bin/src/index.js

@@ -1,6 +1,8 @@
 #!/usr/bin/env node
-import { generateHashesAndReplace } from "./utils.js";
-import process from "node:process";
+
+"use strict";
+
+const { generateHashesAndReplace } = require("./utils.js");
 
 const parseArguments = (args) => {
   let roots = null;

package/bin/src/utils.js

@@ -1,7 +1,9 @@
-import { Glob } from "glob";
-import { createHash } from "node:crypto";
-import { readFile, writeFile } from "node:fs/promises";
-import { win32, posix } from "node:path";
+"use strict";
+
+const { Glob } = require("glob");
+const { createHash } = require("node:crypto");
+const { readFile, writeFile } = require("node:fs/promises");
+const { win32, posix } = require("node:path");
 
 const generateFileHash = async (filePath) => {
   try {
@@ -77,7 +79,7 @@ const updateFilePathsWithHashes = async (
   }
 };
 
-export const generateHashesAndReplace = async ({
+const generateHashesAndReplace = async ({
   roots,
   refs,
   prefix,
@@ -130,3 +132,5 @@ export const generateHashesAndReplace = async ({
     skipPatterns,
   );
 };
+
+module.exports.generateHashesAndReplace = generateHashesAndReplace;

package/{eslint.config.js → eslint.config.mjs}

@@ -1,7 +1,15 @@
 import grules from "grules";
+import globals from "globals";
 
 export default [
   ...grules,
+  {
+    languageOptions: {
+      globals: {
+        ...globals.node,
+      },
+    },
+  },
   {
     rules: {
       "no-await-in-loop": "off",

package/package.json

@@ -3,8 +3,8 @@
   "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.13",
-  "type": "module",
+  "version": "3.1.1",
+  "type": "commonjs",
   "bin": "./bin/src/index.js",
   "main": "./src/index.js",
   "exports": {
@@ -25,11 +25,12 @@
     "glob": "^10.4.5"
   },
   "devDependencies": {
-    "@fastify/pre-commit": "^2.1.0",
+    "@fastify/pre-commit": "^2.2.0",
     "c8": "^10.1.2",
-    "grules": "^0.25.10",
-    "tinybench": "^2.9.0",
-    "typescript": ">=5.6.2"
+    "globals": "^15.13.0",
+    "grules": "^0.26.1",
+    "tinybench": "^3.0.7",
+    "typescript": ">=5.7.2"
   },
   "repository": {
     "type": "git",

package/src/includeFile.d.ts

@@ -1 +1,5 @@
+/**
+ * @param {string} path path
+ * @returns {string} string
+ */
 export function includeFile(path: string): string;

package/src/includeFile.js

@@ -1,4 +1,6 @@
-import { readFileSync } from "node:fs";
+"use strict";
+
+const { readFileSync } = require("node:fs");
 
 const cache = new Map();
 
@@ -6,7 +8,7 @@ const cache = new Map();
  * @param {string} path path
  * @returns {string} string
  */
-export const includeFile = (path) => {
+const includeFile = (path) => {
   let file = cache.get(path);
 
   if (file === undefined) {
@@ -16,3 +18,5 @@ export const includeFile = (path) => {
 
   return file;
 };
+
+module.exports.includeFile = includeFile;

package/src/index.d.ts

@@ -1,3 +1,20 @@
+/**
+ * @param {TemplateStringsArray} literals literals
+ * @param {...any} expressions expressions
+ * @returns {string} string
+ */
 export function html(literals: TemplateStringsArray, ...expressions: any[]): string;
+/**
+ * @param {TemplateStringsArray} literals literals
+ * @param {...any} expressions expressions
+ * @yields {string} string
+ * @returns {Generator<string, void, void>} Generator<string, void, void>
+ */
 export function htmlGenerator(literals: TemplateStringsArray, ...expressions: any[]): Generator<string, void, void>;
+/**
+ * @param {TemplateStringsArray} literals literals
+ * @param {...any} expressions expressions
+ * @yields {string} string
+ * @returns {AsyncGenerator<string, void, void>} AsyncGenerator<string, void, void>
+ */
 export function htmlAsyncGenerator(literals: TemplateStringsArray, ...expressions: any[]): AsyncGenerator<string, void, void>;

package/src/index.js

@@ -1,7 +1,4 @@
-const _isArray = Array.isArray;
-
-const _iterator = Symbol.iterator;
-const _asyncIterator = Symbol.asyncIterator;
+"use strict";
 
 const escapeRegExp = /["&'<=>]/g;
 
@@ -56,12 +53,13 @@ const escapeFunction = (string) => {
  * @param {...any} expressions expressions
  * @returns {string} string
  */
-export const html = (literals, ...expressions) => {
+const html = (literals, ...expressions) => {
   let accumulator = "";
+  let i = 0;
 
-  for (let i = 0; i !== expressions.length; ++i) {
+  for (; i !== expressions.length; ++i) {
     let literal = literals.raw[i];
-    let string = _isArray(expressions[i])
+    let string = Array.isArray(expressions[i])
       ? expressions[i].join("")
       : `${expressions[i] ?? ""}`;
 
@@ -83,7 +81,7 @@ export const html = (literals, ...expressions) => {
  * @yields {string} string
  * @returns {Generator<string, void, void>} Generator<string, void, void>
  */
-export const htmlGenerator = function* (literals, ...expressions) {
+const htmlGenerator = function* (literals, ...expressions) {
   for (let i = 0; i !== expressions.length; ++i) {
     let expression = expressions[i];
     let literal = literals.raw[i];
@@ -94,7 +92,7 @@ export const htmlGenerator = function* (literals, ...expressions) {
     } else if (expression === undefined || expression === null) {
       string = "";
     } else {
-      if (typeof expression[_iterator] === "function") {
+      if (typeof expression[Symbol.iterator] === "function") {
         const isRaw =
           literal.length !== 0 && literal.charCodeAt(literal.length - 1) === 33;
 
@@ -114,7 +112,7 @@ export const htmlGenerator = function* (literals, ...expressions) {
               continue;
             }
 
-            if (typeof expression[_iterator] === "function") {
+            if (typeof expression[Symbol.iterator] === "function") {
               for (expression of expression) {
                 if (expression === undefined || expression === null) {
                   continue;
@@ -174,7 +172,7 @@ export const htmlGenerator = function* (literals, ...expressions) {
  * @yields {string} string
  * @returns {AsyncGenerator<string, void, void>} AsyncGenerator<string, void, void>
  */
-export const htmlAsyncGenerator = async function* (literals, ...expressions) {
+const htmlAsyncGenerator = async function* (literals, ...expressions) {
   for (let i = 0; i !== expressions.length; ++i) {
     let expression = await expressions[i];
     let literal = literals.raw[i];
@@ -186,8 +184,8 @@ export const htmlAsyncGenerator = async function* (literals, ...expressions) {
       string = "";
     } else {
       if (
-        typeof expression[_iterator] === "function" ||
-        typeof expression[_asyncIterator] === "function"
+        typeof expression[Symbol.iterator] === "function" ||
+        typeof expression[Symbol.asyncIterator] === "function"
       ) {
         const isRaw =
           literal.length !== 0 && literal.charCodeAt(literal.length - 1) === 33;
@@ -209,8 +207,8 @@ export const htmlAsyncGenerator = async function* (literals, ...expressions) {
             }
 
             if (
-              typeof expression[_iterator] === "function" ||
-              typeof expression[_asyncIterator] === "function"
+              typeof expression[Symbol.iterator] === "function" ||
+              typeof expression[Symbol.asyncIterator] === "function"
             ) {
               for await (expression of expression) {
                 if (expression === undefined || expression === null) {
@@ -264,3 +262,7 @@ export const htmlAsyncGenerator = async function* (literals, ...expressions) {
     yield literals.raw[expressions.length];
   }
 };
+
+module.exports.html = html;
+module.exports.htmlGenerator = htmlGenerator;
+module.exports.htmlAsyncGenerator = htmlAsyncGenerator;

package/test/index.js

@@ -1,8 +1,10 @@
-import { html, htmlGenerator, htmlAsyncGenerator } from "../src/index.js";
-import { readFile } from "node:fs/promises";
-import { readFileSync } from "node:fs";
-import test from "node:test";
-import assert from "node:assert";
+"use strict";
+
+const { html, htmlGenerator, htmlAsyncGenerator } = require("..");
+const { readFile } = require("node:fs/promises");
+const { readFileSync } = require("node:fs");
+const test = require("node:test");
+const assert = require("node:assert/strict");
 
 const conditionTrue = true;
 const conditionFalse = false;
@@ -137,9 +139,7 @@ test("renders multiple html calls", () => {
 
 test("renders multiple html calls with different expression types", () => {
   const obj = {};
-  obj.toString = () => {
-    return "description of the object";
-  };
+  obj.toString = () => "description of the object";
 
   // prettier-ignore
   assert.strictEqual(
@@ -149,7 +149,7 @@ test("renders multiple html calls with different expression types", () => {
         !${conditionFalse
           ? ""
           :
-            html`<em> ${array1.map((i) => {return i + 1;})} </em>`}<br />
+            html`<em> ${array1.map((i) => i + 1)} </em>`}<br />
         And also, ${false} ${null}${undefined}${obj} is ${true}
       </p>
     `,
@@ -192,9 +192,7 @@ test("htmlGenerator renders unsafe content", () => {
 });
 
 test("htmlGenerator works with nested htmlGenerator calls in an array", () => {
-  const generator = htmlGenerator`<ul>!${[1, 2, 3].map((index) => {
-    return htmlGenerator`<li>${index}</li>`;
-  })}</ul>`;
+  const generator = htmlGenerator`<ul>!${[1, 2, 3].map((index) => htmlGenerator`<li>${index}</li>`)}</ul>`;
   let accumulator = "";
 
   for (const value of generator) {
@@ -345,9 +343,7 @@ test("htmlAsyncGenerator works with other generators (escaped)", async () => {
 });
 
 test("htmlAsyncGenerator works with nested htmlAsyncGenerator calls in an array", async () => {
-  const generator = htmlAsyncGenerator`!${[1, 2, 3].map((i) => {
-    return htmlAsyncGenerator`${i}: <p>${readFile("test/test.md", "utf8")}</p>`;
-  })}`;
+  const generator = htmlAsyncGenerator`!${[1, 2, 3].map((i) => htmlAsyncGenerator`${i}: <p>${readFile("test/test.md", "utf8")}</p>`)}`;
   let accumulator = "";
 
   for await (const value of generator) {
@@ -361,9 +357,7 @@ test("htmlAsyncGenerator works with nested htmlAsyncGenerator calls in an array"
 });
 
 test("htmlAsyncGenerator renders chunks with promises (escaped)", async () => {
-  const generator = htmlAsyncGenerator`<ul>!${[1, 2].map((i) => {
-    return htmlAsyncGenerator`${i}: ${readFile("test/test.md", "utf8")}`;
-  })}</ul>`;
+  const generator = htmlAsyncGenerator`<ul>!${[1, 2].map((i) => htmlAsyncGenerator`${i}: ${readFile("test/test.md", "utf8")}`)}</ul>`;
   const fileContent = readFileSync("test/test.md", "utf8").replaceAll(
     ">",
     "&#62;",
@@ -392,9 +386,7 @@ test("htmlAsyncGenerator renders chunks with promises (escaped)", async () => {
 });
 
 test("htmlAsyncGenerator renders chunks with promises (raw)", async () => {
-  const generator = htmlAsyncGenerator`<ul>!${[1, 2].map((i) => {
-    return htmlAsyncGenerator`${i}: !${readFile("test/test.md", "utf8")}`;
-  })}</ul>`;
+  const generator = htmlAsyncGenerator`<ul>!${[1, 2].map((i) => htmlAsyncGenerator`${i}: !${readFile("test/test.md", "utf8")}`)}</ul>`;
   const fileContent = readFileSync("test/test.md", "utf8");
 
   let value = await generator.next();