ghtml 3.1.3 → 4.0.1

package/package.json

@@ -3,9 +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.1.3",
+  "version": "4.0.1",
   "type": "commonjs",
-  "bin": "./bin/src/index.js",
   "main": "./src/index.js",
   "exports": {
     ".": "./src/index.js",
@@ -21,15 +20,12 @@
     "lint:fix": "eslint --fix . && prettier --write .",
     "typescript": "tsc src/*.js --allowJs --declaration --emitDeclarationOnly --skipLibCheck"
   },
-  "dependencies": {
-    "glob": "^10.4.5"
-  },
   "devDependencies": {
-    "@fastify/pre-commit": "^2.2.0",
-    "c8": "^10.1.2",
-    "globals": "^16.0.0",
-    "grules": "^0.26.1",
-    "tinybench": "^4.0.1",
+    "@fastify/pre-commit": "^2.2.1",
+    "c8": "^10.1.3",
+    "globals": "^16.5.0",
+    "grules": "^0.26.2",
+    "tinybench": "^6.0.0",
     "typescript": ">=5.7.2"
   },
   "repository": {

package/src/index.js

@@ -3,10 +3,14 @@
 const escapeRegExp = /["&'<=>]/g;
 
 const escapeFunction = (string) => {
+  if (!escapeRegExp.test(string)) {
+    return string;
+  }
+
   let escaped = "";
   let start = 0;
 
-  while (escapeRegExp.test(string)) {
+  do {
     const i = escapeRegExp.lastIndex - 1;
 
     switch (string.charCodeAt(i)) {
@@ -43,7 +47,7 @@ const escapeFunction = (string) => {
     }
 
     start = escapeRegExp.lastIndex;
-  }
+  } while (escapeRegExp.test(string));
 
   return escaped + string.slice(start);
 };
@@ -55,8 +59,9 @@ const escapeFunction = (string) => {
  */
 const html = (literals, ...expressions) => {
   let accumulator = "";
+  const expressionsLength = expressions.length;
 
-  for (let i = 0; i !== expressions.length; ++i) {
+  for (let i = 0; i < expressionsLength; ++i) {
     let literal = literals.raw[i];
     let string =
       typeof expressions[i] === "string"
@@ -76,7 +81,7 @@ const html = (literals, ...expressions) => {
     accumulator += literal + string;
   }
 
-  return accumulator + literals.raw[expressions.length];
+  return accumulator + literals.raw[expressionsLength];
 };
 
 /**
@@ -86,7 +91,9 @@ const html = (literals, ...expressions) => {
  * @returns {Generator<string, void, void>} Generator<string, void, void>
  */
 const htmlGenerator = function* (literals, ...expressions) {
-  for (let i = 0; i !== expressions.length; ++i) {
+  const expressionsLength = expressions.length;
+
+  for (let i = 0; i < expressionsLength; ++i) {
     let expression = expressions[i];
     let literal = literals.raw[i];
     let string;
@@ -165,8 +172,8 @@ const htmlGenerator = function* (literals, ...expressions) {
     }
   }
 
-  if (literals.raw[expressions.length].length) {
-    yield literals.raw[expressions.length];
+  if (literals.raw[expressionsLength].length) {
+    yield literals.raw[expressionsLength];
   }
 };
 
@@ -177,7 +184,9 @@ const htmlGenerator = function* (literals, ...expressions) {
  * @returns {AsyncGenerator<string, void, void>} AsyncGenerator<string, void, void>
  */
 const htmlAsyncGenerator = async function* (literals, ...expressions) {
-  for (let i = 0; i !== expressions.length; ++i) {
+  const expressionsLength = expressions.length;
+
+  for (let i = 0; i < expressionsLength; ++i) {
     let expression = await expressions[i];
     let literal = literals.raw[i];
     let string;
@@ -262,8 +271,8 @@ const htmlAsyncGenerator = async function* (literals, ...expressions) {
     }
   }
 
-  if (literals.raw[expressions.length].length) {
-    yield literals.raw[expressions.length];
+  if (literals.raw[expressionsLength].length) {
+    yield literals.raw[expressionsLength];
   }
 };
 

package/bin/README.md

@@ -1,66 +0,0 @@
-Append unique hashes to assets referenced in your views to aggressively cache them while guaranteeing that clients receive the most recent versions.
-
-## Usage
-
-Running the following command will scan asset files found in the `roots` path(s) and replace their references in the `refs` path(s) with hashed versions:
-
-```sh
-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/"
-```
-
-## Example (Fastify)
-
-Register `@fastify/static`:
-
-```js
-await fastify.register(import("@fastify/static"), {
-  root: new URL("assets/", import.meta.url).pathname,
-  prefix: "/p/assets/",
-  wildcard: false,
-  index: false,
-  immutable: true,
-  maxAge: process.env.NODE_ENV === "production" ? 31536000 * 1000 : 0,
-});
-```
-
-Add the `ghtml` command to the build script:
-
-```json
-"scripts": {
-  "build": "npx ghtml --roots=assets/ --refs=views/,routes/ --prefix=/p/assets/",
-},
-```
-
-Make sure to `npm run build` in `Dockerfile`:
-
-```dockerfile
-FROM node:latest
-
-WORKDIR /app
-
-COPY package*.json ./
-
-RUN npm ci --include=dev
-
-COPY . .
-
-RUN npm run build
-
-RUN npm prune --omit=dev
-
-CMD ["npm", "start"]
-```
-
-## Demo
-
-A full project that uses the `ghtml` executable can be found in the `example` folder:
-
-```sh
-cd example
-
-npm i
-
-npm run build
-
-node .
-```

package/bin/example/assets/script.js

@@ -1 +0,0 @@
-globalThis.console.log("Hello World!");

package/bin/example/assets/style.css

@@ -1,19 +0,0 @@
-body {
-  display: flex;
-  flex-direction: column;
-  align-items: center;
-  justify-content: center;
-  height: 100vh;
-  margin: 0;
-  padding: 0;
-}
-
-img {
-  max-width: 100%;
-  height: auto;
-}
-
-.caption {
-  text-align: center;
-  margin-top: 10px;
-}

package/bin/example/package.json

@@ -1,13 +0,0 @@
-{
-  "type": "module",
-  "main": "./server.js",
-  "scripts": {
-    "start": "node server.js",
-    "build": "ghtml --roots=assets/ --refs=routes/ --prefix=/p/assets/"
-  },
-  "dependencies": {
-    "@fastify/static": "^8.0.1",
-    "fastify": "^5.0.0",
-    "ghtml": "file:../../"
-  }
-}

package/bin/example/routes/index.js

@@ -1,32 +0,0 @@
-import { html } from "ghtml";
-
-export default async (fastify) => {
-  fastify.decorateReply("html", function (inner) {
-    this.type("text/html; charset=utf-8");
-
-    return html`<!doctype html>
-      <html lang="en">
-        <head>
-          <meta charset="UTF-8" />
-          <meta
-            name="viewport"
-            content="width=device-width, initial-scale=1.0"
-          />
-          <title>Document</title>
-          <link rel="stylesheet" href="/p/assets/style.css" />
-          <script src="/p/assets/script.js"></script>
-        </head>
-        <body>
-          !${inner}
-        </body>
-      </html>`;
-  });
-
-  fastify.get("/", async (request, reply) => {
-    return reply.html(html`
-      <h1 class="caption">Hello, world!</h1>
-      <p>This is a simple example of a Fastify server.</p>
-      <p>It uses <code>ghtml</code>.</p>
-    `);
-  });
-};

package/bin/example/server.js

@@ -1,21 +0,0 @@
-import Fastify from "fastify";
-
-const fastify = Fastify();
-
-// Plugins
-await fastify.register(import("@fastify/static"), {
-  root: new globalThis.URL("assets/", import.meta.url).pathname,
-  prefix: "/p/assets/",
-  wildcard: false,
-  index: false,
-  immutable: true,
-  maxAge: 31536000 * 1000,
-});
-
-// Routes
-fastify.register(import("./routes/index.js"));
-
-// Listen
-const address = await fastify.listen({ port: 5050 });
-
-globalThis.console.log(`Server listening at ${address}`);

package/bin/src/index.js

@@ -1,56 +0,0 @@
-#!/usr/bin/env node
-
-"use strict";
-
-const { generateHashesAndReplace } = require("./utils.js");
-
-const parseArguments = (args) => {
-  let roots = null;
-  let refs = null;
-  let prefix = "/";
-
-  for (const arg of args) {
-    if (arg.startsWith("--roots=")) {
-      roots = arg.split("=", 2)[1].split(",");
-    } else if (arg.startsWith("--refs=")) {
-      refs = arg.split("=", 2)[1].split(",");
-    } else if (arg.startsWith("--prefix=")) {
-      prefix = arg.split("=", 2)[1];
-    }
-  }
-
-  if (!roots || !refs) {
-    globalThis.console.log(
-      '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);
-  }
-
-  return { roots, refs, prefix };
-};
-
-const main = async () => {
-  const { roots, refs, prefix } = parseArguments(process.argv.slice(2));
-
-  try {
-    globalThis.console.log(`Generating hashes and updating file paths...`);
-    globalThis.console.log(`Scanning files in: ${roots}`);
-    globalThis.console.log(`Updating files in: ${refs}`);
-    globalThis.console.log(`Using prefix: ${prefix}`);
-
-    await generateHashesAndReplace({
-      roots,
-      refs,
-      prefix,
-    });
-
-    globalThis.console.log(
-      "Hash generation and file updates completed successfully.",
-    );
-  } catch (error) {
-    globalThis.console.log(`Error occurred: ${error.message}`);
-    process.exit(1);
-  }
-};
-
-main();

package/bin/src/utils.js

@@ -1,136 +0,0 @@
-"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 {
-    const fileBuffer = await readFile(filePath);
-
-    return createHash("md5").update(fileBuffer).digest("hex").slice(0, 16);
-  } catch (err) {
-    if (err.code !== "ENOENT") {
-      throw err;
-    }
-
-    return "";
-  }
-};
-
-const updateFilePathsWithHashes = async (
-  fileHashes,
-  refs,
-  prefix,
-  includeDotFiles,
-  skipPatterns,
-) => {
-  for (let ref of refs) {
-    ref = ref.replaceAll(win32.sep, posix.sep);
-
-    if (!ref.endsWith("/")) {
-      ref += "/";
-    }
-
-    const filesIterable = new Glob("**/**", {
-      nodir: true,
-      follow: true,
-      absolute: true,
-      cwd: ref,
-      dot: includeDotFiles,
-      ignore: skipPatterns,
-    });
-
-    for await (const filePath of filesIterable) {
-      let content = await readFile(filePath, "utf8");
-      let found = false;
-
-      for (const [path, hash] of fileHashes) {
-        const fullPath = prefix + path;
-        const escapedPath = fullPath.replace(
-          /[$()*+.?[\\\]^{|}]/gu,
-          String.raw`\$&`,
-        );
-        const regex = new RegExp(
-          `(?<path>${escapedPath})(\\?(?<queryString>[^#"'\`]*))?`,
-          "gu",
-        );
-
-        content = content.replace(
-          regex,
-          (match, p1, p2, p3, offset, string, groups) => {
-            found = true;
-            const { path, queryString } = groups;
-
-            return !queryString
-              ? `${path}?hash=${hash}`
-              : queryString.includes("hash=")
-                ? `${path}?${queryString.replace(/(?<hash>hash=)[\dA-Fa-f]*/u, `$1${hash}`)}`
-                : `${path}?hash=${hash}&${queryString}`;
-          },
-        );
-      }
-
-      if (found) {
-        await writeFile(filePath, content);
-      }
-    }
-  }
-};
-
-const generateHashesAndReplace = async ({
-  roots,
-  refs,
-  prefix,
-  includeDotFiles = false,
-  skipPatterns = ["**/node_modules/**"],
-}) => {
-  const fileHashes = new Map();
-
-  roots = Array.isArray(roots) ? roots : [roots];
-  refs = Array.isArray(refs) ? refs : [refs];
-
-  for (let root of roots) {
-    root = root.replaceAll(win32.sep, posix.sep);
-
-    if (!root.endsWith("/")) {
-      root += "/";
-    }
-
-    const queue = [];
-    const files = [];
-    const filesIterable = new Glob("**/**", {
-      nodir: true,
-      follow: true,
-      absolute: true,
-      cwd: root,
-      dot: includeDotFiles,
-      ignore: skipPatterns,
-    });
-
-    for await (let filePath of filesIterable) {
-      filePath = filePath.replaceAll(win32.sep, posix.sep);
-      queue.push(generateFileHash(filePath));
-      files.push(filePath);
-    }
-
-    const hashes = await Promise.all(queue);
-
-    for (let i = 0; i < files.length; ++i) {
-      const fileRelativePath = posix.relative(root, files[i]);
-
-      fileHashes.set(fileRelativePath, hashes[i]);
-    }
-  }
-
-  await updateFilePathsWithHashes(
-    fileHashes,
-    refs,
-    prefix,
-    includeDotFiles,
-    skipPatterns,
-  );
-};
-
-module.exports.generateHashesAndReplace = generateHashesAndReplace;