project-logbook 0.3.2 → 0.3.3

package/README.md

@@ -17,7 +17,7 @@ Each entry in `logbook/` consists of:
 
 ## Installation
 ```bash
-npm i project-loogbook -g
+npm i project-logbook -g
 ```
 
 ## Commands

package/dist/commands/build.js

@@ -5,7 +5,7 @@ import { getConfig, getWorkspaces } from '../lib/config.js';
 import { layout, timelineTemplate } from '../lib/templates.js';
 import { getStyles } from '../lib/styles.js';
 import { getClientScript } from '../lib/logbook-client.js';
-import { mdToHtml, buildProjectMdFiles, renderPost } from '../lib/build-helpers.js';
+import { mdToHtml, buildProjectMdFiles, renderPost, generateBuildMeta } from '../lib/build-helpers.js';
 import { mdToHtmlWithImages, copyImages } from '../lib/image-helpers.js';
 import { getGitCommits, getGitTags } from '../lib/git-helpers.js';
 import { formatRelativeDate, getMonthYear, getSortTime } from '../utils/date.js';
@@ -176,7 +176,7 @@ export async function build() {
             currentPage,
             totalPages,
         }); // prettier-ignore
-        const buildMeta = `Generated by ${config.projectName} v${version} • ${buildTime}`;
+        const buildMeta = generateBuildMeta(version, buildTime);
         const timelineHtml = layout({
             title: 'Timeline',
             projectName: config.projectName,

package/dist/lib/build-helpers.d.ts

@@ -1,6 +1,8 @@
 import type { LogbookConfig } from './config.js';
 import type { TimelineEntry } from './template-types.js';
 export declare function mdToHtml(md: string): Promise<string>;
+/** Process entry markdown with image path rewriting */
+export declare function mdToHtmlWithImagePathRewrite(md: string): Promise<string>;
 export declare function buildProjectMdFiles(projectRoot: string, outputDir: string, excludeDirs: string[], ctx: {
     config: LogbookConfig;
     version: string;
@@ -13,3 +15,8 @@ export declare function renderPost(data: TimelineEntry, i: number, allEntries: T
     version: string;
     buildTime: string;
 }): Promise<void>;
+/**
+ * Generate the standard footer metadata string.
+ * Always hardcoded to 'Project Logbook CLI' with link to npm.
+ */
+export declare function generateBuildMeta(version: string, buildTime: string): string;

package/dist/lib/build-helpers.js

@@ -10,7 +10,7 @@ import rehypeStringify from 'rehype-stringify';
 import matter from 'gray-matter';
 import { layout, postTemplate } from './templates.js';
 import { getGitCommits } from './git-helpers.js';
-import { mdToHtmlWithImages, extractImagePathsFromMarkdown, copyImages } from './image-helpers.js';
+import { mdToHtmlWithImages, extractImagePathsFromMarkdown, copyImages, rehypeRewriteImagePaths, } from './image-helpers.js';
 /** Rehype plugin: rewrite relative .md links to /index.html equivalents. */
 const rehypeRewriteMdLinks = () => {
     return (tree) => {
@@ -46,10 +46,25 @@ const processor = unified()
     .use(rehypeRewriteMdLinks)
     .use(rehypeFormat)
     .use(rehypeStringify);
+/** Processor for entry content with image path rewriting */
+const entryProcessor = unified()
+    .use(remarkParse)
+    .use(remarkGfm)
+    .use(remarkRehype)
+    .use(rehypeSlug)
+    .use(rehypeRewriteMdLinks)
+    .use(rehypeRewriteImagePaths)
+    .use(rehypeFormat)
+    .use(rehypeStringify);
 export async function mdToHtml(md) {
     const result = await processor.process(md);
     return result.toString();
 }
+/** Process entry markdown with image path rewriting */
+export async function mdToHtmlWithImagePathRewrite(md) {
+    const result = await entryProcessor.process(md);
+    return result.toString();
+}
 export async function buildProjectMdFiles(projectRoot, outputDir, excludeDirs, ctx) {
     const entries = await fs.readdir(projectRoot, { withFileTypes: true });
     for (const entry of entries) {
@@ -62,7 +77,7 @@ export async function buildProjectMdFiles(projectRoot, outputDir, excludeDirs, c
         const outDir = join(outputDir, stem);
         const mdContent = await fs.readFile(sourcePath, 'utf8');
         const bodyHtml = await mdToHtml(mdContent);
-        const buildMeta = `Generated by ${ctx.config.projectName} v${ctx.version} • ${ctx.buildTime}`;
+        const buildMeta = generateBuildMeta(ctx.version, ctx.buildTime);
         const pageHtml = layout({
             title: stem,
             projectName: ctx.config.projectName,
@@ -103,7 +118,7 @@ async function renderLinkedMdFiles(markdownSources, entryPath, entryOutputDir, c
             const mdContent = await fs.readFile(sourcePath, 'utf8');
             const bodyHtml = await mdToHtml(mdContent);
             const title = href.replace(/\.md$/i, '');
-            const buildMeta = `Generated by ${ctx.config.projectName} v${ctx.version} • ${ctx.buildTime}`;
+            const buildMeta = generateBuildMeta(ctx.version, ctx.buildTime);
             const pageHtml = layout({
                 title,
                 projectName: ctx.config.projectName,
@@ -141,8 +156,8 @@ export async function renderPost(data, i, allEntries, ctx) {
         title: data.title ?? data.slug,
         harness: data.harness ?? '',
         content: storyHtml,
-        ticketHtml: ticketRaw ? await mdToHtml(ticketRaw) : '',
-        logHtml: logRaw ? await mdToHtml(logRaw) : '',
+        ticketHtml: ticketRaw ? await mdToHtmlWithImagePathRewrite(ticketRaw) : '',
+        logHtml: logRaw ? await mdToHtmlWithImagePathRewrite(logRaw) : '',
         commits,
         version: ctx.version,
         jiraUrl,
@@ -150,7 +165,7 @@ export async function renderPost(data, i, allEntries, ctx) {
         nextEntry: next ? { slug: next.slug, title: next.title ?? '', ticket: next.ticket } : null,
     });
     const descriptionRaw = typeof data.summary === 'string' ? data.summary.replace(/[*#`]/g, '').trim() : '';
-    const buildMeta = `Generated by ${ctx.config.projectName} v${ctx.version} • ${ctx.buildTime}`;
+    const buildMeta = generateBuildMeta(ctx.version, ctx.buildTime);
     const postHtml = layout({
         title: data.title ?? data.slug,
         projectName: ctx.config.projectName,
@@ -171,3 +186,10 @@ export async function renderPost(data, i, allEntries, ctx) {
     }
     await renderLinkedMdFiles([summaryContent, ticketRaw, logRaw], entryPath, entryOutputDir, ctx);
 }
+/**
+ * Generate the standard footer metadata string.
+ * Always hardcoded to 'Project Logbook CLI' with link to npm.
+ */
+export function generateBuildMeta(version, buildTime) {
+    return `Generated by <a href="https://www.npmjs.com/package/project-logbook" target="_blank" rel="noopener noreferrer">Project Logbook CLI</a> v${version} • ${buildTime}`;
+}

package/dist/lib/image-helpers.d.ts

@@ -1,7 +1,11 @@
+import type { Root } from 'hast';
+import type { Plugin } from 'unified';
 /**
  * Extract image paths from markdown content
  */
 export declare function extractImagePathsFromMarkdown(content: string): string[];
+/** Rehype plugin: rewrite relative image paths to use /images/ subfolder */
+export declare const rehypeRewriteImagePaths: Plugin<[], Root>;
 /**
  * Process markdown with image collection enabled
  * Returns { html, imagePaths }

package/dist/lib/image-helpers.js

@@ -58,6 +58,29 @@ function visitImages(node, visitor) {
         }
     }
 }
+/** Rehype plugin: rewrite relative image paths to use /images/ subfolder */
+export const rehypeRewriteImagePaths = () => {
+    return (tree) => {
+        visitImages(tree, (node) => {
+            const src = node.properties?.src;
+            if (typeof src !== 'string')
+                return;
+            // Skip external URLs and data URIs
+            if (/^[a-z][a-z\d+\-.]*:/i.test(src))
+                return;
+            if (src.startsWith('data:'))
+                return;
+            // Skip already rewritten paths
+            if (src.startsWith('./images/') || src.startsWith('../images/'))
+                return;
+            // Skip absolute paths
+            if (src.startsWith('/'))
+                return;
+            // Rewrite relative paths to use /images/ subfolder
+            node.properties.src = `./images/${src}`;
+        });
+    };
+};
 /**
  * Process markdown with image collection enabled
  * Returns { html, imagePaths }
@@ -69,6 +92,7 @@ export async function mdToHtmlWithImages(md) {
         .use(remarkGfm)
         .use(remarkRehype)
         .use(imageProcessor.rehypeCollectImages)
+        .use(rehypeRewriteImagePaths)
         .use(rehypeSlug)
         .use(rehypeFormat)
         .use(rehypeStringify);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "project-logbook",
-  "version": "0.3.2",
+  "version": "0.3.3",
   "description": "A command-line tool for project logbooks.",
   "workspaces": [
     "demo-app"
@@ -28,7 +28,8 @@
     "test": "vitest run",
     "pre": "npm run format && npm run lint && npm run test && npm run build && npm run knip && npm run madge && npm run dev build && npm run dev lint",
     "next": "node scripts/create-ticket-from-backlog.js",
-    "link": "npm run build && npm link"
+    "link": "npm run build && npm link",
+    "open": "npm run build && node scripts/open-and-view-dist.js"
   },
   "keywords": [
     "logbook",