npm - ghtml - Versions diffs - 2.1.5 → 2.2.0 - Mend

ghtml 2.1.5 → 2.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (7) hide show

package/bin/README.md +3 -3
package/bin/example/package.json +2 -2
package/bin/example/routes/index.js +10 -6
package/bin/example/server.js +7 -5
package/bin/src/index.js +0 -0
package/bin/src/utils.js +45 -37
package/package.json +1 -1

package/bin/README.md CHANGED Viewed

@@ -1,11 +1,11 @@
-Append unique hashes to assets referenced in your views to aggressively cache them while guaranteeing that clients receive the most recent versions.
+This executable lets you 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 with hashed versions in the `refs` path(s):
+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="path/to/scan/assets/1/,path/to/scan/assets/2/" --refs="views/path/to/append/hashes/1/,views/path/to/append/hashes/2/"
+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/"
 ```
 ## Example (Fastify)

package/bin/example/package.json CHANGED Viewed

@@ -3,11 +3,11 @@
   "main": "./server.js",
   "scripts": {
     "start": "node server.js",
-    "build": "node ../src/index.js --roots=assets/ --refs=routes/"
+    "build": "ghtml --roots=assets/ --refs=routes/"
   },
   "dependencies": {
     "@fastify/static": "^7.0.1",
     "fastify": "^4.26.1",
-    "fastify-html": "^0.5.0"
+    "ghtml": "file:../../"
   }
 }

package/bin/example/routes/index.js CHANGED Viewed

@@ -1,7 +1,9 @@
+import { html } from "ghtml";
 export default async (fastify) => {
-  const { html } = fastify;
+  fastify.decorateReply("html", function (inner) {
+    this.type("text/html; charset=utf-8");
-  fastify.addLayout((inner) => {
     return html`<!doctype html>
       <html lang="en">
         <head>
@@ -12,17 +14,19 @@ export default async (fastify) => {
           />
           <title>Document</title>
           <link rel="stylesheet" href="/p/assets/style.css" />
+          <script src="/p/assets/script.js"></script>
         </head>
         <body>
           !${inner}
         </body>
-      </html>`;
+      </html> `;
   });
   fastify.get("/", async (request, reply) => {
-    return reply.html`
+    return reply.html(html`
       <h1 class="caption">Hello, world!</h1>
-      <script src="/p/assets/script.js"></script>
-    `;
+      <p>This is a simple example of a Fastify server.</p>
+      <p>It uses <code>ghtml</code>.</p>
+    `);
   });
 };

package/bin/example/server.js CHANGED Viewed

@@ -1,5 +1,3 @@
-/* eslint n/no-missing-import: "off" */
 import Fastify from "fastify";
 const fastify = Fastify();
@@ -13,10 +11,14 @@ await fastify.register(import("@fastify/static"), {
   immutable: true,
   maxAge: 31536000 * 1000,
 });
-await fastify.register(import("fastify-html"));
 // Routes
 fastify.register(import("./routes/index.js"));
-await fastify.listen({ port: 5050 });
-console.warn("Server listening at http://localhost:5050");
+fastify.listen({ port: 5050 }, (err, address) => {
+  if (err) {
+    throw err;
+  }
+  console.warn(`Server listening at ${address}`);
+});

package/bin/src/index.js CHANGED Viewed

File without changes

package/bin/src/utils.js CHANGED Viewed

@@ -22,7 +22,7 @@ const updateFilePathsWithHashes = async (
   skipPatterns,
 ) => {
   for (let ref of refs) {
-    ref = ref.split(win32.sep).join(posix.sep);
+    ref = ref.replaceAll(win32.sep, posix.sep);
     if (!ref.endsWith("/")) {
       ref += "/";
     }
@@ -36,37 +36,45 @@ const updateFilePathsWithHashes = async (
       ignore: skipPatterns,
     });
-    for await (const file of filesIterable) {
-      let content = await readFile(file, "utf8");
-      let found = false;
+    for await (const filePath of filesIterable) {
+      let content = await readFile(filePath, "utf8");
+      let hasChanges = false;
       for (const [originalPath, hash] of fileHashes) {
-        const escapedPath = originalPath.replace(
-          /[$()*+.?[\\\]^{|}]/gu,
-          "\\$&",
-        );
-        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}`;
-          },
-        );
+        const pathIndex = content.indexOf(originalPath);
+        if (pathIndex !== -1) {
+          hasChanges = true;
+          const beforePath = content.slice(0, pathIndex);
+          const afterPath = content.slice(pathIndex + originalPath.length);
+          const queryStart = afterPath.indexOf("?");
+          if (queryStart === -1) {
+            content = `${beforePath}${originalPath}?hash=${hash}${afterPath}`;
+            continue;
+          }
+          const queryEnd = afterPath.slice(queryStart).search(/[#"'`]/u);
+          const queryString =
+            queryEnd !== -1
+              ? afterPath.slice(queryStart + 1, queryEnd)
+              : afterPath.slice(queryStart + 1);
+          const hashRegex = /(?<=(?:^|&))hash=[^&]*/u;
+          if (hashRegex.test(queryString)) {
+            const newQueryString = queryString.replace(
+              hashRegex,
+              `hash=${hash}`,
+            );
+            content = `${beforePath}${originalPath}?${newQueryString}${afterPath.slice(queryStart + queryString.length + 1)}`;
+            continue;
+          }
+          content = `${beforePath}${originalPath}?hash=${hash}&${afterPath.slice(queryStart + 1)}`;
+        }
       }
-      if (found) {
-        await writeFile(file, content);
+      if (hasChanges) {
+        await writeFile(filePath, content);
       }
     }
   }
@@ -82,10 +90,10 @@ const generateHashesAndReplace = async ({
   roots = Array.isArray(roots) ? roots : [roots];
   refs = Array.isArray(refs) ? refs : [refs];
-  for (let rootPath of roots) {
-    rootPath = rootPath.split(win32.sep).join(posix.sep);
-    if (!rootPath.endsWith("/")) {
-      rootPath += "/";
+  for (let root of roots) {
+    root = root.replaceAll(win32.sep, posix.sep);
+    if (!root.endsWith("/")) {
+      root += "/";
     }
     const queue = [];
@@ -94,21 +102,21 @@ const generateHashesAndReplace = async ({
       nodir: true,
       follow: true,
       absolute: true,
-      cwd: rootPath,
+      cwd: root,
       dot: includeDotFiles,
       ignore: skipPatterns,
     });
     for await (let filePath of filesIterable) {
-      filePath = filePath.split(win32.sep).join(posix.sep);
+      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(rootPath, files[i]);
+    for (let i = 0; i < files.length; ++i) {
+      const fileRelativePath = posix.relative(root, files[i]);
       fileHashes.set(fileRelativePath, hashes[i]);
     }
   }
@@ -121,4 +129,4 @@ const generateHashesAndReplace = async ({
   );
 };
-export { generateFileHash, generateHashesAndReplace };
+export { generateHashesAndReplace };

package/package.json CHANGED Viewed

@@ -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": "2.1.5",
+  "version": "2.2.0",
   "type": "module",
   "bin": "./bin/src/index.js",
   "main": "./src/index.js",