project-logbook 1.0.0 → 1.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (81) hide show
  1. package/README.md +5 -1
  2. package/dist/commands/build.js +49 -15
  3. package/dist/commands/build.js.map +1 -1
  4. package/dist/commands/lint.js +2 -1
  5. package/dist/commands/lint.js.map +1 -1
  6. package/dist/commands/list.js +10 -10
  7. package/dist/commands/list.js.map +1 -1
  8. package/dist/commands/log.js +24 -1
  9. package/dist/commands/log.js.map +1 -1
  10. package/dist/commands/new-helpers.d.ts +26 -0
  11. package/dist/commands/new-helpers.js +103 -0
  12. package/dist/commands/new-helpers.js.map +1 -0
  13. package/dist/commands/new.d.ts +4 -1
  14. package/dist/commands/new.js +115 -96
  15. package/dist/commands/new.js.map +1 -1
  16. package/dist/commands/release.js +1 -1
  17. package/dist/commands/release.js.map +1 -1
  18. package/dist/commands/start.d.ts +1 -1
  19. package/dist/commands/start.js +105 -43
  20. package/dist/commands/start.js.map +1 -1
  21. package/dist/commands/status.js +3 -0
  22. package/dist/commands/status.js.map +1 -1
  23. package/dist/index.js +5 -3
  24. package/dist/index.js.map +1 -1
  25. package/dist/lib/autolink.d.ts +15 -0
  26. package/dist/lib/autolink.js +39 -0
  27. package/dist/lib/autolink.js.map +1 -0
  28. package/dist/lib/build-helpers.d.ts +3 -3
  29. package/dist/lib/build-helpers.js +54 -60
  30. package/dist/lib/build-helpers.js.map +1 -1
  31. package/dist/lib/build-steps.d.ts +2 -2
  32. package/dist/lib/build-steps.js +30 -3
  33. package/dist/lib/build-steps.js.map +1 -1
  34. package/dist/lib/config.d.ts +14 -0
  35. package/dist/lib/config.js +10 -0
  36. package/dist/lib/config.js.map +1 -1
  37. package/dist/lib/custom-card-renderer.d.ts +2 -0
  38. package/dist/lib/custom-card-renderer.js +58 -0
  39. package/dist/lib/custom-card-renderer.js.map +1 -0
  40. package/dist/lib/custom-types-builder.d.ts +4 -0
  41. package/dist/lib/custom-types-builder.js +37 -0
  42. package/dist/lib/custom-types-builder.js.map +1 -0
  43. package/dist/lib/git-helpers.js +10 -1
  44. package/dist/lib/git-helpers.js.map +1 -1
  45. package/dist/lib/image-dimension-parser.d.ts +11 -0
  46. package/dist/lib/image-dimension-parser.js +127 -0
  47. package/dist/lib/image-dimension-parser.js.map +1 -0
  48. package/dist/lib/image-helpers.d.ts +2 -0
  49. package/dist/lib/image-helpers.js +2 -0
  50. package/dist/lib/image-helpers.js.map +1 -1
  51. package/dist/lib/markdown-processors.d.ts +5 -2
  52. package/dist/lib/markdown-processors.js +9 -7
  53. package/dist/lib/markdown-processors.js.map +1 -1
  54. package/dist/lib/post-template.d.ts +5 -0
  55. package/dist/lib/post-template.js +48 -0
  56. package/dist/lib/post-template.js.map +1 -0
  57. package/dist/lib/session.d.ts +2 -2
  58. package/dist/lib/session.js +29 -1
  59. package/dist/lib/session.js.map +1 -1
  60. package/dist/lib/template-helpers.js +17 -1
  61. package/dist/lib/template-helpers.js.map +1 -1
  62. package/dist/lib/template-types.d.ts +16 -3
  63. package/dist/lib/templates.d.ts +5 -7
  64. package/dist/lib/templates.js +39 -53
  65. package/dist/lib/templates.js.map +1 -1
  66. package/dist/templates/CONTRIBUTING.md +43 -2
  67. package/dist/templates/adr.md +34 -0
  68. package/dist/templates/index.md +5 -4
  69. package/dist/templates/log.md +1 -1
  70. package/dist/templates/steer.txt +14 -1
  71. package/dist/templates/styles.css +32 -0
  72. package/dist/utils/prompt.d.ts +6 -0
  73. package/dist/utils/prompt.js +59 -0
  74. package/dist/utils/prompt.js.map +1 -0
  75. package/package.json +4 -4
  76. package/src/templates/CONTRIBUTING.md +43 -2
  77. package/src/templates/adr.md +34 -0
  78. package/src/templates/index.md +5 -4
  79. package/src/templates/log.md +1 -1
  80. package/src/templates/steer.txt +14 -1
  81. package/src/templates/styles.css +32 -0
@@ -2,7 +2,7 @@
2
2
  # The ticket field should match the ID portion (e.g., LB-34)
3
3
  ticket: {{id}}
4
4
  # The title should be a human-readable description of the work
5
- title: {{title}}
5
+ title: {{yamlTitle}}
6
6
  prompter: "[PROMPTER]"
7
7
  harness: "[HARNESS]"
8
8
  llm: "[LLM]"
@@ -27,9 +27,10 @@ TODO: Write a polished, highly readable ticket summary that reads like an engagi
27
27
 
