project-logbook 1.2.0 → 1.4.0

package/dist/linters/qna.js

@@ -0,0 +1,120 @@
+import fs from 'fs-extra';
+import { join } from 'node:path';
+import matter from 'gray-matter';
+import { getQnaDirPath } from '../lib/config.js';
+import { parseQnaContent } from '../utils/qna.js';
+const linter = {
+    name: 'qna',
+    description: 'Validates QnA file naming, frontmatter, and mandatory subtitles',
+    async check(context) {
+        if (context.entryName)
+            return [];
+        const issues = [];
+        const qnaDir = getQnaDirPath(context.config) || join(process.cwd(), 'docs/qna');
+        if (!(await fs.pathExists(qnaDir))) {
+            return issues;
+        }
+        const files = await fs.readdir(qnaDir);
+        for (const file of files) {
+            const filePath = join(qnaDir, file);
+            const stat = await fs.stat(filePath);
+            if (stat.isDirectory())
+                continue;
+            if (!file.endsWith('.md')) {
+                issues.push({
+                    level: 'warning',
+                    category: 'qna',
+                    message: `${file}: Unexpected non-markdown file in QnA directory.`,
+                });
+                continue;
+            }
+            if (!/^\d{5}-[\w-]+\.md$/.test(file)) {
+                issues.push({
+                    level: 'error',
+                    category: 'qna',
+                    message: `${file}: File name must match format '00001-question-slug.md'`,
+                });
+            }
+            try {
+                const raw = await fs.readFile(filePath, 'utf8');
+                const { data, content } = matter(raw);
+                if (data.id === undefined || typeof data.id !== 'number') {
+                    issues.push({
+                        level: 'error',
+                        category: 'qna',
+                        message: `${file}: Missing or invalid numeric 'id' in frontmatter.`,
+                    });
+                }
+                const validStatuses = ['asked', 'answered', 'deprecated'];
+                if (!data.status || !validStatuses.includes(String(data.status))) {
+                    issues.push({
+                        level: 'error',
+                        category: 'qna',
+                        message: `${file}: 'status' must be one of: asked, answered, deprecated.`,
+                    });
+                }
+                if (!data.dateAsked) {
+                    issues.push({
+                        level: 'error',
+                        category: 'qna',
+                        message: `${file}: Missing required 'dateAsked' in frontmatter.`,
+                    });
+                }
+                if (data.status === 'answered' && !data.dateAnswered) {
+                    issues.push({
+                        level: 'error',
+                        category: 'qna',
+                        message: `${file}: 'dateAnswered' is required when status is 'answered'.`,
+                    });
+                }
+                if (data.status === 'deprecated' && !data.dateDeprecated) {
+                    issues.push({
+                        level: 'error',
+                        category: 'qna',
+                        message: `${file}: 'dateDeprecated' is required when status is 'deprecated'.`,
+                    });
+                }
+                // Subtitle checks (markdown subtitles are mandatory)
+                if (!/###\s+Question/i.test(content)) {
+                    issues.push({
+                        level: 'error',
+                        category: 'qna',
+                        message: `${file}: Mandatory subtitle '### Question' is missing.`,
+                    });
+                }
+                if (!/###\s+Answer/i.test(content)) {
+                    issues.push({
+                        level: 'error',
+                        category: 'qna',
+                        message: `${file}: Mandatory subtitle '### Answer' is missing.`,
+                    });
+                }
+                const { question, answer } = parseQnaContent(content);
+                if (!question) {
+                    issues.push({
+                        level: 'error',
+                        category: 'qna',
+                        message: `${file}: Question content under '### Question' cannot be empty.`,
+                    });
+                }
+                if (data.status === 'answered' && !answer) {
+                    issues.push({
+                        level: 'error',
+                        category: 'qna',
+                        message: `${file}: Answer content under '### Answer' is empty for answered question.`,
+                    });
+                }
+            }
+            catch (err) {
+                issues.push({
+                    level: 'error',
+                    category: 'qna',
+                    message: `${file}: Failed to parse markdown/frontmatter: ${err instanceof Error ? err.message : String(err)}`,
+                });
+            }
+        }
+        return issues;
+    },
+};
+export default linter;
+//# sourceMappingURL=qna.js.map

