3
0
mirror of https://github.com/larvit/adf-codec.git synced 2026-11-20 07:05:44 +01:00

Answer product-owner round 1: 0 🔴, 4 🟡 (0 misread); list the breaking change on its own, name what to build, and cover the readers

This commit is contained in:
2026-11-04 20:30:08 +01:00
committed by Lillem4n
parent deae360969
commit 9460f18f6f
3 changed files with 22 additions and 17 deletions
+8 -8
View File
@@ -12,14 +12,9 @@ also skips every other node Atlassian's schema withholds the mark from:
| a code span inside any mark's spelling but a link's (``**`npm ci`**``) | the code text holds the mark | the code text holds only `code`, and a link where one wraps it |
| text inside `!adf:border[…]` (`!adf:border[x]{color="#091e42" size=2}`) | the text holds `border` | the text holds none, and where nothing the spelling wraps takes `border`, `unsupported-node-shape`: delete the spelling and keep its text. Only a `mediaInline` takes `border` |
`adfToLosslessMarkdown` and `adfToPortableMarkdown` no longer write an `inlineCard` a link marks:
`0.3.0` refuses it as `unsupported-node-shape` at the card's path, as does `adfToHtml`, since
Atlassian's schema gives a card no link mark. Remove the link mark from the card, or wrap the card's
text in the link yourself.
`0.3.0`'s `adfToLosslessMarkdown` writes a node holding a withheld mark as `!adf:carry{json="…"}`,
where `0.2.0` wrote these spellings. `0.3.0` reads markdown stored from such a document without the
mark, and refuses it where the mark wrapped only those nodes. Keep the mark only in markdown
`0.3.0`'s `adfToLosslessMarkdown` writes a node holding a withheld mark as `!adf:carry{json="…"}`
(an `inlineCard`'s link excepted, below), where `0.2.0` wrote these spellings. `0.3.0` reads
markdown stored from such a document without the mark, and refuses it where the mark wrapped only those nodes. Keep the mark only in markdown
written from ADF that held it: Atlassian's schema withholds it, so a site may refuse the document.
To keep it, read the markdown with `0.2.0` and write it with `0.3.0`, installed side by side:
@@ -27,6 +22,11 @@ To keep it, read the markdown with `0.2.0` and write it with `0.3.0`, installed
npm install @larvit/adf-codec@0.3.0 adf-codec-0.2@npm:@larvit/adf-codec@0.2.0
```
That recipe cannot keep a link on an `inlineCard`: `0.3.0` refuses it as `unsupported-node-shape`,
the error's `path` naming the card, since Atlassian's schema gives a card no link mark. Remove the
`link` mark from that card before you write it with `0.3.0`; to keep the link's target, put the
link on a `text` node beside the card.
## From `0.1.0` to `0.2.0`
Each call names the markdown it reads or writes: