tickets

5.5 KB

1. // lib/mdview.hl — THE MARKDOWN READ VIEW FOR LLM READERS (ticket #6, mission 014; CONCEPT.md "Data
2. // formats": a Markdown read view for LLM readers). The ticket GET endpoints answer
3. // `Accept: text/markdown` with a compact Markdown document instead of JSON (lib/api-helpers.hl
4. // `wantsMarkdown`, `markdownReply`); JSON stays the default and is unchanged. Statics only.
5. //
6. // one ticket → # <project> #<n>: <subject>
7. // state · opened (by) · updated · formerly · URL
8. // the summary as written (it IS Markdown)
9. // ## History — one `### <seq> · <when> · <author> <what>` per event, its text below
10. // a list → # Tickets (<filters>): <count>
11. // one line per ticket: `- <project> #<n> [<state>] <subject> · updated <when> · <url>`
12. // Texts are embedded as written (they are Markdown already), so a text's own headings sit
13. // inside the document — readers should take the `### <seq> ·` lines as the event boundaries.
14. import { publicUrl } from './users.hl'
16. static NL = "
17. "
19. // one line: line breaks and runs of spaces become one space
20. static oneLine = (s) => {
21. if (s == null) { return '' }
22. parts = []
23. for (w of ('' + s).replaceAll(NL, ' ').split(' ')) { if (w != '') { parts.push(w) } }
24. return parts.join(' ')
25. }
27. // `> ` in front of every line (a previous summary inside an edit event)
28. static quoted = (s) => {
29. out = []
30. for (l of ('' + s).split(NL)) { out.push(l == '' ? '>' : '> ' + l) }
31. return out.join(NL)
32. }
34. static ticketLine = (row) => {
35. return '- ' + row.project + ' ' + row.ref + ' [' + row.state + '] ' + oneLine(row.subject) + ' · updated ' + row.updated + ' · ' + publicUrl + row.href + relationTail(row)
36. }
38. // ---- relations (ticket #4, mission 017) --------------------------------------------------------
39. // one ticket's document gets "Parent:", "Children (k of n done):", "Blocked by:", "Blocks:"
40. // blocks under its URL; a list line gets ` · parent … · children n, k done · blocked by … · blocks …`
41. static refName = (r) => { return r.project + ' ' + r.ref }
42. static refLine = (r) => { return '- ' + refName(r) + ' [' + r.state + '] ' + oneLine(r.subject) + ' · ' + publicUrl + r.href }
43. static confirmedOf = (refs) => {
44. let n = 0
45. for (r of refs) { if (r.state == 'done') { n = n + 1 } }
46. return n
47. }
48. static relationTail = (row) => {
49. parts = []
50. if (row.parent != null) { parts.push('parent ' + refName(row.parent)) }
51. total = row.children.length
52. if (total > 0) { parts.push('children ' + total + (row.allChildrenConfirmed ? ', all done' : ', ' + confirmedOf(row.children) + ' done')) }
53. if (row.blockedBy.length > 0) {
54. bs = []
55. for (r of row.blockedBy) { bs.push(refName(r) + ' [' + r.state + ']') }
56. parts.push('blocked by ' + bs.join(', '))
57. }
58. if (row.blocks.length > 0) {
59. bs = []
60. for (r of row.blocks) { bs.push(refName(r)) }
61. parts.push('blocks ' + bs.join(', '))
62. }
63. return parts.length == 0 ? '' : ' · ' + parts.join(' · ')
64. }
65. static relationLines = (t) => {
66. lines = []
67. if (t.parent != null) {
68. lines.push('')
69. lines.push('Parent: ' + refName(t.parent) + ' [' + t.parent.state + '] ' + oneLine(t.parent.subject) + ' · ' + publicUrl + t.parent.href)
70. }
71. total = t.children.length
72. if (total > 0) {
73. lines.push('')
74. lines.push('Children (' + (t.allChildrenConfirmed ? 'all ' + total + ' done' : confirmedOf(t.children) + ' of ' + total + ' done') + '):')
75. for (r of t.children) { lines.push(refLine(r)) }
76. }
77. if (t.blockedBy.length > 0) {
78. lines.push('')
79. lines.push('Blocked by:')
80. for (r of t.blockedBy) { lines.push(refLine(r)) }
81. }
82. if (t.blocks.length > 0) {
83. lines.push('')
84. lines.push('Blocks:')
85. for (r of t.blocks) { lines.push(refLine(r)) }
86. }
87. return lines
88. }
90. // a list: { tickets } (rows, as the JSON answer) + a label of its filters ('' = all)
91. static listDocument = (rows, filters) => {
92. lines = []
93. lines.push('# Tickets' + (filters != '' ? ' (' + filters + ')' : '') + ': ' + rows.length)
94. lines.push('')
95. for (r of rows) { lines.push(ticketLine(r)) }
96. return lines.join(NL) + NL
97. }
99. static eventHeadline = (e) => {
100. let what = e.label
101. if (e.kind == 'state') { what = 'changed the state: ' + (e.from != '' ? e.from : '?') + ' → ' + e.to }
102. if (e.kind == 'edit') {
103. parts = []
104. if (e.subjectChanged) { parts.push('subject') }
105. if (e.summaryChanged) { parts.push('summary') }
106. what = 'edited the ' + parts.join(' and ')
107. }
108. return '### ' + e.seq + ' · ' + e.when + ' · ' + oneLine(e.author) + ' ' + what
109. }
111. // one ticket: { ticket (row), events (rows, oldest first) } as the JSON answer
112. static ticketDocument = (data) => {
113. t = data.ticket
114. let opener = ''
115. for (e of data.events) { if (e.kind == 'created' && opener == '') { opener = oneLine(e.author) } }
116. lines = []
117. lines.push('# ' + t.project + ' ' + t.ref + ': ' + oneLine(t.subject))
118. lines.push('')
119. let meta = 'state: ' + t.state + ' · opened ' + t.created + (opener != '' ? ' by ' + opener : '') + ' · updated ' + t.updated
120. if (t.hasOld) { meta = meta + ' · formerly ' + t.oldRef }
121. lines.push(meta)
122. lines.push(publicUrl + t.href)
123. for (l of relationLines(t)) { lines.push(l) }
124. lines.push('')
125. lines.push(t.summary != '' ? t.summary : '(no summary)')
126. lines.push('')
127. lines.push('## History')
128. for (e of data.events) {
129. lines.push('')
130. lines.push(eventHeadline(e))
131. if (e.kind == 'edit') {
132. if (e.subjectChanged) {
133. lines.push('')
134. lines.push('Subject before: ' + oneLine(e.oldSubject))
135. }
136. if (e.summaryChanged) {
137. lines.push('')
138. lines.push('Summary before:')
139. lines.push('')
140. lines.push(e.oldSummary != '' ? quoted(e.oldSummary) : '> (empty)')
141. }
142. }
143. if (e.hasText) {
144. lines.push('')
145. lines.push(e.text)
146. }
147. }
148. return lines.join(NL) + NL
149. }