3
0
mirror of https://github.com/larvit/adf-codec.git synced 2026-11-19 06:35:44 +01:00

Delete the unreached task-marker paragraph in taskBlocks; check the README error tables against the codes

This commit is contained in:
2026-11-09 08:21:46 +01:00
committed by Lillem4n
parent 2b0e23f90e
commit 32e295eff8
5 changed files with 59 additions and 21 deletions
@@ -158,6 +158,30 @@ test('spells a task list as a bullet list whose items lead with their state', ()
assert.equal(portable(node('taskList', {}, task('DONE', 'a'), node('taskList', {}, task('TODO', '')))), '- [x] a\n - [ ]\n')
})
test('leaves a block task item only when it opens with a paragraph', () => {
const task = (state: string, value: string): AdfNode => node('taskItem', { state }, text(value))
const blockTask = (...content: AdfNode[]): AdfNode => node('blockTaskItem', { state: 'TODO' }, ...content)
const codeBlock: AdfNode = { content: [text('x')], type: 'codeBlock' }
const nested = node('taskList', {}, task('TODO', 'n'))
const lists = [
node('taskList', {}, blockTask(said('a'), said('b')), blockTask(codeBlock, said('c')), blockTask(bulletList(item(said('d'))), said('e'))),
node('taskList', {}, blockTask(nested, said('f')), blockTask(said('g'), codeBlock, said('h')), blockTask(), blockTask(said('i'))),
node('taskList', {}, blockTask(said('j'), nested, said('k'), nested), blockTask(said('l'), said('m'), nested)),
]
const reduced = reduceToPortable(document(...lists))
assert.ok(reduced.ok)
const pending = [...(reduced.value.content ?? [])]
let blockTasks = 0
for (let at = pending.pop(); at !== undefined; at = pending.pop()) {
for (const child of at.content ?? []) pending.push(child)
if (at.type !== 'blockTaskItem') continue
blockTasks += 1
assert.equal(at.content?.[0]?.type, 'paragraph')
assert.ok((at.content ?? []).filter((child) => child.type === 'paragraph').length >= 2)
}
assert.equal(blockTasks, 2)
})
test('spells a decision list as a plain bullet list', () => {
assert.equal(portable(node('decisionList', {}, node('decisionItem', { state: 'DECIDED' }, text('Ship')), said('Stray'))), '- Ship\n- Stray\n')
})
+3 -5
View File
@@ -65,19 +65,17 @@ function placedBlock(node: AdfNode, path: ConvertErrorPath, depth: number, writi
return block.ok ? success({ blocks: [{ ...block.value, node }], headroom: block.value.headroom }) : block
}
// The marker leads the first paragraph, or stands as one where the blocks open with another.
// A block task item reaches here holding two or more paragraphs, so the marker leads the first (`itemParts` in task-list.ts).
function taskBlocks(task: AdfNode, path: ConvertErrorPath, depth: number, writing: Writing): Result<PlacedBlocks> {
const marker = taskMarker(nodeAttrs(task)['state'])
const markerBlock: PlacedBlock = { node: { type: 'paragraph' }, spelling: 'commonmark', text: blockText(marker) }
if (task.type === 'taskItem') {
const content = nodeContent(task)
const line = content.length === 0 ? success('') : emitInlineLine(content, 'paragraph', path, writing.flavour)
if (!line.ok) return line
return success({ blocks: [{ ...markerBlock, text: blockText(line.value === '' ? marker : `${marker} ${line.value}`) }], headroom: Number.POSITIVE_INFINITY })
return success({ blocks: [{ node: { type: 'paragraph' }, spelling: 'commonmark', text: blockText(line.value === '' ? marker : `${marker} ${line.value}`) }], headroom: Number.POSITIVE_INFINITY })
}
const walk = walkBlocks(nodeContent(task), path, depth, writing)
if (!walk.ok) return walk
const [first, ...rest] = walk.value.blocks
const blocks = first?.node.type === 'paragraph' ? [{ ...first, text: prefixedText(`${marker} `, '', first.text) }, ...rest] : [markerBlock, ...walk.value.blocks]
const blocks = walk.value.blocks.map((block, index) => (index === 0 ? { ...block, text: prefixedText(`${marker} `, '', block.text) } : block))
return success({ blocks, headroom: walk.value.headroom })
}
+15
View File
@@ -1,4 +1,7 @@
import assert from 'node:assert/strict'
import { dirname, join } from 'node:path'
import { fileURLToPath } from 'node:url'
import { readFileSync } from 'node:fs'
import test from 'node:test'
import type { AdfDocument, AdfMark } from './adf/document.ts'
@@ -44,3 +47,15 @@ for (const [code, cause] of Object.entries(causes)) {
assert.equal(!result.ok && result.error.code, code)
})
}
// A code added or removed must reach the README's tables, which are the contract a consumer switches on.
test('the README error tables list exactly the codes ConvertErrorCode holds', () => {
const readme = readFileSync(join(dirname(fileURLToPath(import.meta.url)), '..', 'README.md'), 'utf8')
const section = readme.slice(readme.indexOf('\n## The errors\n'))
const listed = new Set<string>()
for (const line of section.slice(1, section.indexOf('\n## ', 1)).split('\n')) {
const code = /^\| `([a-z-]+)` \|/.exec(line)?.[1]
if (code !== undefined) listed.add(code)
}
assert.deepEqual([...listed].sort(), Object.keys(causes).sort())
})