project-logbook 0.4.0 → 1.0.0

package/dist/utils/timeline-helpers.js

@@ -1,10 +1,12 @@
-export function groupTimelineItems(entries, commits, tags) {
+export function groupTimelineItems(entries, commits, tags, adrs = []) {
     const toMs = (item) => {
         if (item.kind === 'entry')
             return item.dateEnd ? new Date(item.dateEnd).getTime() : new Date(item.dateStart).getTime();
+        if (item.kind === 'adr')
+            return new Date(item.date).getTime();
         return new Date(item.timestamp).getTime();
     };
-    const all = [...entries, ...commits, ...tags];
+    const all = [...entries, ...commits, ...tags, ...adrs];
     all.sort((a, b) => toMs(b) - toMs(a));
     const groups = [];
     for (const item of all) {
@@ -17,3 +19,4 @@ export function groupTimelineItems(entries, commits, tags) {
     }
     return groups;
 }
+//# sourceMappingURL=timeline-helpers.js.map

package/dist/utils/timeline-helpers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"timeline-helpers.js","sourceRoot":"","sources":["../../src/utils/timeline-helpers.ts"],"names":[],"mappings":"AAQA,MAAM,UAAU,kBAAkB,CAChC,OAAmD,EACnD,OAA6B,EAC7B,IAAuB,EACvB,OAA0B,EAAE;IAG5B,MAAM,IAAI,GAAG,CAAC,IAAa,EAAU,EAAE;QACrC,IAAI,IAAI,CAAC,IAAI,KAAK,OAAO;YACvB,OAAO,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,OAAO,EAAE,CAAC;QAC9F,IAAI,IAAI,CAAC,IAAI,KAAK,KAAK;YAAE,OAAO,IAAI,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,CAAC;QAC9D,OAAO,IAAI,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,OAAO,EAAE,CAAC;IAC5C,CAAC,CAAC;IAEF,MAAM,GAAG,GAAc,CAAC,GAAG,OAAO,EAAE,GAAG,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,IAAI,CAAC,CAAC;IAClE,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;IAEtC,MAAM,MAAM,GAAoB,EAAE,CAAC;IACnC,KAAK,MAAM,IAAI,IAAI,GAAG,EAAE,CAAC;QACvB,IAAI,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,KAAK,IAAI,CAAC,UAAU,CAAC,CAAC;QAC5D,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,KAAK,GAAG,EAAE,KAAK,EAAE,IAAI,CAAC,UAAU,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC;YAC9C,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACrB,CAAC;QACD,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACzB,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC"}

package/dist/utils/validation.d.ts

@@ -0,0 +1,5 @@
+import { EntryMeta } from './fs.js';
+/**
+ * Check if a logbook entry contains bracket-style template placeholders, TODOs, or fallback prompt text.
+ */
+export declare function hasUnfilledPlaceholders(entry: EntryMeta): boolean;

package/dist/utils/validation.js

@@ -0,0 +1,21 @@
+/**
+ * Check if a logbook entry contains bracket-style template placeholders, TODOs, or fallback prompt text.
+ */
+export function hasUnfilledPlaceholders(entry) {
+    // Check frontmatter field values for bracket-style unfilled placeholders
+    const dataValues = Object.values(entry.data)
+        .filter((v) => typeof v === 'string')
+        .join('\n');
+    const frontmatterHasPlaceholders = dataValues.includes('[DATE_END]') ||
+        dataValues.includes('[DATE_START]') ||
+        dataValues.includes('[WRITE_SUMMARY_HERE]') ||
+        dataValues.includes('[PROMPTER]') ||
+        dataValues.includes('[HARNESS]') ||
+        dataValues.includes('[LLM]');
+    // Check body content for unfilled template hints (strip fenced and inline code blocks to avoid false positives)
+    const contentWithoutCode = entry.content.replace(/```[\s\S]*?```/g, '').replace(/`[^`]*`/g, '');
+    const bodyHasPlaceholders = contentWithoutCode.includes('TODO:') ||
+        entry.content.includes('Write a polished, highly readable "short story" of the change here.');
+    return frontmatterHasPlaceholders || bodyHasPlaceholders;
+}
+//# sourceMappingURL=validation.js.map

package/dist/utils/validation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validation.js","sourceRoot":"","sources":["../../src/utils/validation.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,UAAU,uBAAuB,CAAC,KAAgB;IACtD,yEAAyE;IACzE,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC;SACzC,MAAM,CAAC,CAAC,CAAC,EAAe,EAAE,CAAC,OAAO,CAAC,KAAK,QAAQ,CAAC;SACjD,IAAI,CAAC,IAAI,CAAC,CAAC;IACd,MAAM,0BAA0B,GAC9B,UAAU,CAAC,QAAQ,CAAC,YAAY,CAAC;QACjC,UAAU,CAAC,QAAQ,CAAC,cAAc,CAAC;QACnC,UAAU,CAAC,QAAQ,CAAC,sBAAsB,CAAC;QAC3C,UAAU,CAAC,QAAQ,CAAC,YAAY,CAAC;QACjC,UAAU,CAAC,QAAQ,CAAC,WAAW,CAAC;QAChC,UAAU,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;IAE/B,gHAAgH;IAChH,MAAM,kBAAkB,GAAG,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,iBAAiB,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC;IAChG,MAAM,mBAAmB,GACvB,kBAAkB,CAAC,QAAQ,CAAC,OAAO,CAAC;QACpC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,qEAAqE,CAAC,CAAC;IAEhG,OAAO,0BAA0B,IAAI,mBAAmB,CAAC;AAC3D,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "project-logbook",
-  "version": "0.4.0",
+  "version": "1.0.0",
   "description": "A command-line tool for project logbooks.",
   "workspaces": [
     "demo-app"
@@ -24,9 +24,10 @@
     "lint": "eslint src --ext .ts --fix",
     "format": "prettier --write --list-different .",
     "knip": "cross-env NO_CONSOLE=true knip || true",
-    "madge": "npx --yes madge --circular --extensions ts --ts-config ./tsconfig.json src/index.ts",
+    "madge": "madge --circular --extensions ts --ts-config ./tsconfig.json src/index.ts",
+    "jscpd": "jscpd src",
     "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",
+    "pre": "npm run format && npm run lint && npm audit && npm run test && npm run build && npm run knip && npm run madge && npm run jscpd && npm run dev build && npm run dev lint",
     "next": "node scripts/create-ticket-from-backlog.js",
     "link": "npm run build && npm link",
     "open": "npm run dev build && node scripts/open-and-view-dist.js"
@@ -36,7 +37,7 @@
     "cli",
     "project"
   ],
-  "author": "",
+  "author": "falvhb",
   "license": "MIT",
   "devDependencies": {
     "@types/fs-extra": "^11.0.4",
@@ -48,13 +49,18 @@
     "@vitest/coverage-v8": "^3.1.4",
     "cross-env": "^7.0.3",
     "eslint": "^9.27.0",
+    "jscpd": "^4.2.4",
     "knip": "^5.55.0",
+    "madge": "^8.0.0",
     "prettier": "^3.5.3",
     "rimraf": "^6.1.3",
     "tsx": "^4.21.0",
     "typescript": "^6.0.3",
     "vitest": "^3.1.4"
   },
+  "overrides": {
+    "typescript": "^6.0.3"
+  },
   "dependencies": {
     "chalk": "^5.6.2",
     "commander": "^14.0.3",

package/src/templates/WELCOME.md

@@ -0,0 +1,12 @@
+# Welcome to the Project Logbook!
+
+This website is a **Project Logbook** — a chronological timeline of this project's evolution, design decisions, and development history.
+
+Unlike traditional static documentation, a logbook behaves like a **dev log** or **news feed** of the codebase. Each item in the timeline below represents a completed feature or bugfix, containing:
+- **Original Specifications:** The initial requirements and user stories.
+- **Technical Log:** Step-by-step notes and decisions made during development.
+- **The Story:** An engaging narrative explaining the rationale, pivots, and solutions.
+
+Click around to explore how this project was built step by step!
+
+Wait, did we mention it has an [**RSS Feed**](rss.xml)? Yes, you can subscribe to stay updated on new logbook entries in real-time!

package/src/templates/index.md

@@ -31,4 +31,5 @@ TODO: Write a polished, highly readable ticket summary that reads like an engagi
 - **Use bullet points:** TODO: Whenever listing multiple items (like friction points, test scenarios, or rewritten paths), use a bulleted list instead of a dense paragraph to make it scannable.
 - **Use bold emphasis:** TODO: Bold key concepts, problems, and solutions to guide the reader's eye.
 - **Format code:** TODO: Use inline backticks for files, plugins, HTML elements, and code snippets (e.g., `src/lib/build-helpers.ts`).
-- **Keep paragraphs short:** TODO: Ensure no paragraph is longer than 3-4 sentences. Keep the pacing quick and engaging.
+- **Keep paragraphs short:** TODO: Ensure no paragraph is longer than 3-4 sentences. Keep the pacing quick and engaging.
+- **Do not state the obvious**: TODO: Passed tests, lints, pre-commit suites are mandatory and no ticket is released without this. This does not need to be mentioned

package/src/templates/logbook-client.js

@@ -168,6 +168,32 @@
     }
   }
 
+  /* ── 4. Welcome banner functionality ────────────────────────────────────── */
+  function initWelcomeBanner() {
+    var banner = document.getElementById('welcome-banner');
+    if (!banner) return;
+    try {
+      if (localStorage.getItem('welcome-banner-dismissed') !== 'true') {
+        banner.style.display = 'block';
+      }
+    } catch (e) {
+      // In case localStorage is disabled/unavailable, default to showing
+      banner.style.display = 'block';
+    }
+
+    var closeBtn = document.getElementById('welcome-banner-close');
+    if (closeBtn) {
+      closeBtn.addEventListener('click', function () {
+        banner.style.display = 'none';
+        try {
+          localStorage.setItem('welcome-banner-dismissed', 'true');
+        } catch (e) {
+          /* localStorage unavailable */
+        }
+      });
+    }
+  }
+
   /* ── Bootstrap ─────────────────────────────────────────────────────────── */
   document.addEventListener('DOMContentLoaded', function () {
     updateRelativeDates();
@@ -181,6 +207,9 @@
 
     // Initialize tab functionality
     initTabs();
+
+    // Initialize welcome banner if present
+    initWelcomeBanner();
   });
 
   // Expose showTab globally for onclick handlers

package/src/templates/styles.css

@@ -19,10 +19,16 @@ body {
 header {
   background: var(--card-bg);
   border-bottom: 1px solid var(--border);
-  padding: 2rem 1rem;
+  padding: 2rem 0 0 0;
   text-align: center;
 }
 
+.header-inner {
+  max-width: var(--max-width);
+  margin: 0 auto;
+  padding: 0 1.5rem;
+}
+
 header h1 {
   margin: 0;
   font-size: 2.25rem;
@@ -168,15 +174,15 @@ main {
   display: inline-flex;
   align-items: center;
   font-size: 0.8125rem;
-  font-weight: 500;
   color: var(--primary);
   text-decoration: none;
-  transition:
-    color 0.2s,
-    background 0.2s;
   background: var(--primary-soft);
   padding: 0.5rem 1rem;
   border-radius: 2rem;
+  font-weight: 500;
+  transition:
+    background 0.2s,
+    color 0.2s;
 }
 
 .back-link:hover {
@@ -184,23 +190,7 @@ main {
   color: white;
 }
 
-/* Action bar - Back button + tabs on same line */
-.action-bar {
-  display: flex;
-  align-items: center;
-  justify-content: space-between;
-  gap: 1rem;
-  margin-bottom: 3rem;
-  flex-wrap: wrap;
-}
-
-.action-tabs-wrapper {
-  display: flex;
-  align-items: center;
-  gap: 1rem;
-  flex-wrap: wrap;
-}
-
+/* Jira Action Button */
 .jira-link-btn {
   display: inline-flex;
   align-items: center;
@@ -221,6 +211,48 @@ main {
   color: white;
 }
 
+/* Header Navigation - Back button, tabs, and Jira link */
+.header-nav {
+  display: grid;
+  grid-template-columns: 1fr auto 1fr;
+  align-items: center;
+  margin-top: 2rem;
+  gap: 1rem;
+}
+
+.header-nav-left {
+  text-align: left;
+  display: flex;
+  align-items: center;
+}
+
+.header-nav-right {
+  text-align: right;
+  display: flex;
+  align-items: center;
+  justify-content: flex-end;
+}
+
+.header-nav--center {
+  display: flex;
+  justify-content: center;
+}
+
+@media (max-width: 640px) {
+  .header-nav {
+    display: flex;
+    flex-direction: column;
+    align-items: center;
+    gap: 1rem;
+    padding-bottom: 1rem;
+  }
+  .header-nav-left,
+  .header-nav-right {
+    text-align: center;
+    justify-content: center;
+  }
+}
+
 /* Jira link in build-meta - inline style */
 .build-meta .jira-link-btn {
   margin-left: 0.5rem;
@@ -261,21 +293,25 @@ article h1 {
 
 .tabs {
   display: flex;
-  gap: 0.5rem;
-  background: #f4f4f4;
-  padding: 0.25rem;
-  border-radius: 0.75rem;
+  gap: 1.5rem;
+  background: none;
+  padding: 0;
+  border-radius: 0;
   width: fit-content;
+  margin-bottom: -1px;
+  position: relative;
+  z-index: 2;
 }
 
 .tab {
-  padding: 0.625rem 1.25rem;
-  font-size: 0.8125rem;
+  padding: 0.75rem 0.25rem;
+  font-size: 0.875rem;
   font-weight: 600;
   color: var(--text-muted);
   cursor: pointer;
-  border-radius: 0.5rem;
-  transition: all 0.2s cubic-bezier(0.4, 0, 0.2, 1);
+  border-bottom: 2px solid transparent;
+  transition: all 0.2s ease;
+  border-radius: 0;
 }
 
 .tab:hover {
@@ -284,8 +320,9 @@ article h1 {
 
 .tab.active {
   color: var(--primary);
-  background: white;
-  box-shadow: 0 2px 4px rgba(0, 0, 0, 0.05);
+  border-bottom-color: var(--primary);
+  background: none;
+  box-shadow: none;
 }
 
 /* Pagination Links */
@@ -504,6 +541,11 @@ footer .build-time a:hover {
   color: #374151;
 }
 
+.tag-superseded {
+  background: #f3f4f6;
+  color: #4b5563;
+}
+
 /* Timeline card tag styling */
 .timeline-card .tags-wrapper {
   margin-top: 0.5rem;
@@ -812,3 +854,134 @@ article img[src$='.svg'] {
   font-family: ui-monospace, 'Cascadia Code', 'Source Code Pro', Menlo, Consolas, monospace;
   font-size: 0.8125rem;
 }
+
+/* Welcome Banner */
+.welcome-banner {
+  background: var(--bg-card, #ffffff);
+  border: 1px solid var(--border, #e2e8f0);
+  padding: 1.5rem;
+  border-radius: 0.5rem;
+  margin-top: 1.5rem;
+  margin-bottom: 2rem;
+  position: relative;
+  box-shadow:
+    0 1px 3px 0 rgba(0, 0, 0, 0.1),
+    0 1px 2px -1px rgba(0, 0, 0, 0.1);
+}
+
+.welcome-banner-content h1 {
+  font-size: 1.25rem;
+  margin-top: 0;
+  margin-bottom: 0.75rem;
+  color: var(--text-main, #1e293b);
+  display: flex;
+  align-items: center;
+  gap: 0.5rem;
+}
+
+.welcome-banner-content p {
+  margin: 0 0 0.75rem 0;
+  line-height: 1.5;
+  color: var(--text, #334155);
+}
+
+.welcome-banner-content ul {
+  margin: 0 0 1rem 0;
+  padding-left: 1.25rem;
+  color: var(--text, #334155);
+}
+
+.welcome-banner-content li {
+  margin-bottom: 0.5rem;
+  line-height: 1.4;
+}
+
+.welcome-banner-close {
+  position: absolute;
+  top: 1rem;
+  right: 1rem;
+  background: none;
+  border: none;
+  font-size: 1.25rem;
+  cursor: pointer;
+  color: var(--text-muted, #64748b);
+  line-height: 1;
+  padding: 0.25rem;
+  border-radius: 0.25rem;
+  display: flex;
+  align-items: center;
+  justify-content: center;
+  transition:
+    background-color 0.2s,
+    color 0.2s;
+}
+
+.welcome-banner-close:hover {
+  background-color: var(--primary-soft, #f0fdf4);
+  color: var(--text-main, #1e293b);
+}
+
+/* ADR Details and Cards */
+.adr-detail-card {
+  max-width: var(--max-width);
+  margin: 0 auto;
+  background: var(--card-bg);
+  padding: 2rem;
+  border-radius: 0.5rem;
+  border: 1px solid var(--border);
+}
+
+.adr-detail-meta {
+  margin-bottom: 1.5rem;
+  font-size: 0.85rem;
+  color: var(--text-muted);
+}
+
+.adr-status-badge {
+  margin-right: 0.5rem;
+  text-transform: uppercase;
+  font-size: 0.7rem;
+  padding: 0.15rem 0.4rem;
+}
+
+.adr-detail-title {
+  font-size: 2rem;
+  margin-top: 0;
+  margin-bottom: 1.5rem;
+  letter-spacing: -0.025em;
+  font-weight: 800;
+}
+
+.adr-detail-body {
+  margin-top: 2rem;
+}
+
+.adr-detail-tags {
+  margin-top: 2rem;
+  border-top: 1px solid var(--border);
+  padding-top: 1.5rem;
+}
+
+.adr-indicator-badge {
+  background: #e0f2fe !important;
+  color: #0369a1 !important;
+  font-weight: bold;
+}
+
+.timeline-card--adr {
+  background: color-mix(in srgb, var(--primary) 4%, var(--card-bg, #ffffff)) !important;
+  border: 1px solid color-mix(in srgb, var(--primary) 12%, var(--border, #e5e7eb)) !important;
+  border-radius: 0.5rem;
+}
+
+.timeline-card--adr .item-summary {
+  font-style: italic;
+  border-left: 2px solid var(--primary);
+  padding-left: 0.75rem;
+  margin-top: 0.5rem;
+  color: var(--text-muted);
+}
+
+.timeline-card--adr .tags-wrapper {
+  margin-top: 0.5rem;
+}