@kenjura/ursa 0.40.0 → 0.43.0

package/CHANGELOG.md

@@ -1,3 +1,20 @@
+# 0.43.0
+2025-12-14
+
+- Added buildId and .ursa.json
+- Added full datetime to footer
+- Added commit hash to footer as comment
+
+# 0.42.0
+2025-12-14
+
+- Automenu will now remove dashes from file names
+
+# 0.41.0
+2025-12-13
+
+- Fixed footer bug
+
 # 0.40.0
 2025-12-13
 

package/package.json

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

package/src/helper/automenu.js

@@ -14,6 +14,13 @@ const HOME_ICON = '🏠';
 // Index file extensions to check for folder links
 const INDEX_EXTENSIONS = ['.md', '.txt', '.yml', '.yaml'];
 
+// Convert filename to display name (e.g., "foo-bar" -> "Foo Bar")
+function toDisplayName(filename) {
+  return filename
+    .replace(/[-_]/g, ' ')  // Replace dashes and underscores with spaces
+    .replace(/\b\w/g, c => c.toUpperCase());  // Capitalize first letter of each word
+}
+
 function hasIndexFile(dirPath) {
   for (const ext of INDEX_EXTENSIONS) {
     const indexPath = join(dirPath, `index${ext}`);
@@ -151,7 +158,7 @@ function buildMenuData(tree, source, validPaths, parentPath = '') {
     
     // Get folder config for custom label and icon
     const folderConfig = hasChildren ? getFolderConfig(item.path) : null;
-    const label = folderConfig?.label || baseName;
+    const label = folderConfig?.label || toDisplayName(baseName);
     
     let rawHref = null;
     if (hasChildren) {

package/src/helper/ursaConfig.js

@@ -0,0 +1,62 @@
+import { existsSync, readFileSync, writeFileSync } from "fs";
+import { join } from "path";
+
+const CONFIG_FILENAME = '.ursa.json';
+
+/**
+ * Get the path to the .ursa.json config file in the source directory
+ * @param {string} sourceDir - The source directory path
+ * @returns {string} Path to the config file
+ */
+function getConfigPath(sourceDir) {
+  return join(sourceDir, CONFIG_FILENAME);
+}
+
+/**
+ * Load the ursa config from .ursa.json
+ * @param {string} sourceDir - The source directory path
+ * @returns {object} The config object (empty object if file doesn't exist)
+ */
+export function loadUrsaConfig(sourceDir) {
+  const configPath = getConfigPath(sourceDir);
+  try {
+    if (existsSync(configPath)) {
+      const content = readFileSync(configPath, 'utf8');
+      return JSON.parse(content);
+    }
+  } catch (e) {
+    console.error(`Error reading ${CONFIG_FILENAME}: ${e.message}`);
+  }
+  return {};
+}
+
+/**
+ * Save the ursa config to .ursa.json
+ * @param {string} sourceDir - The source directory path
+ * @param {object} config - The config object to save
+ */
+export function saveUrsaConfig(sourceDir, config) {
+  const configPath = getConfigPath(sourceDir);
+  try {
+    const content = JSON.stringify(config, null, 2);
+    writeFileSync(configPath, content, 'utf8');
+  } catch (e) {
+    console.error(`Error writing ${CONFIG_FILENAME}: ${e.message}`);
+  }
+}
+
+/**
+ * Get the current build ID and increment it for the next build
+ * @param {string} sourceDir - The source directory path
+ * @returns {number} The current build ID (starting from 1)
+ */
+export function getAndIncrementBuildId(sourceDir) {
+  const config = loadUrsaConfig(sourceDir);
+  const currentBuildId = config.buildId || 0;
+  const newBuildId = currentBuildId + 1;
+  
+  config.buildId = newBuildId;
+  saveUrsaConfig(sourceDir, config);
+  
+  return newBuildId;
+}

package/src/jobs/generate.js

@@ -20,6 +20,7 @@ import {
   buildValidPaths,
   markInactiveLinks,
 } from "../helper/linkValidator.js";
+import { getAndIncrementBuildId } from "../helper/ursaConfig.js";
 
 // Helper function to build search index from processed files
 function buildSearchIndex(jsonCache, source, output) {
@@ -128,8 +129,12 @@ export async function generate({
 
   const menu = await getMenu(allSourceFilenames, source, validPaths);
 
+  // Get and increment build ID from .ursa.json
+  const buildId = getAndIncrementBuildId(resolve(_source));
+  console.log(`Build #${buildId}`);
+
   // Generate footer content
-  const footer = await getFooter(source, _source);
+  const footer = await getFooter(source, _source, buildId);
 
   // Load content hash cache from .ursa folder in source directory
   let hashCache = new Map();
@@ -551,8 +556,9 @@ function addTrailingSlash(somePath) {
  * Generate footer HTML from footer.md and package.json
  * @param {string} source - resolved source path with trailing slash
  * @param {string} _source - original source path
+ * @param {number} buildId - the current build ID
  */
-async function getFooter(source, _source) {
+async function getFooter(source, _source, buildId) {
   const footerParts = [];
   
   // Try to read footer.md from source root
@@ -567,35 +573,58 @@ async function getFooter(source, _source) {
     console.error(`Error reading footer.md: ${e.message}`);
   }
   
-  // Try to read package.json from doc repo
+  // Try to read package.json from doc repo (check both source dir and parent)
   let docPackage = null;
-  const packagePath = join(resolve(_source), 'package.json');
-  try {
-    if (existsSync(packagePath)) {
-      const packageJson = await readFile(packagePath, 'utf8');
-      docPackage = JSON.parse(packageJson);
+  const sourceDir = resolve(_source);
+  const packagePaths = [
+    join(sourceDir, 'package.json'),           // In source dir itself
+    join(sourceDir, '..', 'package.json'),     // One level up (if docs is a subfolder)
+  ];
+  
+  for (const packagePath of packagePaths) {
+    try {
+      if (existsSync(packagePath)) {
+        const packageJson = await readFile(packagePath, 'utf8');
+        docPackage = JSON.parse(packageJson);
+        console.log(`Found doc package.json at ${packagePath}`);
+        break;
+      }
+    } catch (e) {
+      // Continue to next path
     }
-  } catch (e) {
-    console.error(`Error reading doc package.json: ${e.message}`);
   }
   
   // Get ursa version from ursa's own package.json
+  // Use import.meta.url to find the package.json relative to this file
   let ursaVersion = 'unknown';
   try {
-    const ursaPackagePath = new URL('../../../package.json', import.meta.url).pathname;
-    const ursaPackageJson = await readFile(ursaPackagePath, 'utf8');
-    const ursaPackage = JSON.parse(ursaPackageJson);
-    ursaVersion = ursaPackage.version;
+    // From src/jobs/generate.js, go up to package root
+    const currentFileUrl = new URL(import.meta.url);
+    const currentDir = dirname(currentFileUrl.pathname);
+    const ursaPackagePath = resolve(currentDir, '..', '..', 'package.json');
+    
+    if (existsSync(ursaPackagePath)) {
+      const ursaPackageJson = await readFile(ursaPackagePath, 'utf8');
+      const ursaPackage = JSON.parse(ursaPackageJson);
+      ursaVersion = ursaPackage.version;
+      console.log(`Found ursa package.json at ${ursaPackagePath}, version: ${ursaVersion}`);
+    }
   } catch (e) {
     console.error(`Error reading ursa package.json: ${e.message}`);
   }
   
-  // Build meta line: version, timestamp, "generated by ursa"
+  // Build meta line: version, build id, timestamp, "generated by ursa"
   const metaParts = [];
   if (docPackage?.version) {
     metaParts.push(`v${docPackage.version}`);
   }
-  metaParts.push(new Date().toISOString().split('T')[0]); // YYYY-MM-DD
+  metaParts.push(`build ${buildId}`);
+  
+  // Full date/time in a readable format
+  const now = new Date();
+  const timestamp = now.toISOString().replace('T', ' ').replace(/\.\d{3}Z$/, ' UTC');
+  metaParts.push(timestamp);
+  
   metaParts.push(`Generated by <a href="https://www.npmjs.com/package/@kenjura/ursa">ursa</a> v${ursaVersion}`);
   
   footerParts.push(`<div class="footer-meta">${metaParts.join(' • ')}</div>`);
@@ -611,5 +640,20 @@ async function getFooter(source, _source) {
     }
   }
   
+  // Try to get git short hash of doc repo (as HTML comment)
+  try {
+    const { execSync } = await import('child_process');
+    const gitHash = execSync('git rev-parse --short HEAD', {
+      cwd: resolve(_source),
+      encoding: 'utf8',
+      stdio: ['pipe', 'pipe', 'pipe']
+    }).trim();
+    if (gitHash) {
+      footerParts.push(`<!-- git: ${gitHash} -->`);
+    }
+  } catch (e) {
+    // Not a git repo or git not available - silently skip
+  }
+  
   return footerParts.join('\n');
 }