@kenjura/ursa 0.52.0 → 0.54.0

package/src/helper/build/index.js

@@ -0,0 +1,13 @@
+// Barrel file for build helpers
+export * from './cacheBust.js';
+export * from './batch.js';
+export * from './progress.js';
+export * from './watchCache.js';
+export * from './titleCase.js';
+export * from './excludeFilter.js';
+export * from './pathUtils.js';
+export * from './templates.js';
+export * from './menu.js';
+export * from './metadata.js';
+export * from './footer.js';
+export * from './autoIndex.js';

package/src/helper/build/menu.js

@@ -0,0 +1,19 @@
+// Menu helpers for build
+import { getAutomenu } from "../automenu.js";
+import { renderFile } from "../fileRenderer.js";
+
+/**
+ * Get menu HTML and menu data from source directory
+ * @param {string[]} allSourceFilenames - All source file names
+ * @param {string} source - Source directory path
+ * @param {Set<string>} validPaths - Set of valid internal paths for link validation
+ * @returns {Promise<{html: string, menuData: Object}>} Menu HTML and menu data
+ */
+export async function getMenu(allSourceFilenames, source, validPaths) {
+  const menuResult = await getAutomenu(source, validPaths);
+  const menuBody = renderFile({ fileContents: menuResult.html, type: ".md" });
+  return {
+    html: menuBody,
+    menuData: menuResult.menuData
+  };
+}

package/src/helper/build/metadata.js

@@ -0,0 +1,30 @@
+// Metadata transformation helpers for build
+import { join } from "path";
+
+/**
+ * Get transformed metadata using custom or default transform function
+ * @param {string} dirname - Directory containing the file
+ * @param {Object} metadata - Raw metadata object
+ * @returns {Promise<string>} Transformed metadata string
+ */
+export async function getTransformedMetadata(dirname, metadata) {
+  // custom transform? else, use default
+  const customTransformFnFilename = join(dirname, "transformMetadata.js");
+  let transformFn = defaultTransformFn;
+  try {
+    const customTransformFn = (await import(customTransformFnFilename)).default;
+    if (typeof customTransformFn === "function")
+      transformFn = customTransformFn;
+  } catch (e) {
+    // No custom transform found, use default
+  }
+  try {
+    return transformFn(metadata);
+  } catch (e) {
+    return "error transforming metadata";
+  }
+
+  function defaultTransformFn(metadata) {
+    return "default transform";
+  }
+}

package/src/helper/build/pathUtils.js

@@ -0,0 +1,13 @@
+// Path utility helpers for build
+
+/**
+ * Add trailing slash to a path if not present
+ * @param {string} somePath - Path to modify
+ * @returns {string} Path with trailing slash
+ */
+export function addTrailingSlash(somePath) {
+  if (typeof somePath !== "string") return somePath;
+  if (somePath.length < 1) return somePath;
+  if (somePath[somePath.length - 1] === "/") return somePath;
+  return `${somePath}/`;
+}

package/src/helper/build/progress.js

@@ -0,0 +1,35 @@
+// Progress reporter for build
+
+export class ProgressReporter {
+  constructor() {
+    this.lines = {};
+    this.isTTY = process.stdout.isTTY;
+  }
+  status(name, message) {
+    if (this.isTTY) {
+      const line = `${name}: ${message}`;
+      this.lines[name] = line;
+      process.stdout.write(`\r\x1b[K${line}`);
+    }
+  }
+  done(name, message) {
+    if (this.isTTY) {
+      process.stdout.write(`\r\x1b[K${name}: ${message}\n`);
+    } else {
+      console.log(`${name}: ${message}`);
+    }
+    delete this.lines[name];
+  }
+  log(message) {
+    if (this.isTTY) {
+      process.stdout.write(`\r\x1b[K${message}\n`);
+    } else {
+      console.log(message);
+    }
+  }
+  clear() {
+    if (this.isTTY) {
+      process.stdout.write(`\r\x1b[K`);
+    }
+  }
+}

package/src/helper/build/templates.js

@@ -0,0 +1,30 @@
+// Template helpers for build
+import { readFile } from "fs/promises";
+import { parse } from "path";
+import { recurse } from "../recursive-readdir.js";
+
+/**
+ * Get all templates from meta directory
+ * @param {string} meta - Full path to meta files directory
+ * @returns {Promise<Object>} Map of templateName to templateBody
+ */
+export async function getTemplates(meta) {
+  const allMetaFilenames = await recurse(meta);
+  const allHtmlFilenames = allMetaFilenames.filter((filename) =>
+    filename.match(/\.html/)
+  );
+
+  let templates = {};
+  const templatesArray = await Promise.all(
+    allHtmlFilenames.map(async (filename) => {
+      const { name } = parse(filename);
+      const fileContent = await readFile(filename, "utf8");
+      return [name, fileContent];
+    })
+  );
+  templatesArray.forEach(
+    ([templateName, templateText]) => (templates[templateName] = templateText)
+  );
+
+  return templates;
+}

package/src/helper/build/titleCase.js

@@ -0,0 +1,7 @@
+// Helper to convert filename to title case
+export function toTitleCase(filename) {
+  return filename
+    .split(/[-_\s]+/)
+    .map(word => word.charAt(0).toUpperCase() + word.slice(1).toLowerCase())
+    .join(' ');
+}

package/src/helper/build/watchCache.js

@@ -0,0 +1,26 @@
+// Watch mode cache and clear function for build
+
+export const watchModeCache = {
+  templates: null,
+  menu: null,
+  footer: null,
+  validPaths: null,
+  source: null,
+  meta: null,
+  output: null,
+  hashCache: null,
+  cacheBustTimestamp: null,
+  lastFullBuild: 0,
+  isInitialized: false,
+};
+
+export function clearWatchCache(cssPathCache) {
+  watchModeCache.templates = null;
+  watchModeCache.menu = null;
+  watchModeCache.footer = null;
+  watchModeCache.validPaths = null;
+  watchModeCache.hashCache = null;
+  watchModeCache.isInitialized = false;
+  if (cssPathCache) cssPathCache.clear();
+  console.log('Watch cache cleared');
+}