package/dist/linters/qna.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"qna.js","sourceRoot":"","sources":["../../src/linters/qna.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,UAAU,CAAC;AAC1B,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,OAAO,MAAM,MAAM,aAAa,CAAC;AAEjC,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACjD,OAAO,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AAElD,MAAM,MAAM,GAAW;IACrB,IAAI,EAAE,KAAK;IACX,WAAW,EAAE,iEAAiE;IAC9E,KAAK,CAAC,KAAK,CAAC,OAAsB;QAChC,IAAI,OAAO,CAAC,SAAS;YAAE,OAAO,EAAE,CAAC;QAEjC,MAAM,MAAM,GAAgB,EAAE,CAAC;QAC/B,MAAM,MAAM,GAAG,aAAa,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,UAAU,CAAC,CAAC;QAEhF,IAAI,CAAC,CAAC,MAAM,EAAE,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC;YACnC,OAAO,MAAM,CAAC;QAChB,CAAC;QAED,MAAM,KAAK,GAAG,MAAM,EAAE,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QAEvC,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;YACzB,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;YACpC,MAAM,IAAI,GAAG,MAAM,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YACrC,IAAI,IAAI,CAAC,WAAW,EAAE;gBAAE,SAAS;YAEjC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;gBAC1B,MAAM,CAAC,IAAI,CAAC;oBACV,KAAK,EAAE,SAAS;oBAChB,QAAQ,EAAE,KAAK;oBACf,OAAO,EAAE,GAAG,IAAI,kDAAkD;iBACnE,CAAC,CAAC;gBACH,SAAS;YACX,CAAC;YAED,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;gBACrC,MAAM,CAAC,IAAI,CAAC;oBACV,KAAK,EAAE,OAAO;oBACd,QAAQ,EAAE,KAAK;oBACf,OAAO,EAAE,GAAG,IAAI,wDAAwD;iBACzE,CAAC,CAAC;YACL,CAAC;YAED,IAAI,CAAC;gBACH,MAAM,GAAG,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;gBAChD,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;gBAEtC,IAAI,IAAI,CAAC,EAAE,KAAK,SAAS,IAAI,OAAO,IAAI,CAAC,EAAE,KAAK,QAAQ,EAAE,CAAC;oBACzD,MAAM,CAAC,IAAI,CAAC;wBACV,KAAK,EAAE,OAAO;wBACd,QAAQ,EAAE,KAAK;wBACf,OAAO,EAAE,GAAG,IAAI,mDAAmD;qBACpE,CAAC,CAAC;gBACL,CAAC;gBAED,MAAM,aAAa,GAAsB,CAAC,OAAO,EAAE,UAAU,EAAE,YAAY,CAAC,CAAC;gBAC7E,IAAI,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC;oBACjE,MAAM,CAAC,IAAI,CAAC;wBACV,KAAK,EAAE,OAAO;wBACd,QAAQ,EAAE,KAAK;wBACf,OAAO,EAAE,GAAG,IAAI,yDAAyD;qBAC1E,CAAC,CAAC;gBACL,CAAC;gBAED,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC;oBACpB,MAAM,CAAC,IAAI,CAAC;wBACV,KAAK,EAAE,OAAO;wBACd,QAAQ,EAAE,KAAK;wBACf,OAAO,EAAE,GAAG,IAAI,gDAAgD;qBACjE,CAAC,CAAC;gBACL,CAAC;gBAED,IAAI,IAAI,CAAC,MAAM,KAAK,UAAU,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC;oBACrD,MAAM,CAAC,IAAI,CAAC;wBACV,KAAK,EAAE,OAAO;wBACd,QAAQ,EAAE,KAAK;wBACf,OAAO,EAAE,GAAG,IAAI,yDAAyD;qBAC1E,CAAC,CAAC;gBACL,CAAC;gBAED,IAAI,IAAI,CAAC,MAAM,KAAK,YAAY,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,CAAC;oBACzD,MAAM,CAAC,IAAI,CAAC;wBACV,KAAK,EAAE,OAAO;wBACd,QAAQ,EAAE,KAAK;wBACf,OAAO,EAAE,GAAG,IAAI,6DAA6D;qBAC9E,CAAC,CAAC;gBACL,CAAC;gBAED,qDAAqD;gBACrD,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;oBACrC,MAAM,CAAC,IAAI,CAAC;wBACV,KAAK,EAAE,OAAO;wBACd,QAAQ,EAAE,KAAK;wBACf,OAAO,EAAE,GAAG,IAAI,iDAAiD;qBAClE,CAAC,CAAC;gBACL,CAAC;gBAED,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;oBACnC,MAAM,CAAC,IAAI,CAAC;wBACV,KAAK,EAAE,OAAO;wBACd,QAAQ,EAAE,KAAK;wBACf,OAAO,EAAE,GAAG,IAAI,+CAA+C;qBAChE,CAAC,CAAC;gBACL,CAAC;gBAED,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,eAAe,CAAC,OAAO,CAAC,CAAC;gBACtD,IAAI,CAAC,QAAQ,EAAE,CAAC;oBACd,MAAM,CAAC,IAAI,CAAC;wBACV,KAAK,EAAE,OAAO;wBACd,QAAQ,EAAE,KAAK;wBACf,OAAO,EAAE,GAAG,IAAI,0DAA0D;qBAC3E,CAAC,CAAC;gBACL,CAAC;gBAED,IAAI,IAAI,CAAC,MAAM,KAAK,UAAU,IAAI,CAAC,MAAM,EAAE,CAAC;oBAC1C,MAAM,CAAC,IAAI,CAAC;wBACV,KAAK,EAAE,OAAO;wBACd,QAAQ,EAAE,KAAK;wBACf,OAAO,EAAE,GAAG,IAAI,qEAAqE;qBACtF,CAAC,CAAC;gBACL,CAAC;YACH,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,MAAM,CAAC,IAAI,CAAC;oBACV,KAAK,EAAE,OAAO;oBACd,QAAQ,EAAE,KAAK;oBACf,OAAO,EAAE,GAAG,IAAI,2CAA2C,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE;iBAC9G,CAAC,CAAC;YACL,CAAC;QACH,CAAC;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;CACF,CAAC;AAEF,eAAe,MAAM,CAAC"}

