# todo ## Scoring `Score = 100 * V / (2**S + 8)` `Bar = 0.1` `Next ID = 168` ## Items | ID | Release | Blocked by | Exempt | Item | L | E | I | R | S | Moves | Score | |---|---|---|---|---|---|---|---|---|---|---|---| | 164 | 0.3.0 | | | **Publish a feature table setting chosen corpus examples beside what each call writes for them, readable at a glance by people and parseable by LLMs, and kept current by the gate.** | 3 | 2 | 1 | 4 | 5 | 3 by 6, 6 by 4 | 6.2 | | 165 | 0.3.0 | 164 | | **Have a reader panel seated from `## Audience` judge each feature-table row reasonable or not, and file an item for each row it rejects.** | 2 | 2 | 1 | 3 | 3 | 6 by 5 | 7.5 | | 132 | 0.3.0 | | | **Write tables as `
`; a cell's span, width and background in HTML attributes or `data-*`, as a
writer panel picks.
### 73. Announce the package where someone needing an ADF converter already reads: JRACLOUD-77436, the Atlassian developer community and Stack Overflow's ADF-to-markdown questions.
Blocked by every other `0.3.0` item (the maintainer, 2026-10-14): the posts announce the finished
release. Before posting, set `converter-comparison/run.sh`'s pins to each package's latest version,
`@larvit/adf-codec@0.3.0` included, and `--before` to today, run it, and bring the README
comparison table's versions and date in step.
Venues found 2026-10-28, each a thread a reply answers today: on the developer community, topics
96176, 99408, 82496, 100699, 101278, 86214 and 96638; on GitHub, `atlassian/atlassian-mcp-server`
issues 60 and 161. Finding Stack Overflow's ADF-to-markdown questions is part of this item.
We draft each post for the place it goes. Each opens with the asker's problem and how the package
solves it, then links the GitHub repository, the README's comparison table and the README's
opening. The maintainer posts them once `0.3.0` is published (`docs/decisions.md` §Posts
announcing a release wait for its publish). Found while planning discoverability, 2026-10-04.
### 167. Refuse in `refusedShape` the schema-forbidden shapes `adfToLosslessMarkdown` refuses in its walk, and drop them from that writer.
The maintainer's call, 2026-11-04 (`docs/decisions.md` §Schema refusals are made in the first step
alone): the first step holds every schema check, "moved there from wherever else in the code they
are". It replaces item 68, which would have carried these shapes. Move into `refusedShape`:
- `emitDirectiveBlock` in `emit/adf-to-markdown.ts`: a block holding `text`, and a leaf block
holding `content`.
- `emitLeaf` in `emit/inline-line.ts`: a non-text inline node holding `content` or `text`.
Atlassian's schema gives each such node no `text` or `content` (`additionalProperties` is false).
Breaking: `adfToHtml` and `adfToPortableMarkdown` refuse these shapes too, and so does
`adfToLosslessMarkdown` inside a node that rides the carry, where it writes them today. Both carry
readers refuse them too, so a stored markdown or HTML document whose carry holds one stops
reading; `MIGRATION.md` says to convert it once with the last version that reads it. Say so in
`CHANGELOG.md` and `MIGRATION.md`. Search the writers for any other refusal of a shape the schema
forbids, and `carriedNode` for one the readers still build.
The aim is the same behaviour in and out, with the checks alike in every format. The breaking
change above is what "alike" costs: `refusedShape` takes no format, so it cannot spare a node that
only one writer carries. The maintainer accepted it (2026-11-04); the item adds no other refusal.
Stays where it is: a node holding one mark type twice (the schema allows it, no spelling holds it),
nesting depth, output length, a portable task list holding what no list item spells, and a
reader's refusal of markdown or HTML it cannot read. A node type, mark or attribute the schema does
not name, a known node out of place and a mark a node cannot hold keep riding the carry. Drop the
refused shapes from the README's `unsupported-node-shape` cause under writing in
`adfToLosslessMarkdown` and add them to the cause common to the writers, and from `spec/flavour.md`;
the property generators build none of them.
### 72. Re-create `gitea.larvit.se/larvit/adf-codec` as a read-only pull mirror of GitHub, its issues and Actions off and its description pointing at GitHub.
Blocked by every other `0.3.0` item but 73 (the maintainer, 2026-10-05; moved to `0.3.0` 2026-10-28,
since the copy, not marked a mirror, reads as the package's origin). The maintainer does this. Gitea
cannot convert an existing repository to a mirror, so the copy is deleted and re-created. That drops
the copy's commit hashes from before the 2026-10-04 history rewrite, and its Actions secrets. The
Gitea copy holds no issues or releases to move. Actions stay off on the mirror: Gitea runs
`.github/workflows/` when `.gitea/workflows/` is absent, and the mirrored `publish` job would
otherwise run there. When this lands, the `docs/decisions.md` entry "GitHub is canonical" loses its
interim sentence.
### 153. Decide whether `src/markdown/` root may import `emit/`, `parse/` or `portable/`, and hold the answer in `.oxlintrc.json` and §The source parts by ADF and format.
The writers read each escaped line back through `src/markdown/inline-content.ts`'s scan. A writer
question put back on that scan's path, such as the opening-link consult `parseInlineContent` takes
as an argument today, would close the cycle writer → reader → writer and recurse without bound on
a paragraph opening with a spellable `!adf:link` (§Nothing recurses unbounded). The override for
`src/markdown/**` bans only `html/`; banning `emit/`, `parse/` and `portable/` for the root's own
files, with its `ci.sh` probe, extends the decision.
### 156. Stop a leg's container when its script is interrupted, so Ctrl-C ends `ci.sh` or `mutation-tests/run.sh` at once.
`in_image` runs `sh -c` as the container's process 1, which ignores the SIGINT `docker run`
forwards, so the container runs to its end: a `sleep 30` outlived Ctrl-C by 30 s. `--init` would
forward it. Found by the product-owner review of item 152, 2026-10-28.
### 128. Pin the portable flavour's block reading and writing with tests: callout titles past one line, a link beside other marks in a title, the nesting limit of callouts and task lists, refusals inside tasks and their paths, and empty or non-paragraph tasks.
Mutation testing left about 40 mutants alive in code moved verbatim into `src/markdown/portable/`
on 2026-10-22, so the gaps predate the move: `tryTaskList` and `taskBlocks` in `src/markdown/portable/block-spelling.ts`, and
`markerLine`, `quoteReader`, `titleText`, `taskBlocks` and `readTaskBlock` in
`src/markdown/portable/portable-markdown-to-adf.ts`. Each test takes its expected value from
`spec/flavour.md` or `docs/decisions.md`, never from the code.
### 75. Make the generated-markdown property write block carries as `adf:` fences, canonical and hostile.
`blockCarry` and `hostileBlockCarry` (`src/conformance/markdown-property.test.ts`) write a fence
whose info string is `carry`. Under the `docs/decisions.md` entry "The carry fence names the node
type", that is an ordinary code language, so the property reaches `readCarriedBlock`'s refusals only
where a random edit lands in a canonical document. Write `adf:`, as `htmlToAdf` reads it (`docs/decisions.md` §Foreign HTML sorts three ways). A writer panel picks the rest. ### 46. Publish the bundle size in the README, failing the release pipeline when it drifts. The HTML items change the size. The quantity is what a consumer downloads and loads: the tarball `npm pack` produces, its unpacked `dist`, and the built JavaScript minified + gzipped — the figure the competitors advertise (marklassian's "12kb") and the only apples-to-apples one, since ours ships tsc's unminified output and no minifier yet (decide here whether to minify for the build or report the unminified gzip). The figure lands in README §The package beside the "no runtime dependencies" claim, and in a size column of the comparison table. Measured today, unminified: tarball 60.4 kB, unpacked 221.5 kB, JS gzipped 45.6 kB. ### 51. Match a reference label to its definition under Unicode case folding. `link-syntax.ts` normalizes a label with `toLowerCase`, so `[ẞ]` misses its `[SS]` definition (spec example 540). Fold with Unicode's full case folding, `CaseFolding.txt`'s C and F mappings, shipped as data per §Standards ship as data: lowercasing and then uppercasing would also merge `ı` with `I`, which folding keeps apart, so add that pair as a fixture. Breaking: `MIGRATION.md`'s Readings table gains its row. Its `pending` exceptions go, and the README's guarantees drop the case-folding exception and count one fewer. ### 148. Ship conversion between ADF and Jira wiki markup both ways, under a README goal for wiki markup. Jira's REST API v2 and its changelogs carry wiki markup, and Atlassian's `WikiMarkupTransformer` is the only converter; community threads report its round-trip losing expands, layouts and some marks. Add the goal to the README's `## Goals` in the same change. Split into items before starting. The maintainer, 2026-10-28: ship what exists first, so this waits for 0.4.0. ### 149. Read any HTML into ADF, in a call or option a developer panel picks, under a README goal for foreign HTML. `htmlToAdf` reads only what `adfToHtml` writes. The most asked need on the Atlassian developer community is HTML from emails, CMSs and editors into ADF. The maintainer, 2026-10-28: reading foreign HTML is a separate goal, added to the README in this change. Before building, a panel of the developer personas picks the API among those the goals allow: a parameter on `htmlToAdf` or a separate call; Goal 8's "nothing to configure" and Goal 6.1's naming bear on the choice. Split into items once the API is picked. ### 77. Read the input once into a plain copy, so an accessor property or a throwing Proxy yields `not-an-adf-document` and every call returns a result. Lands with item 45, in one chunk: item 45's reader returns the copy. The maintainer's call, 2026-10-04: Goal 1 promises a result for any value, getters and Proxies included. Today the guards and the conversions read the caller's object many times, so a throwing getter, a revoked Proxy or a getter minting a fresh child per access throws or walks forever. Item 45's reader copies the document once inside one tight `try/catch`, reading property descriptors so no getter runs: an accessor property, or a Proxy trap that throws, is `not-an-adf-document`. The copy keeps own enumerable keys, as `JSON.stringify` does, so an inherited or non-enumerable key drops. The reader reads arrays by index, so no custom iterator runs. Every later step works on the copy. A Proxy can still claim unbounded width, which the 500-level limit does not cover, so the copy reads at most 10 million JSON values, each object, array, string, number, boolean and null counting one (the maintainer, 2026-10-05): roughly 50 to 100 MB of JSON, far past any real page, where 10 000 would refuse a 500-row table. Before reading an array, the reader checks its `length` against the values left, so a Proxy claiming 2³² elements is refused at once. The chunk asks whether that refusal shares the 500-level guard's `unsupported-nesting-depth` or takes another code. Found by the technical-principles audit, 2026-10-04. ### 107. Spell the block carry's JSON so its length stays linear in the node's JSON. The block carry indents two spaces a level, so about 1 MB of deeply nested arrays in a carried node's JSON spells past V8's longest string, which the writers refuse as `unsupported-node-shape`; the inline carry's compact JSON would fit. docs/decisions.md §The code list calls a refusal no spelling recovers from a gap in the flavour. Respelling the carry changes the format (§The formats are API). Found by the README-goals audit of item 83, 2026-10-11. ### 42. Trim a text leaf's trailing blanks in linear time. `portable/inline-reduction.ts`'s `leafEdges` finds the trail with an unanchored `/[ \t]*$/`, quadratic in a run of blanks inside one leaf: a paragraph of `a`, 80 000 spaces, `b` takes 6.5 s in `adfToPortableMarkdown`. Scan backward, as the expand title's trim does. ### 31. Make the branch-coverage figure repeat across runs of an unchanged tree. Three Node test legs over one unchanged tree reported `emit/inline-line.ts` at 95.83%, 96.23% and 96.23%, and the total at 98.80%, 98.84% and 98.84% (2026-09-21). `--experimental-test-coverage` counts branches off V8's own coverage, which the runner's parallel files and V8's optimization make run-dependent, so the number the floor is read against is not the code's alone. The floor of 98 holds today on 0.8 points of slack and `docs/decisions.md` §The coverage floors says it only ever moves upward, so the first raise to the measured figure reddens a run that changed nothing. Make the measurement repeatable, or state the number the floor may be raised to and why it is not the measured one. ### 57. Make each `ci.sh` leg build what it reads, so one leg run alone tests the current tree. Technical principle "Compose, do not entangle": Deno, Bun and the tests read the install leg's `node_modules`, the floor and consumer legs the pack leg's, and the browser leg whatever `dist/` the build leg left, so a leg run alone can pass on stale output. ### 38. Spell a lone surrogate in a text node so it survives a UTF-8 encode. `adfToLosslessMarkdown` emits it verbatim, so markdown stored as UTF-8 reads back U+FFFD; attribute values already escape it. ### 76. State the files the package does not ship once, so the build, the lint ceiling, the coverage exclusions and the mutation run cannot drift apart. Technical principle DRY: the set is written in `tsconfig.build.json`'s `exclude`, `.oxlintrc.json`'s `ignorePatterns` and the `test` script's two `--test-coverage-exclude` flags, and §The size ratchet assumes they agree. A helper added to one list lints test code under the shipped ceiling, or drops shipped code from coverage, silently. Derive the others from one, or assert in a test that they agree. Found by the technical-principles audit, 2026-10-04. `mutation-tests/run.sh`'s pathspec restates the test files and test helpers, and `mutation-tests/stryker.config.mjs`'s `testFiles` the test files, so a helper missing from the pathspec has its mutants read as survivors. Found by the architecture review of item 152, 2026-10-28. ### 56. Give each piece of `blocks.ts`'s block-walk state and `inline-content.ts`'s `Scan` one owner that returns what it changes. Technical principle "One owner per value": the `Walk` record passes through functions that mutate it and return `void`; `walk.leaf` alone is written in seven places, and `openedList` reads the `endedLists` that `closeLeaf` fills. `ContainerStack` in the same file shows the shape to follow. `inline-content.ts`'s `Scan` has the same shape: about fifteen functions write `pending`, `pieces`, `brackets`, `linkOpenersFrom` and `openingSpellableLink` on the `Scan` they are handed, most of them returning `void`, and `parseInlineContent` reads a flag `scanInline` leaves on it. The same shape recurs in `mintTaskIds` (`portable/task-ids.ts`), which writes `attrs` on the document `readDocument` built; `takeFallback` (`emit/inline-line.ts`), which writes the record the next `lineSegments` pass reads; `writeUnpaired`, `markPairings` and `markHighlights` (`inline-content.ts`), whose order changes the output. Once `Scan`'s pieces have owners, the bracket resolution — `linkedAlt` through `linkTo`, `holdsLink`, and `closeBracket` through `altText` — can leave `inline-content.ts` (about 690 lines) for a module of its own. ### 118. Spell a portable link's title through `oneLine`. `portableLink` (`src/markdown/portable/inline-reduction.ts`) repeats `oneLine`'s replacements by hand, so a change to what a portable line drops would miss link titles. Technical principle: DRY. Found by the principles audit of item 99, 2026-10-14. ### 82. Give the directive tests and fixtures random UUID v7 ids in place of `a-1`, `a`, `x` and `h`. Technical principle: tests use random UUID v7 ids; `portable-markdown-to-adf.test.ts` already does. Found by the technical-principles audit of item 78, 2026-10-05. ### 58. Port `ci.sh`, `publish.sh`, `docker-runner.sh` and `mutation-tests/run.sh` to standalone Python scripts. Technical principle "Prefer a standalone Python script over a shell script": `AGENTS.md` §3 teaches bash footguns (`&&` chaining under `||`, `tee /dev/stderr`) the port removes. A wrong line range in `run.sh` mutates the wrong lines without failing, so the port tests how it reads diff hunks. ### 34. Read emphasis flanking by the whole character beside an astral symbol. Check whether `delimiterRunToken` (`inline-tokens.ts`) and `resolveEmphasis` (`line-escaping.ts`) read one UTF-16 unit beside an astral symbol. A lone surrogate is neither punctuation nor symbol, but CommonMark reads `😀` as punctuation. Where they do, read the code point, with a fixture per direction. ### 74. Keep the release path publishing after npm retires bypass-2FA tokens. Lands after 2027-01-01, or after a release run fails on the token, whichever comes first: the maintainer chose on 2026-10-02 to wait and see whether the retirement bites. It holds back no release: when the rest of its release is done, it moves to the next. `0.1.0` published only once the npm token carried **Bypass 2FA**: the account requiring no 2FA on writes was not enough, and npm answered `EOTP` until the token itself bypassed. npm retires bypass-2FA tokens for direct publishing around January 2027, leaving them `npm stage publish`, which a maintainer approves with 2FA. Trusted publishing over OIDC replaces the token, and GitHub-hosted Actions support it. The release has run there since 2026-10-04, still with the organization's `NPM_TOKEN`: the maintainer chose to keep the token for now. The trade is the maintainer's: move `publish.sh` to trusted publishing, or to the staged publish, which fits badly with publish-on-merge. Its Moves cell is empty: no README goal covers the release path. ### 8. Ship a CLI. Its Moves cell is empty: no README goal or persona covers a CLI yet. The chunk proposes both (the maintainer, 2026-10-02), and they land in the README's `## Goals` and `## Audience` with the CLI. ### 139. Ship the calls between markdown and HTML, composed through ADF and each named by its flavour. Waits until a consumer needs it. Which flavours get a composed call is this item's to settle; the CommonMark spec suite runs against the one reading CommonMark, checked against the spec's expected HTML. Where a composed call naming a markdown `Flavour` sits is this item's to settle. ### 137. Read foreign HTML in `htmlToAdf` the three ways `docs/decisions.md` §Foreign HTML sorts three ways states. Waits until a consumer needs `htmlToAdf` to read HTML that `adfToHtml` did not write. ### 138. Read raw HTML in every markdown reader through `htmlToAdf`'s foreign-element mapping, in place of refusing it as `unmappable-html`. Waits until a consumer needs it. The change touches `inline-content.ts` and `markdown-to-adf.ts`, places the comprehension seats found hard; leave each place it touches easier to read. |
|---|