diff --git a/AGENTS.md b/AGENTS.md index 08a92e1..b55b6f1 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -125,9 +125,12 @@ live Atlassian APIs; property-generated ADF trees; the CommonMark spec suite aga `matchEmphasis` transcribes the reference `process_emphasis` line for line, and its closer walk and opener search stay whole: broken into named steps they drift from the algorithm being faithful is the whole point of. -- A readable spelling tried ahead of a general one — the image, the pipe table, a pipe cell — - returns `string | undefined`, never a `Result`: any failure is the fallback signal, and the - general form owns the refusal. Refusing there refuses a document the general form spells. +- A readable spelling tried ahead of a general one — a CommonMark block, the image, the pipe + table, a pipe cell — gives way with `undefined` for every shape it cannot spell, and fails only + where the general form fails on the same node. Refusing there refuses a document the general + form spells, so a refusal the general form does not share belongs in the general form or + nowhere — save the nested list a tight spelling would swallow, whose refusal the + tight-versus-blank answer owns (`todo.md` 2b). - Nothing recurses unbounded: the guards walk iteratively, and blocks, marks and JSON values — an attribute's and a carried node's alike — are all held to 500 levels, so a deep document is a `Result` rather than the stack overflow that waits near 2000. diff --git a/corpus/unspellable/block-local-id.json b/corpus/round-trip/block-nodes/block-local-id.json similarity index 100% rename from corpus/unspellable/block-local-id.json rename to corpus/round-trip/block-nodes/block-local-id.json diff --git a/corpus/round-trip/block-nodes/block-local-id.md b/corpus/round-trip/block-nodes/block-local-id.md new file mode 100644 index 0000000..914cf26 --- /dev/null +++ b/corpus/round-trip/block-nodes/block-local-id.md @@ -0,0 +1,3 @@ +:::paragraph {localId=01a03d5c-9b21-73f4-8e6a-0c47b1d9e2f8} +Every block node in the schema carries one. +::: diff --git a/corpus/round-trip/opaque-carry/code-block-adf.json b/corpus/round-trip/block-nodes/code-block-adf.json similarity index 100% rename from corpus/round-trip/opaque-carry/code-block-adf.json rename to corpus/round-trip/block-nodes/code-block-adf.json diff --git a/corpus/round-trip/block-nodes/code-block-adf.md b/corpus/round-trip/block-nodes/code-block-adf.md new file mode 100644 index 0000000..ac62a01 --- /dev/null +++ b/corpus/round-trip/block-nodes/code-block-adf.md @@ -0,0 +1,13 @@ +:::codeBlock {language=adf} +``` +{ + "type": "blockCard" +} +``` +::: + +:::codeBlock {language=adf} +```` +``` +```` +::: diff --git a/corpus/round-trip/block-nodes/code-block-attributes.json b/corpus/round-trip/block-nodes/code-block-attributes.json new file mode 100644 index 0000000..383c929 --- /dev/null +++ b/corpus/round-trip/block-nodes/code-block-attributes.json @@ -0,0 +1,79 @@ +{ + "content": [ + { + "attrs": { + "hideLineNumbers": true, + "language": "rust", + "localId": "01a0431d-201b-70a7-81fa-8d0072e09eab", + "uniqueId": "4478e39c", + "wrap": true + }, + "content": [ + { + "text": "fn main() {}", + "type": "text" + } + ], + "type": "codeBlock" + }, + { + "attrs": { + "language": "a`b" + }, + "content": [ + { + "text": "x", + "type": "text" + } + ], + "type": "codeBlock" + }, + { + "attrs": { + "language": " sql" + }, + "content": [ + { + "text": "SELECT 1", + "type": "text" + } + ], + "type": "codeBlock" + }, + { + "attrs": { + "language": "adf" + }, + "content": [ + { + "text": "y", + "type": "text" + } + ], + "type": "codeBlock" + }, + { + "attrs": { + "panelType": "info" + }, + "content": [ + { + "attrs": { + "language": "text", + "wrap": true + }, + "content": [ + { + "text": ":::", + "type": "text" + } + ], + "type": "codeBlock" + } + ], + "type": "panel" + } + ], + "type": "doc", + "version": 1 +} diff --git a/corpus/round-trip/block-nodes/code-block-attributes.md b/corpus/round-trip/block-nodes/code-block-attributes.md new file mode 100644 index 0000000..1684d8d --- /dev/null +++ b/corpus/round-trip/block-nodes/code-block-attributes.md @@ -0,0 +1,31 @@ +:::codeBlock {hideLineNumbers=true localId=01a0431d-201b-70a7-81fa-8d0072e09eab uniqueId=4478e39c wrap=true} +```rust +fn main() {} +``` +::: + +:::codeBlock {language="a\u0060b"} +``` +x +``` +::: + +:::codeBlock {language=" sql"} +``` +SELECT 1 +``` +::: + +:::codeBlock {language="\u0026#97;df"} +``` +y +``` +::: + +::::panel info +:::codeBlock {wrap=true} +```text +::: +``` +::: +:::: diff --git a/corpus/unspellable/code-block-empty-language.json b/corpus/round-trip/block-nodes/code-block-empty-language.json similarity index 100% rename from corpus/unspellable/code-block-empty-language.json rename to corpus/round-trip/block-nodes/code-block-empty-language.json diff --git a/corpus/round-trip/block-nodes/code-block-empty-language.md b/corpus/round-trip/block-nodes/code-block-empty-language.md new file mode 100644 index 0000000..7d6da9a --- /dev/null +++ b/corpus/round-trip/block-nodes/code-block-empty-language.md @@ -0,0 +1,5 @@ +:::codeBlock {language=""} +``` +cargo build --release +``` +::: diff --git a/corpus/round-trip/block-nodes/commonmark-blocks.json b/corpus/round-trip/block-nodes/commonmark-blocks.json new file mode 100644 index 0000000..98b4515 --- /dev/null +++ b/corpus/round-trip/block-nodes/commonmark-blocks.json @@ -0,0 +1,145 @@ +{ + "content": [ + { + "attrs": { + "level": 2, + "localId": "01a0431d-2014-737c-a1bf-f9daedab6de3" + }, + "content": [ + { + "text": "Release checklist", + "type": "text" + } + ], + "type": "heading" + }, + { + "content": [ + { + "text": "Centred.", + "type": "text" + } + ], + "marks": [ + { + "attrs": { + "align": "center" + }, + "type": "alignment" + } + ], + "type": "paragraph" + }, + { + "attrs": { + "localId": "01a0431d-2015-737f-afad-33064295ad4f" + }, + "content": [ + { + "attrs": { + "localId": "01a0431d-2016-7abb-823f-c0942934c878" + }, + "content": [ + { + "content": [ + { + "text": "Tag the commit", + "type": "text" + } + ], + "type": "paragraph" + } + ], + "type": "listItem" + }, + { + "content": [ + { + "content": [ + { + "text": "Push the tag", + "type": "text" + } + ], + "type": "paragraph" + } + ], + "type": "listItem" + } + ], + "type": "bulletList" + }, + { + "content": [ + { + "content": [ + { + "content": [ + { + "text": "Loosen the clamp", + "type": "text" + } + ], + "type": "paragraph" + } + ], + "type": "listItem" + } + ], + "type": "orderedList" + }, + { + "content": [ + { + "attrs": { + "localId": "01a0431d-2017-72cf-baf3-8934a54e0582" + }, + "content": [ + { + "text": "Hold the line.", + "type": "text" + } + ], + "type": "paragraph" + } + ], + "type": "blockquote" + }, + { + "content": [ + { + "content": [ + { + "attrs": { + "localId": "01a0431d-2018-7667-a769-ab0037ca80aa" + }, + "content": [ + { + "text": "Indented.", + "type": "text" + } + ], + "type": "paragraph" + } + ], + "type": "listItem" + } + ], + "type": "bulletList" + }, + { + "attrs": { + "localId": "01a0431d-2019-76b7-bf6f-13841363b111" + }, + "type": "rule" + }, + { + "attrs": { + "localId": "01a0431d-201a-7a65-bea7-84b441c85bd6" + }, + "type": "paragraph" + } + ], + "type": "doc", + "version": 1 +} diff --git a/corpus/round-trip/block-nodes/commonmark-blocks.md b/corpus/round-trip/block-nodes/commonmark-blocks.md new file mode 100644 index 0000000..7fc5c32 --- /dev/null +++ b/corpus/round-trip/block-nodes/commonmark-blocks.md @@ -0,0 +1,34 @@ +:::heading {level=2 localId=01a0431d-2014-737c-a1bf-f9daedab6de3} +Release checklist +::: + +:::paragraph {marks="[{\"attrs\":{\"align\":\"center\"},\"type\":\"alignment\"}]"} +Centred. +::: + +::::bulletList {localId=01a0431d-2015-737f-afad-33064295ad4f} +:::listItem {localId=01a0431d-2016-7abb-823f-c0942934c878} +Tag the commit +::: +:::listItem +Push the tag +::: +:::: + +::::orderedList +:::listItem +Loosen the clamp +::: +:::: + +> :::paragraph {localId=01a0431d-2017-72cf-baf3-8934a54e0582} +> Hold the line. +> ::: + +- :::paragraph {localId=01a0431d-2018-7667-a769-ab0037ca80aa} + Indented. + ::: + +::rule {localId=01a0431d-2019-76b7-bf6f-13841363b111} + +::paragraph {localId=01a0431d-201a-7a65-bea7-84b441c85bd6} diff --git a/corpus/round-trip/block-nodes/commonmark-values.json b/corpus/round-trip/block-nodes/commonmark-values.json new file mode 100644 index 0000000..e2c1dbb --- /dev/null +++ b/corpus/round-trip/block-nodes/commonmark-values.json @@ -0,0 +1,77 @@ +{ + "content": [ + { + "attrs": { + "level": 7 + }, + "content": [ + { + "text": "Seventh", + "type": "text" + } + ], + "type": "heading" + }, + { + "content": [ + { + "text": "Levelless", + "type": "text" + } + ], + "type": "heading" + }, + { + "attrs": { + "order": 999999998 + }, + "content": [ + { + "content": [ + { + "content": [ + { + "text": "One", + "type": "text" + } + ], + "type": "paragraph" + } + ], + "type": "listItem" + }, + { + "content": [ + { + "content": [ + { + "text": "Two", + "type": "text" + } + ], + "type": "paragraph" + } + ], + "type": "listItem" + }, + { + "content": [ + { + "content": [ + { + "text": "Three", + "type": "text" + } + ], + "type": "paragraph" + } + ], + "type": "listItem" + } + ], + "type": "orderedList" + } + ], + "type": "doc", + "version": 1 +} diff --git a/corpus/round-trip/block-nodes/commonmark-values.md b/corpus/round-trip/block-nodes/commonmark-values.md new file mode 100644 index 0000000..c7745f2 --- /dev/null +++ b/corpus/round-trip/block-nodes/commonmark-values.md @@ -0,0 +1,19 @@ +:::heading {level=7} +Seventh +::: + +:::heading +Levelless +::: + +::::orderedList {order=999999998} +:::listItem +One +::: +:::listItem +Two +::: +:::listItem +Three +::: +:::: diff --git a/corpus/round-trip/block-nodes/task-list.json b/corpus/round-trip/block-nodes/task-list.json index b0a148f..b1758df 100644 --- a/corpus/round-trip/block-nodes/task-list.json +++ b/corpus/round-trip/block-nodes/task-list.json @@ -75,6 +75,12 @@ } ], "type": "taskItem" + }, + { + "attrs": { + "state": "TODO" + }, + "type": "taskItem" } ], "type": "taskList" diff --git a/corpus/round-trip/block-nodes/task-list.md b/corpus/round-trip/block-nodes/task-list.md index e4f3f22..030cce1 100644 --- a/corpus/round-trip/block-nodes/task-list.md +++ b/corpus/round-trip/block-nodes/task-list.md @@ -14,5 +14,6 @@ Then sign off. :::taskItem TODO {localId=01a033bd-a22d-7fb5-be9d-89d1aa261112} Nested step ::: +::taskItem TODO :::: ::::: diff --git a/corpus/unspellable/ordered-list-start-one.json b/corpus/round-trip/commonmark-subset/ordered-list-start-one.json similarity index 100% rename from corpus/unspellable/ordered-list-start-one.json rename to corpus/round-trip/commonmark-subset/ordered-list-start-one.json diff --git a/corpus/round-trip/commonmark-subset/ordered-list-start-one.md b/corpus/round-trip/commonmark-subset/ordered-list-start-one.md new file mode 100644 index 0000000..2f1e0bf --- /dev/null +++ b/corpus/round-trip/commonmark-subset/ordered-list-start-one.md @@ -0,0 +1 @@ +1. Loosen the clamp diff --git a/corpus/round-trip/inline-nodes/hard-break-attributes.json b/corpus/round-trip/inline-nodes/hard-break-attributes.json new file mode 100644 index 0000000..c81b7ab --- /dev/null +++ b/corpus/round-trip/inline-nodes/hard-break-attributes.json @@ -0,0 +1,44 @@ +{ + "content": [ + { + "content": [ + { + "text": "One", + "type": "text" + }, + { + "attrs": { + "localId": "01a0431d-201e-7400-a175-9c04d3628f95" + }, + "type": "hardBreak" + }, + { + "text": "Two", + "type": "text" + } + ], + "type": "paragraph" + }, + { + "content": [ + { + "text": "Three", + "type": "text" + }, + { + "attrs": { + "text": "\n" + }, + "type": "hardBreak" + }, + { + "text": "Four", + "type": "text" + } + ], + "type": "paragraph" + } + ], + "type": "doc", + "version": 1 +} diff --git a/corpus/round-trip/inline-nodes/hard-break-attributes.md b/corpus/round-trip/inline-nodes/hard-break-attributes.md new file mode 100644 index 0000000..1bcc6f6 --- /dev/null +++ b/corpus/round-trip/inline-nodes/hard-break-attributes.md @@ -0,0 +1,3 @@ +One:hardBreak{localId=01a0431d-201e-7400-a175-9c04d3628f95}Two + +Three:hardBreak{text="\n"}Four diff --git a/corpus/round-trip/opaque-carry/code-block-adf.md b/corpus/round-trip/opaque-carry/code-block-adf.md deleted file mode 100644 index cd39eb0..0000000 --- a/corpus/round-trip/opaque-carry/code-block-adf.md +++ /dev/null @@ -1,29 +0,0 @@ -```adf -{ - "attrs": { - "language": "adf" - }, - "content": [ - { - "text": "{\n \"type\": \"blockCard\"\n}", - "type": "text" - } - ], - "type": "codeBlock" -} -``` - -````adf -{ - "attrs": { - "language": "adf" - }, - "content": [ - { - "text": "```", - "type": "text" - } - ], - "type": "codeBlock" -} -```` diff --git a/corpus/unspellable/block-local-id.error b/corpus/unspellable/block-local-id.error deleted file mode 100644 index b4a73d2..0000000 --- a/corpus/unspellable/block-local-id.error +++ /dev/null @@ -1 +0,0 @@ -unspelled-node-attribute diff --git a/corpus/unspellable/code-block-empty-language.error b/corpus/unspellable/code-block-empty-language.error deleted file mode 100644 index 01daa5e..0000000 --- a/corpus/unspellable/code-block-empty-language.error +++ /dev/null @@ -1 +0,0 @@ -ambiguous-attribute-spelling diff --git a/corpus/unspellable/ordered-list-start-one.error b/corpus/unspellable/ordered-list-start-one.error deleted file mode 100644 index 01daa5e..0000000 --- a/corpus/unspellable/ordered-list-start-one.error +++ /dev/null @@ -1 +0,0 @@ -ambiguous-attribute-spelling diff --git a/package.json b/package.json index 3e0afb0..0d74b30 100644 --- a/package.json +++ b/package.json @@ -13,7 +13,7 @@ "node": ">=24" }, "scripts": { - "test": "node --test --experimental-test-coverage --test-coverage-exclude=\"src/**/*.test.ts\" --test-coverage-branches=95 --test-coverage-functions=100 --test-coverage-lines=100 \"src/**/*.test.ts\"", + "test": "node --test --experimental-test-coverage --test-coverage-exclude=\"src/**/*.test.ts\" --test-coverage-branches=96 --test-coverage-functions=100 --test-coverage-lines=100 \"src/**/*.test.ts\"", "typecheck": "tsc --noEmit" }, "devDependencies": { diff --git a/spec/flavour.md b/spec/flavour.md index 0106017..bcc356e 100644 --- a/spec/flavour.md +++ b/spec/flavour.md @@ -16,10 +16,11 @@ normalizes to it through the round-trip. cannot parse (intra-word). Strike is GFM strikethrough narrowed to exactly two tildes — a single tilde or a run of three or more is literal text — and block structure resolves before inline, so a `~~~` line opens a CommonMark tilde code fence. -- Bullet lists `- `; ordered lists incrementing `1.` `2.` `3.`, the first number taken from the - node's `order` attribute. Continuation lines align with the first character after the marker - (two spaces for `- `, three for `1. `); blank lines inside an item are empty lines, none before - a nested list. Blank lines between items normalize away; ADF does not record tightness. +- Bullet lists `- `; ordered lists incrementing `1.` `2.` `3.`, the first number the node's + `order` attribute. Continuation lines align with the first character after the marker + (two spaces for `- `, three for `1. `); blank lines inside an item are empty lines, none + between a nested list and a CommonMark block above it. Blank lines between items normalize + away; ADF does not record tightness. - Blockquotes prefix lines with `> `; a blank line inside a blockquote is a bare `>`. - ATX headings (`#` … `######`); setext input normalizes to ATX. - Code fences ``` with the node's language as info string, the fence lengthened past any backtick @@ -31,7 +32,8 @@ normalizes to it through the round-trip. inside it, directive syntax and `~~` included. - Thematic break `---`. - Hard break: backslash at end of line (survives editors that trim trailing spaces). Where - CommonMark admits no spelling — the end of a block, inside a heading — it is `:hardBreak{}`. + CommonMark admits no spelling — the end of a block, inside an ATX heading — or where the node + carries an attribute, it is the inline directive. - An empty paragraph — real payloads carry them — is `::paragraph`. - Links `[text](url)`; `<…>` around a destination containing spaces; title in double quotes. `` autolink form only when the text equals the destination and the destination is a valid @@ -84,7 +86,8 @@ fence or opaque carry is content. Canonical form uses minimal lengths. Directive fence lines follow code-fence indentation (up to three spaces relative to their container); trailing whitespace on a fence line is tolerated in input, never emitted. -**Leaf block**: `::name {attrs}` — a block-position node with no body. +**Leaf block**: `::name arg {attrs}` — a block-position node with no body, `arg` reading as +above. **Claiming at block level**, symmetric with inline: a line whose leading run of two or more colons is followed immediately by a name character is claimed and must parse fully as a container @@ -125,8 +128,9 @@ positions canonicalize differently, each fitting where it sits: - **Inline position**: `:adf{json="…"}` — compact serialization (keys sorted, no whitespace), JSON-string-escaped into the attribute. -The info string `adf` is reserved: a genuine `codeBlock` whose `language` is exactly `adf` is -itself emitted through the opaque carry, so the reservation stays absolute and stays lossless. +The info string `adf` is reserved: a genuine `codeBlock` whose `language` is exactly `adf` takes +the attribute the section below keeps for a language no info string holds, so the reservation +stays absolute. In block-directive positions (`::adf`, `:::adf`) the reserved name is a named error — the carry's block form is the fence. @@ -153,14 +157,44 @@ editor-normal ADF reads an empty attrs object, marks array or content array as t Marks on a block node ride the reserved attribute key `marks` — the node's marks array as a `json` value: `::::layoutSection {marks="[{\"attrs\":{\"mode\":\"wide\"},\"type\":\"breakout\"}]"}`. -Three child nodes hold inline content rather than blocks (`caption`, `decisionItem`, -`taskItem`): their body is at most one paragraph, whose inline content becomes the node's -`content`; any other body is a named error. +A section saying its body is inline takes at most one paragraph, whose inline content becomes +the node's `content`; any other body is a named error, and a node holding no content is the leaf. A node the sections cannot spell rides the opaque carry: an attrs key its section does not list, a value that is not the section's type, or an arg-slot value that is no bare token. In markdown input the same mismatch is a named error. +### The CommonMark blocks + +CommonMark spells `blockquote`, `bulletList`, `codeBlock`, `heading`, `listItem`, `orderedList`, +`paragraph` and `rule`, and keeps that spelling wherever it holds what the node carries. What it +cannot — `localId` (string) on any of them, marks, and the values below — takes the directive +form. + +- `blockquote`, `bulletList`, `listItem` — containers, block body; no attributes beyond `localId`. +- `codeBlock` — container, body one fenced code block whose info string is the language and whose + content is the node's. Attributes: `hideLineNumbers` (boolean), `language` (string), `localId`, + `uniqueId` (string), `wrap` (boolean). A language no info string carries back — empty, the + reserved `adf`, or holding a backtick, a backslash, a control character, edge whitespace or an + entity reference — rides the `language` attribute instead and the fence carries no info string; + writing both is a named error. +- `heading` — container, inline body. Attributes: `level` (number), `localId`. `level` is the `#` + count, so a heading carrying none, or one that is no whole number from 1 to 6, has no CommonMark + spelling. +- `orderedList` — container of `listItem`, block body. Attributes: `localId`, `order` (number). + `order` is the first marker, so a list carrying none, one that is no whole number from 0, or one + whose markers would run past 999999999, has no CommonMark spelling. +- `paragraph` — container, inline body; no attributes beyond `localId`. +- `rule` — leaf; no attributes beyond `localId`. + +```` +:::codeBlock {localId=01a03d5c-9b21-73f4-8e6a-0c47b1d9e2f8 wrap=true} +```rust +fn main() {} +``` +::: +```` + ### Panel Container; the arg is `panelType` (`custom` `error` `info` `note` `success` `tip` `warning`). @@ -331,15 +365,16 @@ attributes. The other three share: `extensionKey` (string), `extensionType` (str ## Inline nodes Attributes and the carry fallback read as in the block sections, the carry in its inline form. Of -the nodes below, those with a `text` attribute spell it in the content slot as plain text: `[]` is -the empty string, absent content is the absent attribute, non-empty content parsing to anything -but one unmarked text node — adjacent identical-mark text nodes merged first — is a named -error, and so is a `text` key in `{attrs}`. An enclosing mark spelling does not reach into the -slot. The rest take no content, `:text` included; content on a node that takes none is a named -error. +the nodes below, `emoji`, `mention` and `status` spell their `text` attribute in the content slot +as plain text: `[]` is the empty string, absent content is the absent attribute, non-empty content +parsing to anything but one unmarked text node — adjacent identical-mark text nodes merged first — +is a named error, and so is a `text` key in `{attrs}`. An enclosing mark spelling does not reach +into the slot. The rest take no content, `:text` included; content on a node that takes none is a +named error. - `date` — `localId` (string), `timestamp` (string, epoch milliseconds). - `emoji` — `id` (string), `localId` (string), `shortName` (string, `:name:`), `text` (string). +- `hardBreak` — `localId` (string), `text` (string). - `inlineCard` — `data` (json), `localId` (string), `url` (string); real payloads carry one or the other. - `mediaInline` — `alt` (string), `collection` (string), `data` (json), `height` (number), `id` diff --git a/src/adf-document.ts b/src/adf-document.ts index 0bd22a6..f85ac28 100644 --- a/src/adf-document.ts +++ b/src/adf-document.ts @@ -29,6 +29,11 @@ const documentKeys = ['content', 'type', 'version'] const markKeys = ['attrs', 'type'] const nodeKeys = ['attrs', 'content', 'marks', 'text', 'type'] +export function carriesOnly(node: AdfNode, attributes: readonly string[]): boolean { + if ((node.marks ?? []).length > 0 || node.text !== undefined) return false + return holdsOnly(node.attrs ?? {}, attributes) +} + export function isAdfDocument(value: unknown): value is AdfDocument { if (!isRecord(value) || !holdsOnly(value, documentKeys)) return false if (value['type'] !== 'doc') return false diff --git a/src/adf-to-markdown.test.ts b/src/adf-to-markdown.test.ts index 6a7f150..6774b34 100644 --- a/src/adf-to-markdown.test.ts +++ b/src/adf-to-markdown.test.ts @@ -26,7 +26,7 @@ function path(result: Result): readonly (number | string)[] { } test('names the node a refusal came from', () => { - const unspellable: AdfNode = { attrs: { localId: 'a' }, type: 'paragraph' } + const unspellable: AdfNode = { text: 'x', type: 'paragraph' } const list: AdfNode = { content: [{ content: [paragraph({ text: 'x', type: 'text' })], type: 'listItem' }, { content: [unspellable], type: 'listItem' }], type: 'bulletList' } assert.deepEqual(path(adfToMarkdown(document(paragraph({ text: 'x', type: 'text' }), list))), ['content', 1, 'content', 1, 'content', 0]) assert.deepEqual(path(adfToMarkdown(document(paragraph({ text: 'x', type: 'text' }, { type: 'text' })))), ['content', 0, 'content', 1]) @@ -41,28 +41,37 @@ test('refuses a document version the markdown cannot carry', () => { assert.equal(code(adfToMarkdown({ type: 'doc', version: 2 })), 'unsupported-document-version') }) -test('refuses an attribute the canonical form does not spell', () => { - assert.equal(code(adfToMarkdown(document({ attrs: { localId: 'a' }, type: 'paragraph' }))), 'unspelled-node-attribute') - assert.equal(code(adfToMarkdown(document({ attrs: { wrap: true }, type: 'codeBlock' }))), 'unspelled-node-attribute') - assert.equal(code(adfToMarkdown(document(paragraph({ attrs: { localId: 'a' }, type: 'hardBreak' }, { text: 'x', type: 'text' })))), 'unspelled-node-attribute') +test('carries a text node attribute no spelling holds', () => { + assert.equal( + markdown(adfToMarkdown(document(paragraph({ attrs: { localId: 'a' }, text: 'x', type: 'text' })))), + ':adf{json="{\\"attrs\\":{\\"localId\\":\\"a\\"},\\"text\\":\\"x\\",\\"type\\":\\"text\\"}"}\n', + ) }) -test('refuses marks on a block node', () => { - assert.equal(code(adfToMarkdown(document({ marks: [{ type: 'border' }], type: 'blockquote' }))), 'unspelled-block-marks') +test('spells a CommonMark block as a directive where its own spelling holds neither attribute nor mark', () => { + assert.equal(markdown(adfToMarkdown(document({ attrs: { localId: 'a' }, type: 'paragraph' }))), '::paragraph {localId=a}\n') + assert.equal(markdown(adfToMarkdown(document({ attrs: { wrap: true }, type: 'codeBlock' }))), ':::codeBlock {wrap=true}\n```\n```\n:::\n') + assert.equal(markdown(adfToMarkdown(document(paragraph({ attrs: { localId: 'a' }, type: 'hardBreak' }, { text: 'x', type: 'text' })))), ':hardBreak{localId=a}x\n') + assert.equal(markdown(adfToMarkdown(document({ marks: [{ type: 'border' }], type: 'blockquote' }))), ':::blockquote {marks="[{\\"type\\":\\"border\\"}]"}\n:::\n') + assert.equal(markdown(adfToMarkdown(document({ type: 'listItem' }))), ':::listItem\n:::\n') }) -test('refuses an ordered list whose markdown start is ambiguous', () => { +test('spells an ordered list from the order attribute its first marker is', () => { const items: AdfNode[] = [{ content: [paragraph({ text: 'x', type: 'text' })], type: 'listItem' }] - assert.equal(code(adfToMarkdown(document({ content: items, type: 'orderedList' }))), 'ambiguous-attribute-spelling') - assert.equal(code(adfToMarkdown(document({ attrs: { order: 1 }, content: items, type: 'orderedList' }))), 'ambiguous-attribute-spelling') + assert.equal(markdown(adfToMarkdown(document({ content: items, type: 'orderedList' }))), '::::orderedList\n:::listItem\nx\n:::\n::::\n') + assert.equal(markdown(adfToMarkdown(document({ attrs: { order: 1 }, content: items, type: 'orderedList' }))), '1. x\n') assert.equal(markdown(adfToMarkdown(document({ attrs: { order: 2 }, content: items, type: 'orderedList' }))), '2. x\n') }) -test('refuses the code block info strings the fence cannot hold', () => { - assert.equal(code(adfToMarkdown(document({ attrs: { language: '' }, type: 'codeBlock' }))), 'ambiguous-attribute-spelling') - assert.equal(code(adfToMarkdown(document({ attrs: { language: 'a`b' }, type: 'codeBlock' }))), 'unspellable-code-block-language') - assert.equal(code(adfToMarkdown(document({ attrs: { language: ' sql' }, type: 'codeBlock' }))), 'unspellable-code-block-language') - assert.equal(code(adfToMarkdown(document({ attrs: { language: 'adf' }, type: 'codeBlock' }))), 'unspellable-code-block-language') +test('spells a code block language no info string holds as an attribute', () => { + const language = (value: string): string => markdown(adfToMarkdown(document({ attrs: { language: value }, type: 'codeBlock' }))) + assert.equal(language(''), ':::codeBlock {language=""}\n```\n```\n:::\n') + assert.equal(language('a`b'), ':::codeBlock {language="a\\u0060b"}\n```\n```\n:::\n') + assert.equal(language(' sql'), ':::codeBlock {language=" sql"}\n```\n```\n:::\n') + assert.equal(language('adf'), ':::codeBlock {language="\\u0026#97;df"}\n```\n```\n:::\n') + assert.equal(language('foo\\+bar'), ':::codeBlock {language="foo\\\\+bar"}\n```\n```\n:::\n') + assert.equal(language('a\u0000b'), ':::codeBlock {language="a\\u0000b"}\n```\n```\n:::\n') + assert.equal(language('a\tb'), ':::codeBlock {language="a\\tb"}\n```\n```\n:::\n') }) test('refuses a link destination CommonMark cannot spell', () => { @@ -131,15 +140,11 @@ test('carries a node type no section spells', () => { assert.equal(markdown(adfToMarkdown(document({ type: 'toString' }))), '```adf\n{\n "type": "toString"\n}\n```\n') assert.equal(markdown(adfToMarkdown(document(paragraph({ type: 'blockCard' })))), ':adf{json="{\\"type\\":\\"blockCard\\"}"}\n') assert.equal(markdown(adfToMarkdown(document({ text: 'x', type: 'text' }))), '```adf\n{\n "text": "x",\n "type": "text"\n}\n```\n') - assert.equal(markdown(adfToMarkdown(document({ type: 'listItem' }))), '```adf\n{\n "type": "listItem"\n}\n```\n') assert.equal(markdown(adfToMarkdown(document({ type: 'hardBreak' }))), '```adf\n{\n "type": "hardBreak"\n}\n```\n') }) -test('carries the code block whose language is the reserved info string', () => { - assert.equal( - markdown(adfToMarkdown(document({ attrs: { language: 'adf' }, type: 'codeBlock' }))), - '```adf\n{\n "attrs": {\n "language": "adf"\n },\n "type": "codeBlock"\n}\n```\n', - ) +test('spells the code block whose language is the reserved info string', () => { + assert.equal(markdown(adfToMarkdown(document({ attrs: { language: 'adf' }, type: 'codeBlock' }))), ':::codeBlock {language=adf}\n```\n```\n:::\n') }) test('breaks a mark run at the node it carries', () => { @@ -161,18 +166,21 @@ test('refuses a carried node nested deeper than the emitter carries', () => { test('refuses a node whose content model the canonical form cannot emit', () => { assert.equal(code(adfToMarkdown(document({ content: [paragraph()], type: 'codeBlock' }))), 'unsupported-node-shape') assert.equal(code(adfToMarkdown(document({ content: [{ content: [{ text: 'lost', type: 'text' }], text: 'x', type: 'text' }], type: 'codeBlock' }))), 'unsupported-node-shape') - assert.equal(code(adfToMarkdown(document({ content: [paragraph()], type: 'bulletList' }))), 'unsupported-node-shape') - assert.equal(code(adfToMarkdown(document({ type: 'bulletList' }))), 'unsupported-node-shape') - assert.equal(code(adfToMarkdown(document({ attrs: { order: 2 }, content: [], type: 'orderedList' }))), 'unsupported-node-shape') }) -test('refuses an ordered list no marker spells', () => { +test('spells a list its own content shape cannot hold as a directive', () => { + assert.equal(markdown(adfToMarkdown(document({ content: [paragraph()], type: 'bulletList' }))), ':::bulletList\n::paragraph\n:::\n') + assert.equal(markdown(adfToMarkdown(document({ type: 'bulletList' }))), ':::bulletList\n:::\n') + assert.equal(markdown(adfToMarkdown(document({ attrs: { order: 2 }, content: [], type: 'orderedList' }))), ':::orderedList {order=2}\n:::\n') +}) + +test('spells an ordered list no marker fits as a directive', () => { const item: AdfNode = { content: [paragraph({ text: 'x', type: 'text' })], type: 'listItem' } const list = (order: number, items: number): AdfDocument => document({ attrs: { order }, content: Array.from({ length: items }, () => item), type: 'orderedList' }) - assert.equal(code(adfToMarkdown(list(1.5, 1))), 'unsupported-node-shape') + assert.equal(markdown(adfToMarkdown(list(1.5, 1))), '::::orderedList {order="1.5"}\n:::listItem\nx\n:::\n::::\n') assert.equal(markdown(adfToMarkdown(list(999999999, 1))), '999999999. x\n') - assert.equal(code(adfToMarkdown(list(999999999, 2))), 'unspellable-list-marker') + assert.equal(markdown(adfToMarkdown(list(999999999, 2))), '::::orderedList {order=999999999}\n:::listItem\nx\n:::\n:::listItem\nx\n:::\n::::\n') }) test('carries a code mark over anything but text', () => { @@ -182,9 +190,9 @@ test('carries a code mark over anything but text', () => { ) }) -test('refuses a heading level outside the ATX range', () => { - assert.equal(code(adfToMarkdown(document({ attrs: { level: 7 }, content: [{ text: 'x', type: 'text' }], type: 'heading' }))), 'unsupported-heading-level') - assert.equal(code(adfToMarkdown(document({ content: [{ text: 'x', type: 'text' }], type: 'heading' }))), 'unsupported-heading-level') +test('spells a heading level no ATX heading fits as a directive', () => { + assert.equal(markdown(adfToMarkdown(document({ attrs: { level: 7 }, content: [{ text: 'x', type: 'text' }], type: 'heading' }))), ':::heading {level=7}\nx\n:::\n') + assert.equal(markdown(adfToMarkdown(document({ content: [{ text: 'x', type: 'text' }], type: 'heading' }))), ':::heading\nx\n:::\n') }) test('escapes only text that would otherwise open a construct', () => { @@ -322,12 +330,12 @@ test('escapes a hyphen underline a hard break would expose', () => { assert.equal(line('=='), 'foo\\\n\\==\n') }) -test('refuses a list item whose marker completes a thematic break', () => { +test('spells a list item whose marker completes a thematic break as a directive', () => { const item = (...content: AdfNode[]): AdfNode => ({ content, type: 'listItem' }) - assert.equal(code(adfToMarkdown(document({ content: [item({ type: 'rule' })], type: 'bulletList' }))), 'unspellable-line-start') + assert.equal(markdown(adfToMarkdown(document({ content: [item({ type: 'rule' })], type: 'bulletList' }))), '::::bulletList\n:::listItem\n---\n:::\n::::\n') const nested: AdfNode = { content: [item({ content: [item()], type: 'bulletList' })], type: 'bulletList' } assert.equal(markdown(adfToMarkdown(document(nested))), '- -\n') - assert.equal(code(adfToMarkdown(document({ content: [item(nested)], type: 'bulletList' }))), 'unspellable-line-start') + assert.equal(markdown(adfToMarkdown(document({ content: [item(nested)], type: 'bulletList' }))), '::::bulletList\n:::listItem\n- -\n:::\n::::\n') }) test('refuses the characters CommonMark rewrites', () => { @@ -383,7 +391,8 @@ test('spells a block directive as its node type, arg and attributes', () => { const panel = (attrs: AdfAttributes): AdfDocument => document({ attrs, content: [paragraph({ text: 'x', type: 'text' })], type: 'panel' }) assert.equal(markdown(adfToMarkdown(panel({ panelType: 'warning' }))), ':::panel warning\nx\n:::\n') assert.equal(markdown(adfToMarkdown(panel({}))), ':::panel\nx\n:::\n') - assert.equal(markdown(adfToMarkdown(document({ type: 'caption' }))), ':::caption\n:::\n') + assert.equal(markdown(adfToMarkdown(document({ content: [{ text: 'x', type: 'text' }], type: 'caption' }))), ':::caption\nx\n:::\n') + assert.equal(markdown(adfToMarkdown(document({ type: 'caption' }))), '::caption\n') assert.equal(markdown(adfToMarkdown(document({ attrs: { localId: 'a' }, type: 'syncBlock' }))), '::syncBlock {localId=a}\n') }) @@ -430,9 +439,10 @@ test('separates two directive blocks in a container body by one line, two Common const text = (value: string): AdfNode => ({ content: [{ text: value, type: 'text' }], type: 'paragraph' }) const panel = (...content: AdfNode[]): AdfDocument => document({ attrs: { panelType: 'info' }, content, type: 'panel' }) assert.equal(markdown(adfToMarkdown(panel(text('a'), text('b')))), ':::panel info\na\n\nb\n:::\n') - assert.equal(markdown(adfToMarkdown(panel({ type: 'caption' }, { type: 'caption' }))), '::::panel info\n:::caption\n:::\n:::caption\n:::\n::::\n') - assert.equal(code(adfToMarkdown(panel(text('a'), { type: 'caption' }))), 'unspelled-block-separation') - assert.equal(code(adfToMarkdown(panel({ type: 'caption' }, text('a')))), 'unspelled-block-separation') + const caption: AdfNode = { content: [{ text: 'c', type: 'text' }], type: 'caption' } + assert.equal(markdown(adfToMarkdown(panel(caption, caption))), '::::panel info\n:::caption\nc\n:::\n:::caption\nc\n:::\n::::\n') + assert.equal(code(adfToMarkdown(panel(text('a'), caption))), 'unspelled-block-separation') + assert.equal(code(adfToMarkdown(panel(caption, text('a')))), 'unspelled-block-separation') assert.equal(code(adfToMarkdown(panel(paragraph(), text('a')))), 'unspelled-block-separation') }) @@ -452,6 +462,9 @@ test('spells the image form for exactly the centered external media shape', () = assert.ok(fallback({ alt: 4, type: 'external', url })) assert.ok(fallback({ type: 'external', url: 4 })) assert.equal(code(adfToMarkdown(single({ type: 'external', url }, paragraph()))), 'unsupported-node-shape') + const media: AdfNode = { attrs: { type: 'external', url }, type: 'media' } + assert.equal(code(adfToMarkdown(document({ attrs: { layout: 'center' }, content: [media], text: 'x', type: 'mediaSingle' }))), 'unsupported-node-shape') + assert.equal(code(adfToMarkdown(document({ attrs: { layout: 'center' }, content: [{ ...media, text: 'x' }], type: 'mediaSingle' }))), 'unsupported-node-shape') }) test('spells a mediaSingle the image form does not fit as a directive', () => { @@ -480,7 +493,7 @@ test('spells a table as a pipe table only where every row and cell is plain', () assert.ok(directive(adfToMarkdown(table(cell('tableHeader', text('Part')))))) assert.ok(directive(adfToMarkdown(table(row(cell('tableHeader')))))) assert.ok(directive(adfToMarkdown(table(row(cell('tableHeader', text('a'), text('b'))))))) - assert.equal(code(adfToMarkdown(table(row(cell('tableHeader', { attrs: { localId: 'a' }, type: 'paragraph' }))))), 'unspelled-node-attribute') + assert.ok(directive(adfToMarkdown(table(row(cell('tableHeader', { attrs: { localId: 'a' }, type: 'paragraph' })))))) assert.equal( markdown(adfToMarkdown(table(row(cell('tableHeader', { content: [{ attrs: { url: 'a|b' }, type: 'blockCard' }], type: 'paragraph' }))))), '| :adf{json="{\\"attrs\\":{\\"url\\":\\"a\\u007cb\\"},\\"type\\":\\"blockCard\\"}"} |\n| --- |\n', diff --git a/src/adf-to-markdown.ts b/src/adf-to-markdown.ts index 4fec162..64a89a0 100644 --- a/src/adf-to-markdown.ts +++ b/src/adf-to-markdown.ts @@ -7,8 +7,8 @@ import { emitInlineLine } from './markdown-inline.ts' import { tryPipeTable } from './markdown-pipe-table.ts' import { carriedBlock, carryName } from './opaque-carry.ts' import { failure, success, type ConvertErrorPath, type Result } from './result.ts' -import { holdsEntityReference, holdsNullCharacter, isThematicBreak } from './commonmark-grammar.ts' -import { isAdfDocument } from './adf-document.ts' +import { holdsControlCharacter, holdsEntityReference, holdsNullCharacter, isThematicBreak } from './commonmark-grammar.ts' +import { carriesOnly, isAdfDocument } from './adf-document.ts' import { largestNesting } from './nesting.ts' import { fencedCodeBlock } from './backtick-runs.ts' @@ -54,17 +54,19 @@ function emitBlocks(nodes: readonly AdfNode[], container: BlockContainer, path: } function separationBetween(previous: PlacedBlock, next: PlacedBlock, container: BlockContainer): Result { - if (listTypes.includes(next.node.type) && previous.node.type === next.node.type) { - return failure('unspellable-adjacent-lists', `two adjacent ${next.node.type} nodes read back as one list`, next.path) - } - if (container === 'list-item' && listTypes.includes(next.node.type)) { - if (!interruptsParagraph(next.node)) { - return failure('unspellable-line-start', `a ${next.node.type} that cannot interrupt the block above it has no tight spelling`, next.path) + const plainPair = previous.spelling === 'commonmark' && next.spelling === 'commonmark' + if (plainPair && listTypes.includes(next.node.type)) { + if (previous.node.type === next.node.type) { + return failure('unspellable-adjacent-lists', `two adjacent ${next.node.type} nodes read back as one list`, next.path) + } + if (container === 'list-item') { + if (!interruptsParagraph(next.node)) { + return failure('unspellable-line-start', `a ${next.node.type} that cannot interrupt the block above it has no tight spelling`, next.path) + } + return success('\n') } - return success('\n') } - if (container !== 'directive') return success('\n\n') - if (previous.spelling === 'commonmark' && next.spelling === 'commonmark') return success('\n\n') + if (container !== 'directive' || plainPair) return success('\n\n') if (previous.spelling === 'directive' && next.spelling === 'directive') return success('\n') return failure( 'unspelled-block-separation', @@ -79,19 +81,27 @@ function interruptsParagraph(node: AdfNode): boolean { } function emitBlock(node: AdfNode, path: ConvertErrorPath, depth: number): Result { - if (node.type === 'blockquote') return commonMarkContainer(emitBlockquote(node, path, depth)) - if (node.type === 'bulletList' || node.type === 'orderedList') return commonMarkContainer(emitList(node, path, depth)) - if (node.type === 'codeBlock') return commonMarkLine(emitCodeBlock(node, path)) - if (node.type === 'heading') return commonMarkLine(emitHeading(node, path)) - if (node.type === 'paragraph') return emitParagraph(node, path) - if (node.type === 'rule') return commonMarkLine(emitRule(node, path)) const directive = blockDirective(node.type) - if (directive !== undefined) { - if (node.type === 'mediaSingle') return emitMediaSingle(node, directive, path, depth) - if (node.type === 'table') return emitTable(node, directive, path, depth) - return emitDirectiveBlock(node, directive, path, depth) - } - return commonMarkLine(carriedBlock(node, path)) + if (directive === undefined) return commonMarkLine(carriedBlock(node, path)) + const readable = readableBlock(node, path, depth) + if (readable !== undefined) return readable + return emitDirectiveBlock(node, directive, path, depth) +} + +function readableBlock(node: AdfNode, path: ConvertErrorPath, depth: number): Result | undefined { + if (node.type === 'blockquote') return emitBlockquote(node, path, depth) + if (node.type === 'bulletList' || node.type === 'orderedList') return emitList(node, path, depth) + if (node.type === 'codeBlock') return emitCodeBlock(node, path) + if (node.type === 'heading') return emitHeading(node, path) + if (node.type === 'mediaSingle') return readableText(tryImage(node, path)) + if (node.type === 'paragraph') return emitParagraph(node, path) + if (node.type === 'rule') return emitRule(node) + if (node.type === 'table') return readableText(tryPipeTable(node, path)) + return undefined +} + +function readableText(text: string | undefined): Result | undefined { + return text === undefined ? undefined : success(commonMarkText(text)) } function commonMarkLine(text: Result): Result { @@ -103,18 +113,16 @@ function commonMarkText(text: string): EmittedBlock { return { fenceColons: 0, spelling: 'commonmark', text } } -function commonMarkContainer(body: Result): Result { - if (!body.ok) return body - return success({ ...body.value, spelling: 'commonmark' }) -} - function emitDirectiveBlock(node: AdfNode, directive: BlockDirective, path: ConvertErrorPath, depth: number): Result { if (node.text !== undefined) return failure('unsupported-node-shape', `a ${node.type} carries no text`, path) const content = node.content ?? [] if (directive.body === 'none' && content.length > 0) return failure('unsupported-node-shape', `a ${node.type} holds no content`, path) + if (directive.body === 'code') return emitCodeDirective(node, directive, path) const header = spellDirectiveHeader(node, directive) if (header === undefined) return commonMarkLine(carriedBlock(node, path)) - if (directive.body === 'none') return success({ fenceColons: 2, spelling: 'directive', text: `::${header}` }) + if (directive.body === 'none' || (directive.body === 'inline' && content.length === 0)) { + return success({ fenceColons: 2, spelling: 'directive', text: `::${header}` }) + } const body = directive.body === 'inline' ? emitInlineBody(content, path) : emitBlocks(content, 'directive', path, depth + 1) if (!body.ok) return body const fenceColons = Math.max(3, body.value.fenceColons + 1) @@ -124,42 +132,41 @@ function emitDirectiveBlock(node: AdfNode, directive: BlockDirective, path: Conv } function emitInlineBody(content: readonly AdfNode[], path: ConvertErrorPath): Result { - if (content.length === 0) return success({ fenceColons: 0, text: '' }) const line = emitInlineLine(content, 'paragraph', path) if (!line.ok) return line return success({ fenceColons: 0, text: line.value }) } -function emitMediaSingle(node: AdfNode, directive: BlockDirective, path: ConvertErrorPath, depth: number): Result { - const image = tryImage(node, path) - if (image === undefined) return emitDirectiveBlock(node, directive, path, depth) - return success(commonMarkText(image)) -} - -function emitTable(node: AdfNode, directive: BlockDirective, path: ConvertErrorPath, depth: number): Result { - const pipe = tryPipeTable(node, path) - if (pipe === undefined) return emitDirectiveBlock(node, directive, path, depth) - return success(commonMarkText(pipe)) -} - -function emitBlockquote(node: AdfNode, path: ConvertErrorPath, depth: number): Result { - const validation = validateBlockNode(node, [], path) - if (!validation.ok) return validation +function emitBlockquote(node: AdfNode, path: ConvertErrorPath, depth: number): Result | undefined { + if (!carriesOnly(node, [])) return undefined const inner = emitBlocks(node.content ?? [], 'document', path, depth + 1) if (!inner.ok) return inner const text = inner.value.text .split('\n') .map((line) => (line === '' ? '>' : `> ${line}`)) .join('\n') - return success({ fenceColons: inner.value.fenceColons, text }) + return success({ fenceColons: inner.value.fenceColons, spelling: 'commonmark', text }) } -function emitCodeBlock(node: AdfNode, path: ConvertErrorPath): Result { - if (node.attrs?.['language'] === carryName) return carriedBlock(node, path) - const validation = validateBlockNode(node, ['language'], path) - if (!validation.ok) return validation - const info = spellCodeFenceInfo(node.attrs?.['language'], path) - if (!info.ok) return info +function emitCodeBlock(node: AdfNode, path: ConvertErrorPath): Result | undefined { + if (!carriesOnly(node, ['language'])) return undefined + const info = fenceInfo(node.attrs?.['language']) + if (info === undefined) return undefined + const text = codeBlockText(node, path) + if (!text.ok) return text + return success(commonMarkText(fencedCodeBlock(info, text.value))) +} + +function emitCodeDirective(node: AdfNode, directive: BlockDirective, path: ConvertErrorPath): Result { + const info = fenceInfo(node.attrs?.['language']) + const header = spellDirectiveHeader(node, directive, info === undefined ? [] : ['language']) + if (header === undefined) return commonMarkLine(carriedBlock(node, path)) + const text = codeBlockText(node, path) + if (!text.ok) return text + return success({ fenceColons: 3, spelling: 'directive', text: `:::${header}\n${fencedCodeBlock(info ?? '', text.value)}\n:::` }) +} + +function codeBlockText(node: AdfNode, path: ConvertErrorPath): Result { let text = '' for (const [index, child] of (node.content ?? []).entries()) { const childPath = [...path, 'content', index] @@ -177,113 +184,74 @@ function emitCodeBlock(node: AdfNode, path: ConvertErrorPath): Result { if (holdsNullCharacter(child.text)) return failure('unspellable-character', 'a codeBlock holds a null character CommonMark replaces', childPath) text += child.text } - return success(fencedCodeBlock(info.value, text)) + return success(text) } -function spellCodeFenceInfo(language: JsonValue | undefined, path: ConvertErrorPath): Result { - if (language === undefined) return success('') - if (typeof language !== 'string') return failure('unsupported-node-shape', 'a codeBlock language is no string', path) - if (language === '') { - return failure('ambiguous-attribute-spelling', 'an empty codeBlock language and an absent one share one markdown spelling', path) - } - if (/[`\n\r]/.test(language) || language !== language.trim()) { - return failure('unspellable-code-block-language', 'a fence info string holds no backtick and no edge whitespace', path) - } - if (holdsEntityReference(language)) { - return failure('unspellable-code-block-language', 'a fence info string shaped like an entity reference decodes on the way back', path) - } - return success(language) +// spec/flavour.md, The CommonMark blocks. +function fenceInfo(language: JsonValue | undefined): string | undefined { + if (language === undefined) return '' + if (typeof language !== 'string' || language === '' || language === carryName) return undefined + if (/[`\\]/.test(language) || holdsControlCharacter(language) || language !== language.trim() || holdsEntityReference(language)) return undefined + return language } -function emitHeading(node: AdfNode, path: ConvertErrorPath): Result { - const validation = validateBlockNode(node, ['level'], path) - if (!validation.ok) return validation +function emitHeading(node: AdfNode, path: ConvertErrorPath): Result | undefined { + if (!carriesOnly(node, ['level'])) return undefined const level = node.attrs?.['level'] - if (typeof level !== 'number' || !Number.isInteger(level) || level < 1 || level > 6) { - return failure('unsupported-heading-level', `no ATX heading spells level ${JSON.stringify(level ?? null)}`, path) - } + if (typeof level !== 'number' || !Number.isInteger(level) || level < 1 || level > 6) return undefined const hashes = '#'.repeat(level) const content = node.content ?? [] - if (content.length === 0) return success(hashes) + if (content.length === 0) return success(commonMarkText(hashes)) const line = emitInlineLine(content, 'heading', path) if (!line.ok) return line - return success(`${hashes} ${line.value}`) + return success(commonMarkText(`${hashes} ${line.value}`)) } -function emitList(node: AdfNode, path: ConvertErrorPath, depth: number): Result { +function emitList(node: AdfNode, path: ConvertErrorPath, depth: number): Result | undefined { const ordered = node.type === 'orderedList' - const validation = validateBlockNode(node, ordered ? ['order'] : [], path) - if (!validation.ok) return validation + if (!carriesOnly(node, ordered ? ['order'] : [])) return undefined const items = node.content ?? [] - const start = listStart(node, items.length, path) - if (!start.ok) return start + const start = listStart(node, items.length) + if (start === undefined || items.length === 0) return undefined + if (items.some((item) => item.type !== 'listItem' || !carriesOnly(item, []))) return undefined const lines: string[] = [] let fenceColons = 0 for (const [offset, item] of items.entries()) { - const itemPath = [...path, 'content', offset] - if (item.type !== 'listItem') return failure('unsupported-node-shape', `a ${node.type} holds listItem nodes only`, itemPath) - const emitted = emitListItem(item, ordered ? `${start.value + offset}. ` : '- ', itemPath, depth) + const emitted = emitListItem(item, ordered ? `${start + offset}. ` : '- ', [...path, 'content', offset], depth) + if (emitted === undefined) return undefined if (!emitted.ok) return emitted fenceColons = Math.max(fenceColons, emitted.value.fenceColons) lines.push(emitted.value.text) } - return success({ fenceColons, text: lines.join('\n') }) + return success({ fenceColons, spelling: 'commonmark', text: lines.join('\n') }) } -function listStart(node: AdfNode, items: number, path: ConvertErrorPath): Result { - if (items === 0) return failure('unsupported-node-shape', `a ${node.type} holds at least one listItem`, path) - if (node.type !== 'orderedList') return success(0) +function listStart(node: AdfNode, items: number): number | undefined { + if (node.type !== 'orderedList') return 0 const start = node.attrs?.['order'] - if (start === undefined || start === 1) { - return failure('ambiguous-attribute-spelling', 'an orderedList starting at 1 and one with no order share one markdown spelling', path) - } - if (typeof start !== 'number' || !Number.isInteger(start) || start < 0 || start > largestListMarker) { - return failure('unsupported-node-shape', `no list marker spells the order ${JSON.stringify(start)}`, path) - } - if (start + items - 1 > largestListMarker) { - return failure('unspellable-list-marker', `no list marker spells the ${items} items a list starting at ${start} needs`, path) - } - return success(start) + if (typeof start !== 'number' || !Number.isInteger(start) || start < 0 || start > largestListMarker) return undefined + return start + items - 1 > largestListMarker ? undefined : start } -function emitListItem(item: AdfNode, marker: string, path: ConvertErrorPath, depth: number): Result { - const validation = validateBlockNode(item, [], path) - if (!validation.ok) return validation +function emitListItem(item: AdfNode, marker: string, path: ConvertErrorPath, depth: number): Result | undefined { const inner = emitBlocks(item.content ?? [], 'list-item', path, depth + 1) if (!inner.ok) return inner if (inner.value.text === '') return success({ fenceColons: 0, text: marker.trimEnd() }) const indent = ' '.repeat(marker.length) const lines = inner.value.text.split('\n').map((line, index) => (index === 0 ? `${marker}${line}` : line === '' ? '' : `${indent}${line}`)) - const first = lines[0] ?? '' - if (isThematicBreak(first)) { - return failure('unspellable-line-start', `block parsing would claim the emitted line ${JSON.stringify(first)}`, path) - } + if (isThematicBreak(lines[0] ?? '')) return undefined return success({ fenceColons: inner.value.fenceColons, text: lines.join('\n') }) } -function emitParagraph(node: AdfNode, path: ConvertErrorPath): Result { - const validation = validateBlockNode(node, [], path) - if (!validation.ok) return validation +function emitParagraph(node: AdfNode, path: ConvertErrorPath): Result | undefined { const content = node.content ?? [] - if (content.length === 0) return success({ fenceColons: 2, spelling: 'directive', text: '::paragraph' }) - return commonMarkLine(emitInlineLine(content, 'paragraph', path)) + if (content.length === 0 || !carriesOnly(node, [])) return undefined + const line = emitInlineLine(content, 'paragraph', path) + if (!line.ok) return line + return success(commonMarkText(line.value)) } -function emitRule(node: AdfNode, path: ConvertErrorPath): Result { - const validation = validateBlockNode(node, [], path) - if (!validation.ok) return validation - if ((node.content ?? []).length > 0) return failure('unsupported-node-shape', 'a rule holds no content', path) - return success('---') -} - -function validateBlockNode(node: AdfNode, spelled: readonly string[], path: ConvertErrorPath): Result { - if ((node.marks ?? []).length > 0) { - return failure('unspelled-block-marks', `the canonical form has no place for the marks a ${node.type} carries`, path) - } - if (node.text !== undefined) return failure('unsupported-node-shape', `a ${node.type} carries no text`, path) - const unspelled = Object.keys(node.attrs ?? {}).find((key) => !spelled.includes(key)) - if (unspelled !== undefined) { - return failure('unspelled-node-attribute', `the ${node.type} attribute ${unspelled} has no canonical markdown spelling`, path) - } - return success(null) +function emitRule(node: AdfNode): Result | undefined { + if (!carriesOnly(node, []) || (node.content ?? []).length > 0) return undefined + return success(commonMarkText('---')) } diff --git a/src/block-directives.ts b/src/block-directives.ts index 934ebbd..817689e 100644 --- a/src/block-directives.ts +++ b/src/block-directives.ts @@ -5,7 +5,7 @@ import { isBareToken, spellAttributes, spellJsonAttribute, vocabularyPairs } fro export type BlockDirective = { argument?: string attributes: AttributeVocabulary - body: 'block' | 'inline' | 'none' + body: 'block' | 'code' | 'inline' | 'none' } const cellAttributes: AttributeVocabulary = { @@ -28,7 +28,7 @@ const extensionAttributes: AttributeVocabulary = { text: 'string', } -const itemAttributes: AttributeVocabulary = { localId: 'string' } +const localIdAttributes: AttributeVocabulary = { localId: 'string' } const mediaAttributes: AttributeVocabulary = { alt: 'string', @@ -45,44 +45,56 @@ const mediaAttributes: AttributeVocabulary = { const syncBlockAttributes: AttributeVocabulary = { localId: 'string', resourceId: 'string' } const blockDirectives: Readonly> = { - blockTaskItem: { argument: 'state', attributes: itemAttributes, body: 'block' }, + blockTaskItem: { argument: 'state', attributes: localIdAttributes, body: 'block' }, + blockquote: { attributes: localIdAttributes, body: 'block' }, bodiedExtension: { attributes: extensionAttributes, body: 'block' }, bodiedSyncBlock: { attributes: syncBlockAttributes, body: 'block' }, - caption: { attributes: itemAttributes, body: 'inline' }, + bulletList: { attributes: localIdAttributes, body: 'block' }, + caption: { attributes: localIdAttributes, body: 'inline' }, + codeBlock: { + attributes: { hideLineNumbers: 'boolean', language: 'string', localId: 'string', uniqueId: 'string', wrap: 'boolean' }, + body: 'code', + }, decisionItem: { attributes: { localId: 'string', state: 'string' }, body: 'inline' }, - decisionList: { attributes: itemAttributes, body: 'block' }, + decisionList: { attributes: localIdAttributes, body: 'block' }, expand: { attributes: expandAttributes, body: 'block' }, extension: { attributes: extensionAttributes, body: 'none' }, extensionFrame: { attributes: {}, body: 'block' }, + heading: { attributes: { level: 'number', localId: 'string' }, body: 'inline' }, layoutColumn: { attributes: { localId: 'string', valign: 'string', width: 'number' }, body: 'block' }, - layoutSection: { attributes: itemAttributes, body: 'block' }, + layoutSection: { attributes: localIdAttributes, body: 'block' }, + listItem: { attributes: localIdAttributes, body: 'block' }, media: { attributes: mediaAttributes, body: 'none' }, mediaGroup: { attributes: {}, body: 'block' }, mediaSingle: { attributes: { layout: 'string', localId: 'string', width: 'number', widthType: 'string' }, body: 'block' }, multiBodiedExtension: { attributes: extensionAttributes, body: 'block' }, nestedExpand: { attributes: expandAttributes, body: 'block' }, + orderedList: { attributes: { localId: 'string', order: 'number' }, body: 'block' }, panel: { argument: 'panelType', attributes: { localId: 'string', panelColor: 'string', panelIcon: 'string', panelIconId: 'string', panelIconText: 'string' }, body: 'block', }, + paragraph: { attributes: localIdAttributes, body: 'inline' }, + rule: { attributes: localIdAttributes, body: 'none' }, syncBlock: { attributes: syncBlockAttributes, body: 'none' }, table: { attributes: { displayMode: 'string', isNumberColumnEnabled: 'boolean', layout: 'string', localId: 'string', width: 'number' }, body: 'block' }, tableCell: { attributes: cellAttributes, body: 'block' }, tableHeader: { attributes: cellAttributes, body: 'block' }, - tableRow: { attributes: itemAttributes, body: 'block' }, - taskItem: { argument: 'state', attributes: itemAttributes, body: 'inline' }, - taskList: { attributes: itemAttributes, body: 'block' }, + tableRow: { attributes: localIdAttributes, body: 'block' }, + taskItem: { argument: 'state', attributes: localIdAttributes, body: 'inline' }, + taskList: { attributes: localIdAttributes, body: 'block' }, } export function blockDirective(type: string): BlockDirective | undefined { return Object.hasOwn(blockDirectives, type) ? blockDirectives[type] : undefined } -export function spellDirectiveHeader(node: AdfNode, directive: BlockDirective): string | undefined { +export function spellDirectiveHeader(node: AdfNode, directive: BlockDirective, spelledByBody: readonly string[] = []): string | undefined { const argument = spellArgument(node, directive) if (argument === undefined) return undefined - const pairs = vocabularyPairs(node.attrs ?? {}, directive.attributes, directive.argument) + const spelled = directive.argument === undefined ? spelledByBody : [directive.argument, ...spelledByBody] + const pairs = vocabularyPairs(node.attrs ?? {}, directive.attributes, spelled) if (pairs === undefined) return undefined const marks = node.marks ?? [] if (marks.length > 0) pairs.push(['marks', spellJsonAttribute(markValues(marks))]) diff --git a/src/directive-attributes.ts b/src/directive-attributes.ts index 53a8988..b93492d 100644 --- a/src/directive-attributes.ts +++ b/src/directive-attributes.ts @@ -11,10 +11,10 @@ export function isBareToken(text: string): boolean { return bareToken.test(text) } -export function vocabularyPairs(attrs: AdfAttributes, vocabulary: AttributeVocabulary, slot: string | undefined): [string, string][] | undefined { +export function vocabularyPairs(attrs: AdfAttributes, vocabulary: AttributeVocabulary, spelledElsewhere: readonly string[]): [string, string][] | undefined { const pairs: [string, string][] = [] for (const [key, value] of Object.entries(attrs)) { - if (key === slot) continue + if (spelledElsewhere.includes(key)) continue const kind = Object.hasOwn(vocabulary, key) ? vocabulary[key] : undefined if (kind === undefined) return undefined const spelled = spellAttributeValue(value, kind) diff --git a/src/inline-directives.ts b/src/inline-directives.ts index d18c258..eaad116 100644 --- a/src/inline-directives.ts +++ b/src/inline-directives.ts @@ -13,6 +13,7 @@ export type MarkSpelling = const inlineDirectives: Readonly> = { date: { attributes: { localId: 'string', timestamp: 'string' } }, emoji: { attributes: { id: 'string', localId: 'string', shortName: 'string' }, slot: 'text' }, + hardBreak: { attributes: { localId: 'string', text: 'string' } }, inlineCard: { attributes: { data: 'json', localId: 'string', url: 'string' } }, mediaInline: { attributes: { @@ -52,11 +53,11 @@ export function markSpelling(type: string): MarkSpelling | undefined { } export function spellInlineNodeAttributes(node: AdfNode, directive: InlineDirective): string | undefined { - const pairs = vocabularyPairs(node.attrs ?? {}, directive.attributes, directive.slot) + const pairs = vocabularyPairs(node.attrs ?? {}, directive.attributes, directive.slot === undefined ? [] : [directive.slot]) return pairs === undefined ? undefined : spellAttributes(pairs) } export function spellMarkAttributes(mark: AdfMark, vocabulary: AttributeVocabulary): string | undefined { - const pairs = vocabularyPairs(mark.attrs ?? {}, vocabulary, undefined) + const pairs = vocabularyPairs(mark.attrs ?? {}, vocabulary, []) return pairs === undefined ? undefined : spellAttributes(pairs) } diff --git a/src/markdown-image.ts b/src/markdown-image.ts index 77b7cd8..1eaf509 100644 --- a/src/markdown-image.ts +++ b/src/markdown-image.ts @@ -1,4 +1,5 @@ import type { AdfNode } from './adf-document.ts' +import { carriesOnly } from './adf-document.ts' import type { ConvertErrorPath } from './result.ts' import { serializeCanonicalJson } from './canonical-json.ts' import { tryImageLine } from './markdown-inline.ts' @@ -15,12 +16,12 @@ export function tryImage(node: AdfNode, path: ConvertErrorPath): string | undefi function imageShape(node: AdfNode): { alt: string | undefined; url: string } | undefined { const content = node.content ?? [] const media = content[0] - if (serializeCanonicalJson(node.attrs ?? {}, 'compact') !== centeredMediaSingle || (node.marks ?? []).length > 0) return undefined - if (media === undefined || content.length !== 1 || media.type !== 'media' || (media.marks ?? []).length > 0 || (media.content ?? []).length > 0) return undefined + if (!carriesOnly(node, ['layout']) || serializeCanonicalJson(node.attrs ?? {}, 'compact') !== centeredMediaSingle) return undefined + if (media === undefined || content.length !== 1 || media.type !== 'media' || !carriesOnly(media, imageAttributes) || (media.content ?? []).length > 0) return undefined const attrs = media.attrs ?? {} const alt = attrs['alt'] const url = attrs['url'] - if (Object.keys(attrs).some((key) => !imageAttributes.includes(key)) || attrs['type'] !== 'external' || typeof url !== 'string') return undefined + if (attrs['type'] !== 'external' || typeof url !== 'string') return undefined if (alt !== undefined && (typeof alt !== 'string' || alt === '')) return undefined return { alt, url } } diff --git a/src/markdown-inline.ts b/src/markdown-inline.ts index d6b2fa6..b1bdea8 100644 --- a/src/markdown-inline.ts +++ b/src/markdown-inline.ts @@ -174,7 +174,7 @@ function nodePath(context: InlineContext, index: number): ConvertErrorPath { function carries(node: AdfNode, carried: ReadonlySet, index: number): boolean { if (carried.has(index)) return true - return node.type !== 'hardBreak' && node.type !== 'text' && inlineDirective(node.type) === undefined + return node.type !== 'text' && inlineDirective(node.type) === undefined } function emitLeaf(node: AdfNode, context: InlineContext, index: number): Result { @@ -187,18 +187,18 @@ function emitLeaf(node: AdfNode, context: InlineContext, index: number): Result< const types = (node.marks ?? []).map((mark) => mark.type) if (new Set(types).size !== types.length) return failure('unsupported-node-shape', `a ${node.type} node carries one mark type twice`, path) const directive = inlineDirective(node.type) - if (directive !== undefined) return emitInlineDirective(node, directive, index, path) - if (node.type === 'hardBreak') return emitHardBreak(node, context, path) - return emitText(node, context, path) + if (directive === undefined) return emitText(node, context, index, path) + if (node.type === 'hardBreak') return emitHardBreak(node, directive, context, index, path) + return emitInlineDirective(node, directive, index, path) } -function emitHardBreak(node: AdfNode, context: InlineContext, path: ConvertErrorPath): Result { - const unspelled = Object.keys(node.attrs ?? {})[0] - if (unspelled !== undefined) return failure('unspelled-node-attribute', `the hardBreak attribute ${unspelled} has no canonical markdown spelling`, path) +function emitHardBreak(node: AdfNode, directive: InlineDirective, context: InlineContext, index: number, path: ConvertErrorPath): Result { const empty = refuseContentAndText(node, path) if (!empty.ok) return empty - if (context.spansLines && !context.atBlockEnd) return success({ segments: [syntax('\\\n')] }) - return success({ segments: [syntax(spellLeafDirective('hardBreak', ''))] }) + const attributes = spellInlineNodeAttributes(node, directive) + if (attributes === undefined) return success({ carry: { first: index, last: index } }) + if (attributes === '' && context.spansLines && !context.atBlockEnd) return success({ segments: [syntax('\\\n')] }) + return success({ segments: [syntax(spellLeafDirective('hardBreak', attributes))] }) } function emitInlineDirective(node: AdfNode, directive: InlineDirective, index: number, path: ConvertErrorPath): Result { @@ -215,9 +215,8 @@ function emitInlineDirective(node: AdfNode, directive: InlineDirective, index: n return success({ segments: [syntax(`:${node.type}[`), ...content, syntax(`]${attributes}`)] }) } -function emitText(node: AdfNode, context: InlineContext, path: ConvertErrorPath): Result { - const unspelled = Object.keys(node.attrs ?? {})[0] - if (unspelled !== undefined) return failure('unspelled-node-attribute', `the text attribute ${unspelled} has no canonical markdown spelling`, path) +function emitText(node: AdfNode, context: InlineContext, index: number, path: ConvertErrorPath): Result { + if (Object.keys(node.attrs ?? {}).length > 0) return success({ carry: { first: index, last: index } }) if (typeof node.text !== 'string' || node.text === '') return failure('unsupported-node-shape', 'a text node holds text', path) if ((node.content ?? []).length > 0) return failure('unsupported-node-shape', 'a text node holds no content', path) if (/\r/.test(node.text)) return failure('unspellable-whitespace', 'a text node holds a carriage return CommonMark rewrites', path) diff --git a/src/markdown-pipe-table.ts b/src/markdown-pipe-table.ts index 0487fbc..8756a69 100644 --- a/src/markdown-pipe-table.ts +++ b/src/markdown-pipe-table.ts @@ -1,4 +1,5 @@ import type { AdfNode } from './adf-document.ts' +import { carriesOnly } from './adf-document.ts' import { tryPipeCell } from './markdown-inline.ts' import type { ConvertErrorPath } from './result.ts' @@ -23,16 +24,16 @@ export function tryPipeTable(node: AdfNode, path: ConvertErrorPath): string | un function pipeRows(node: AdfNode): AdfNode[][] | undefined { const rows = node.content ?? [] const columns = (rows[0]?.content ?? []).length - if (!isPlain(node) || columns === 0) return undefined + if (!carriesOnly(node, []) || columns === 0) return undefined const grid: AdfNode[][] = [] for (const [index, row] of rows.entries()) { const cells = row.content ?? [] - if (row.type !== 'tableRow' || !isPlain(row) || cells.length !== columns) return undefined + if (row.type !== 'tableRow' || !carriesOnly(row, []) || cells.length !== columns) return undefined const wanted = index === 0 ? 'tableHeader' : 'tableCell' const paragraphs: AdfNode[] = [] for (const cell of cells) { const paragraph = plainParagraph(cell) - if (paragraph === undefined || cell.type !== wanted || !isPlain(cell)) return undefined + if (paragraph === undefined || cell.type !== wanted || !carriesOnly(cell, [])) return undefined paragraphs.push(paragraph) } grid.push(paragraphs) @@ -40,13 +41,9 @@ function pipeRows(node: AdfNode): AdfNode[][] | undefined { return grid } -function isPlain(node: AdfNode): boolean { - return Object.keys(node.attrs ?? {}).length === 0 && (node.marks ?? []).length === 0 && node.text === undefined -} - function plainParagraph(cell: AdfNode): AdfNode | undefined { const content = cell.content ?? [] const paragraph = content[0] - if (paragraph === undefined || content.length !== 1 || paragraph.type !== 'paragraph' || !isPlain(paragraph)) return undefined + if (paragraph === undefined || content.length !== 1 || paragraph.type !== 'paragraph' || !carriesOnly(paragraph, [])) return undefined return paragraph } diff --git a/src/result.ts b/src/result.ts index 533c8e2..6c705a9 100644 --- a/src/result.ts +++ b/src/result.ts @@ -1,19 +1,13 @@ export type ConvertErrorCode = - | 'ambiguous-attribute-spelling' | 'not-an-adf-document' | 'unspellable-adjacent-lists' | 'unspellable-character' - | 'unspellable-code-block-language' | 'unspellable-line-start' | 'unspellable-link-destination' | 'unspellable-link-title' - | 'unspellable-list-marker' | 'unspellable-whitespace' - | 'unspelled-block-marks' | 'unspelled-block-separation' - | 'unspelled-node-attribute' | 'unsupported-document-version' - | 'unsupported-heading-level' | 'unsupported-node-shape' export type ConvertErrorPath = readonly (number | string)[] diff --git a/todo.md b/todo.md index 9039eb1..e9f975f 100644 --- a/todo.md +++ b/todo.md @@ -55,7 +55,7 @@ detail is settled at its own milestone. - [x] **1d3 — Inline nodes and marks**: date, emoji, inlineCard, mediaInline, mention, status; border, subsup, textColor, underline; the content slot's `text` attribute and the `:text{text="…"}` whitespace spelling. -- [ ] **2 — `adfToMarkdown`.** First real code. Each sub-item turns one corpus directory green; +- [x] **2 — `adfToMarkdown`.** First real code. Each sub-item turns one corpus directory green; the two that have no fixtures yet write them in the same chunk, tests first (§10). - [x] **2a — The runner and the CommonMark subset.** The corpus runner: walk `corpus/round-trip/`, assert `adfToMarkdown` emits each `.md` byte for byte. Decide here @@ -65,7 +65,10 @@ detail is settled at its own milestone. the inline carry. `commonmark-subset/` green. - [x] **2b — Block nodes.** `block-nodes/` green. A nested list that cannot interrupt the block above it is refused meanwhile, not spelled: the maintainer's answer on tight-versus-blank - separation turns that refusal into an emission. Block separation becomes + separation turns that refusal into an emission. The test is broader than the name it + carries — `interruptsParagraph` reads the next list alone, so a list after a block no + paragraph continues, a code block say, is refused too — and the same answer narrows it. + Block separation becomes `separationBetween(previous, next, container)` here — a boolean cannot hold the third case `spec/flavour.md` states for two directive blocks in a container body, and the maintainer's answer on a CommonMark block beside a directive block (1d) drops into the same seam. Give @@ -82,7 +85,7 @@ detail is settled at its own milestone. info string, and the `codeBlock` whose language is `adf` — carried whole ahead of the attribute fallback 2e owes, since the reservation leaves that node no other spelling whatever 1d decides for its `localId`. - - [ ] **2e — Carve-outs and combinations.** Fixtures and emitter together, into + - [x] **2e — Carve-outs and combinations.** Fixtures and emitter together, into `corpus/round-trip/combinations/`. - [x] **2e1 — The carve-outs and the claimed line.** The three carve-outs and their escapes, and a paragraph line inside a container body shaped like a closing @@ -124,7 +127,7 @@ detail is settled at its own milestone. both ways keeps every delimiter the emitter did not write out of the matching. The canonical form gained a backslash where a run only closes — `\*not emphasis\*`, and 2e1's `carve-out-strike` a third and fourth. - - [ ] **2f — The attributes CommonMark cannot hold.** 1d's settled answer: the block nodes + - [x] **2f — The attributes CommonMark cannot hold.** 1d's settled answer: the block nodes CommonMark spells — `blockquote`, `bulletList`, `codeBlock`, `heading`, `listItem`, `orderedList`, `paragraph`, `rule` — get directive sections in `spec/flavour.md` carrying `localId`, `codeBlock`'s `hideLineNumbers`, `uniqueId` and `wrap`, and `blockquote`'s @@ -134,6 +137,23 @@ detail is settled at its own milestone. page of carried JSON. Fixtures and emitter together, and the three documents the answer settles leave `corpus/unspellable/` as round-trip pairs: `block-local-id`, `code-block-empty-language`, `ordered-list-start-one`. + **Settled** (the maintainer, 2026-08-27): the `codeBlock` directive's body is one fenced + code block, the language staying on the fence line so every renderer still highlights it; + a language no info string holds — empty, a backtick, edge whitespace, an entity reference + or the reserved `adf` — rides the `language` attribute with the fence bare, which retires + 2d's carry for the reserved name along with the premise that left it no other spelling. + The plain spelling gives way wherever it cannot render what the node carries rather than + only where it has no place for it, so a heading level absent or outside 1-6 and an order + whose markers would run past 999999999 take the directive form too, and + `ambiguous-attribute-spelling`, `unspellable-code-block-language`, + `unspellable-list-marker`, `unspelled-block-marks` and `unsupported-heading-level` leave + `ConvertErrorCode`; content and placement refusals stay, which leaves the directive form + spelling an empty list or a non-`listItem` child that the plain form refuses. `order` is + the first marker, so `order: 1` keeps the plain `1.` — what a real payload carries — and a + list carrying no `order` has no number to take and takes the directive form. + 2f raises what 1d's unspelled block separation costs: a single `localId` on a paragraph + beside a plain one now refuses every container body that is a directive's — a panel, an + expand, a table cell — where before 2f the attribute refused the document anyway. - [ ] **3 — `markdownToAdf`.** The CommonMark parser is the largest single component; split it into sub-items before starting (§15). Fixtures land with the code that reads them: `corpus/normalization/` (setext, indented code, loose lists, `*`/`+` bullets, entity