@kenjura/ursa 0.8.0 → 0.10.0

package/CHANGELOG.md

@@ -1,3 +1,15 @@
+# 0.10.0
+
+2024-03-13
+
+- Will no longer write an autoindex when index document already exists
+
+# 0.9.0
+
+2024-02-10
+
+- Removed spammy debug data from json
+
 # 0.8.0
 
 2023-12-31

package/package.json

@@ -2,7 +2,7 @@
   "name": "@kenjura/ursa",
   "author": "Andrew London <andrew@kenjura.com>",
   "type": "module",
-  "version": "0.8.0",
+  "version": "0.10.0",
   "description": "static site generator from MD/wikitext/YML",
   "main": "lib/index.js",
   "scripts": {

package/src/helper/fileExists.js

@@ -0,0 +1,13 @@
+import { open } from "node:fs/promises";
+
+export async function fileExists(path) {
+  let filehandle = null;
+  try {
+    filehandle = await open(path, "r+");
+    return true;
+  } catch (err) {
+    return false;
+  } finally {
+    filehandle?.close();
+  }
+}

package/src/index.js

@@ -2,7 +2,8 @@ import { generate } from "./jobs/generate.js";
 
 import { join, resolve } from "path";
 
-const source = process.env.SOURCE ?? join(process.cwd(), "source");
-const build = process.env.BUILD ?? join(process.cwd(), "build");
+const _source = process.env.SOURCE ?? join(process.cwd(), "source");
+const _meta = process.env.META ?? join(process.cwd(), "meta");
+const _output = process.env.OUTPUT ?? join(process.cwd(), "output");
 
-generate({ source, build });
+generate({ _source, _meta, _output });

package/src/jobs/generate.js

@@ -1,6 +1,6 @@
 import { recurse } from "../helper/recursive-readdir.js";
 
-import { copyFile, mkdir, readdir, readFile } from "fs/promises";
+import { copyFile, mkdir, readdir, readFile, stat } from "fs/promises";
 import { getAutomenu } from "../helper/automenu.js";
 import { filterAsync } from "../helper/filterAsync.js";
 import { isDirectory } from "../helper/isDirectory.js";
@@ -13,15 +13,21 @@ import { copy as copyDir, emptyDir, outputFile } from "fs-extra";
 import { basename, dirname, extname, join, parse, resolve } from "path";
 import { URL } from "url";
 import o2x from "object-to-xml";
+import { existsSync } from "fs";
+import { fileExists } from "../helper/fileExists.js";
 
 const DEFAULT_TEMPLATE_NAME =
   process.env.DEFAULT_TEMPLATE_NAME ?? "default-template";
 
 export async function generate({
-  source = join(process.cwd(), "."),
-  meta = join(process.cwd(), "meta"),
-  output = join(process.cwd(), "build"),
+  _source = join(process.cwd(), "."),
+  _meta = join(process.cwd(), "meta"),
+  _output = join(process.cwd(), "build"),
 } = {}) {
+  console.log({ _source, _meta, _output });
+  const source = resolve(_source) + "/";
+  const meta = resolve(_meta);
+  const output = resolve(_output) + "/";
   console.log({ source, meta, output });
 
   const allSourceFilenamesUnfiltered = await recurse(source, [() => false]);
@@ -29,10 +35,10 @@ export async function generate({
     ? (fileName) => fileName.match(process.env.INCLUDE_FILTER)
     : Boolean;
   const allSourceFilenames = allSourceFilenamesUnfiltered.filter(includeFilter);
-  console.log(allSourceFilenames);
+  // console.log(allSourceFilenames);
 
-  if (source.substr(-1) !== "/") source += "/"; // warning: might not work in windows
-  if (output.substr(-1) !== "/") output += "/";
+  // if (source.substr(-1) !== "/") source += "/"; // warning: might not work in windows
+  // if (output.substr(-1) !== "/") output += "/";
 
   const templates = await getTemplates(meta); // todo: error if no default template
   // console.log({ templates });
@@ -107,11 +113,11 @@ export async function generate({
       const jsonObject = {
         name: base,
         contents: rawBody,
-        bodyLessMeta: bodyLessMeta,
+        // bodyLessMeta: bodyLessMeta,
         bodyHtml: body,
         metadata: meta,
         transformedMetadata,
-        html: finalHtml,
+        // html: finalHtml,
       };
       jsonCache.set(file, jsonObject);
       const json = JSON.stringify(jsonObject);
@@ -151,22 +157,25 @@ export async function generate({
       await outputFile(outputFilename, json);
 
       // html
-      const template = templates["default-template"]; // TODO: figure out a way to specify template for a directory index
-      const indexHtml = `<ul>${pathsInThisDirectory
-        .map((path) => {
-          const partialPath = path
-            .replace(source, "")
-            .replace(parse(path).ext, ".html");
-          const name = basename(path, parse(path).ext);
-          return `<li><a href="${partialPath}">${name}</a></li>`;
-        })
-        .join("")}</ul>`;
-      const finalHtml = template
-        .replace("${menu}", menu)
-        .replace("${body}", indexHtml);
       const htmlOutputFilename = dir.replace(source, output) + ".html";
-      console.log(`writing directory index to ${htmlOutputFilename}`);
-      await outputFile(htmlOutputFilename, finalHtml);
+      const indexAlreadyExists = fileExists(htmlOutputFilename);
+      if (!indexAlreadyExists) {
+        const template = templates["default-template"]; // TODO: figure out a way to specify template for a directory index
+        const indexHtml = `<ul>${pathsInThisDirectory
+          .map((path) => {
+            const partialPath = path
+              .replace(source, "")
+              .replace(parse(path).ext, ".html");
+            const name = basename(path, parse(path).ext);
+            return `<li><a href="${partialPath}">${name}</a></li>`;
+          })
+          .join("")}</ul>`;
+        const finalHtml = template
+          .replace("${menu}", menu)
+          .replace("${body}", indexHtml);
+        console.log(`writing directory index to ${htmlOutputFilename}`);
+        await outputFile(htmlOutputFilename, finalHtml);
+      }
     })
   );
 
@@ -263,4 +272,4 @@ function addTrailingSlash(somePath) {
   if (somePath.length < 1) return somePath;
   if (somePath[somePath.length - 1] == "/") return somePath;
   return `${somePath}/`;
-}
+}