package/dist/templates/about-watch.md

@@ -0,0 +1,29 @@
+# logbook Hub
+
+The **logbook Hub** is a real-time dashboard for monitoring multiple project-logbook instances on your machine.
+
+## How it works
+
+- The first `logbook watch` invocation binds **port 4201** and becomes the Hub server.
+- Subsequent invocations detect the Hub, register as a Watcher, and push status updates.
+- Each project appears as a card on the dashboard with status badges.
+- The dashboard updates in real time via **Server-Sent Events (SSE)**.
+
+## What you see
+
+| Element | Description |
+|---------|-------------|
+| **Badges** | Color-coded status indicators (green = good, yellow = warning, blue = info) |
+| **Branch** | Current git branch, click to open in the repository |
+| **Ticket** | Active logbook ticket, click to open in Jira (if configured) |
+| **Activity** | Recent events: log entries, starts, releases |
+| **Previews** | Story, Log, and Ticket content rendered as HTML (click buttons) |
+| **Details** | LOC stats, staged/unstaged files, commit counts (click card to expand) |
+
+## Status badges
+
+The Help tab lists every status strategy with its severity and which badges it blocks.
+
+## Jira & GitLab tabs
+
+When a project has `jiraBaseUrl` configured and `JIRA_API_TOKEN` set, assigned issues appear in the Jira tab. When `glab` CLI is installed and authenticated, open merge requests appear in the GitLab tab.