28
28
  ### Formatting & Style Rules:
29
29
  - **Maintain the narrative tone:** TODO: Keep the storytelling flair (e.g., describing how problems accumulated or how gaps surfaced), but stay strictly factual based on the provided changes.
30
- - **Add thematic headings:** TODO: Break the narrative down into logical chapters using Markdown headings (e.g., ### The Friction Points, ### The Fix, ### Closing the Gap).
31
- - **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.
30
+ - **Add thematic headings:** TODO: Break the narrative down into logical chapters using action-oriented Markdown subheadings that describe what was improved/solved (e.g., ### Improving TabGroup Accessibility, ### Binding Dialog Colors to the Theme) rather than dry, generic headers like "Friction" or "The Fix".
31
+ - **Avoid forced bullet points:** TODO: Write in natural, flowing paragraphs (like in a dev blog post). Only use bullet points for actual, simple lists of items (e.g., list of modified files or configuration options), never to structure or split your main story thoughts.
32
32
  - **Use bold emphasis:** TODO: Bold key concepts, problems, and solutions to guide the reader's eye.
33
33
  - **Format code:** TODO: Use inline backticks for files, plugins, HTML elements, and code snippets (e.g., `src/lib/build-helpers.ts`).
34
- - **Keep paragraphs short:** TODO: Ensure no paragraph is longer than 3-4 sentences. Keep the pacing quick and engaging.
34
+ - **Keep paragraphs short:** TODO: Ensure no paragraph is longer than 4 sentences. Keep the pacing quick and engaging.
35
+ - **Weave the narrative:** TODO: Do not list all friction points in one massive block followed by all fixes/solutions in another. Instead, weave them together chronologically or by component/theme (e.g., describe the friction and its corresponding fix within the same chapter or paragraph).
35
36
  - **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
@@ -1,4 +1,4 @@
1
- # Technical Log: {{id}}-{{slug}}
1
+ # Technical Log: {{id}} - {{title}}
2
2
 
3
3
  > **REMINDER**: Log your work in real-time using `logbook log "<message>"`. Don't wait until the end!
4
4
  >
@@ -33,9 +33,22 @@ You MUST log your work continuously using `logbook log "<message>"`. This is not
33
33
  Phase 3: Synthesize
34
34
  1. When implementation is finished, write the narrative in `index.md`.
35
35
  2. Storytelling Mode: Explain the "Why" and the "Journey." Avoid simple technical bullet points.
36
+ - **Keep paragraphs short**: Max 4 sentences per paragraph to ensure fast-paced, readable prose.
37
+ - **Use bold & code formatting**: Use inline backticks for files/code, and bolding for key terms/problems.
38
+ - **Structure with H3 headings**: Use action-oriented subheadings describing the topic/component modified (e.g., ### Improving TabGroup Accessibility, ### Binding Dialog Colors to the Theme) instead of generic "Friction" or "Fix" headers.
39
+ - **Avoid forced lists**: Write in natural, flowing paragraphs. Only use bullet points for simple lists of items (e.g., files modified, options checked), never to split or structure your core narrative thoughts.
40
+ - **Weave friction & fix**: Do not separate all problems into one block and all solutions into another. Weave them together chronologically or group them by component/theme.
36
41
  3. Clean up all template placeholders and complete the frontmatter (author, summary, dates).
37
42
 
38
43
  Phase 4: Verify
39
44
  1. Run `npm run pre` (which includes `logbook lint` and other quality gates).
40
45
  2. Ensure there are no linter errors, unreplaced placeholders, or architectural violations before concluding your work.
41
- 3. Hand back to the prompter, who will review and run `logbook release`.
46
+ 3. Hand back to the prompter for local QA/review.
47
+
48
+ Phase 5: Local QA & Iterative Refinement
49
+ 1. Expect feedback loops: The prompter will test your changes, challenge decisions, and request refinements.
50
+ 2. In each iteration loop:
51
+ - Log decisions and pivots in `log.md` in real-time (`logbook log "<message>"`).
52
+ - Update the story in `index.md` to reflect any design/code changes.
53
+ - Run verification again (`npm run pre`).
54
+ 3. Optimize the git commit message (conforming to project standards) before final release.
@@ -169,6 +169,38 @@ main {
169
169
  transform: translateX(4px);
170
170
  }
171
171
 
172
+ .teaser-image-right {
173
+ flex-shrink: 0;
174
+ max-width: 200px;
175
+ max-height: 120px;
176
+ display: flex;
177
+ align-items: center;
178
+ justify-content: center;
179
+ overflow: hidden;
180
+ border-radius: 4px;
181
+ }
182
+
183
+ .teaser-image-right img {
184
+ max-width: 100%;
185
+ max-height: 100%;
186
+ object-fit: contain;
187
+ }
188
+
189
+ .teaser-image-bottom {
190
+ margin-top: 0.75rem;
191
+ display: flex;
192
+ justify-content: center;
193
+ align-items: center;
194
+ width: 100%;
195
+ }
196
+
197
+ .teaser-image-bottom img {
198
+ max-width: 100%;
199
+ max-height: 200px;
200
+ object-fit: contain;
201
+ border-radius: 4px;
202
+ }
203
+
172
204
  /* Post Page */
173
205
  .back-link {
174
206
  display: inline-flex;