# todo ## Scoring `Score = -R - S/4 + 2*A + 2*G*W` `Bar = 9` `Next ID = 105` | Goal | W | |---|---| | 1 | 1.00 | | 2 | 0.89 | | 3 | 0.78 | | 4 | 0.67 | | 5 | 0.56 | | 6 | 0.44 | | 6.1 | 0.44 | | 7 | 0.33 | | 8 | 0.22 | | 9 | 0.11 | ## Items | ID | Release | Exempt | Item | R | S | A | G | Goals | Score | |---|---|---|---|---|---|---|---|---|---| | 83 | 0.2.0 | defect | **Refuse a document whose markdown would pass the engine's string limit with a result, never a `RangeError`.** | 3 | 4 | 5 | 8 | 1, 9 | 22.0 | | 103 | 0.2.0 | | **Fold `unspellable-whitespace` into `unsupported-node-shape`, so a line ending and a null character in a content slot take one code.** | 2 | 2 | 5 | 6 | 1 | 19.5 | | 84 | 0.2.0 | | **Read GFM's pipe table without leading pipes, and with alignment colons, in `portableMarkdownToAdf`, dropping the alignment.** | 3 | 4 | 7 | 7 | 4, 7 | 19.4 | | 104 | 0.2.0 | | **Make the README describe 0.2.0 alone: `code` stable within a minor before 1.0, no HTML call before it ships, and no corpus file named.** | 1 | 2 | 5 | 5 | 3 | 16.3 | | 52 | 0.2.0 | | **Spell `colwidth` as a comma list, `colwidth="340,420"`.** | 3 | 3 | 5 | 6 | 6 | 11.5 | | 53 | 0.2.0 | | **Put a block's `marks` spelling to the writer panel and adopt its pick.** | 4 | 5 | 5 | 6 | 6 | 10.0 | | 89 | 0.2.1 | | **Build a `date`, `emoji`, `inlineCard`, `mention` or `status` holding no mark Atlassian's schema withholds from it, in every reader.** | 4 | 4 | 5 | 6 | 4 | 13.0 | | 99 | 0.2.1 | defect | **Write a linked external image standing inline or in a table cell in the spelling a reader panel picks, in `adfToPortableMarkdown`.** | 3 | 3 | 6 | 7 | 7 | 12.9 | | 100 | 0.2.1 | decision | **Put the reading of an image's title as its caption back to a reader panel, now that a writer panel reads a title as hover text.** | 3 | 3 | 4 | 5 | 4, 6 | 10.9 | | 60 | 0.2.1 | decision | **Collect the questions `parse/` asks `emit/` into one named module.** | 3 | 4 | 2 | 6 | 2 | 10.7 | | 59 | 0.2.1 | decision | **Group the directive grammar into `src/markdown/directive/`, move `Read` to `result.ts`, and move `Flavour` and `flavourClaims` to `markdown/flavour.ts`.** | 3 | 5 | 2 | 6 | 2 | 10.4 | | 62 | 0.2.1 | decision | **Move the portable flavour's reading out of `parse/` and its writing out of `emit/` into `markdown/portable/`, so `emit/` no longer imports `portable/`.** | 4 | 5 | 2 | 6 | 2 | 9.4 | | 96 | 0.2.1 | defect | **Read and write a text holding many unclosed backtick runs, or many `` is quadratic, in the reader and the emitter's escape walk alike. commonmark.js avoids the backtick cost by caching backtick runs by length. ### 101. Name the CommonMark spelling to write in the refusal of a directive whose node CommonMark spells. `directiveNode` (`src/markdown/parse/markdown-to-adf.ts`) refuses `!adf:mediaSingle` holding a linked image as `unsupported-node-shape`: "mediaSingle takes the CommonMark spelling, not the directive form". README §The errors says to fix what the message names, and the message names no spelling, here `[![alt](url)](href "title")`. ### 92. Lower the reading cost of the files a chunk reads most before its first commit. The last five chunks' median is 168135 new input tokens before their first commit, the five before them 97329. Files read most over the last five chunks, counting opens and searches: `docs/decisions.md` 28, `README.md` 27, `todo.md` 26, `CHANGELOG.md` 20, `src/markdown/parse/blocks.ts` 15, `src/markdown/portable/adf-to-portable-markdown.ts` 12, `spec/flavour.md` 10, `src/markdown/parse/portable-markdown-to-adf.test.ts` 10, `src/markdown/emit/line-escaping.ts` 9, `src/markdown/parse/markdown-to-adf.test.ts` 8. ### 33. Emit a line in time linear in its mark runs, in `adfToLosslessMarkdown` and `adfToPortableMarkdown`. `adfToLosslessMarkdown` spends 28 s on one paragraph of 2000 × `un` plus `**-r**`: each run its flanking cannot spell re-emits the whole line before riding the carry, quadratic in the runs, and the portable reduction's `spellableLine` drops one mark per re-emit the same way. An inline node whose attributes no spelling writes re-emits the line the same way before riding the carry. Make all three linear. ### 98. Read blank lines inside deeply nested list items in time linear in the markdown. `matchContainers` in `src/markdown/parse/blocks.ts` continues every open item holding a block on each blank line, and `parseBlocks` holds no depth guard: `readBlocks` refuses past 500 levels only after the walk. `'- '.repeat(n) + 'a\n' + '\n'.repeat(n)` took 675 ms at n = 5000, 2.7 s at 10000 and 10.7 s at 20000 (60 kB) before refusing as `unsupported-nesting-depth`. `docs/decisions.md` §Cost fixes are measured, never timed says the 500-level guard bounds `continuesContainer`'s re-scan in depth; the guard runs only after the walk, so it bounds nothing. Correct that entry with the fix. ### 102. Place a block a portable task list refuses at its path in the returned document without replaying `splitTaskList` on stand-in nodes. `splitPath` (`src/markdown/parse/markdown-to-adf.ts`) builds stand-ins and `splitPlace` (`src/markdown/portable/task-list.ts`) finds them again by object identity, right only while `taskOfParagraphs` keeps the original child objects. Both paired-ruling seats on 2026-10-11 named it the reason the project read worse. ### 7. Ship HTML: `adfToHtml`, `htmlToAdf`, and markdown to and from HTML composed through ADF, each call named by its flavour. Lands after items 6, 59, 60 and 62. Which flavours get a composed call is this item's to settle; the CommonMark spec suite also runs against the one reading CommonMark. The README documents HTML as it documents markdown, and its tagline and `package.json`'s description and keywords name HTML again. `htmlToAdf` refuses a value that is not a string as `not-a-string` (`docs/decisions.md` §Which code a cause takes). ### 45. Replace `isAdfDocument` with a reader returning `Result`. Lands with item 77: the reader returns item 77's copy. Goal 1 has every call return a result; the boolean guard is the one export that does not, and it cannot say which branch refused, where `not-an-adf-document`'s message already does. Breaking: `MIGRATION.md` shows the guard's replacement. ### 6. Specify the HTML dialect. Element-by-element mapping, the `data-*` fidelity scheme, the opaque-carry form, and the documented foreign-element set `htmlToAdf` accepts — the set the markdown readers share (`spec/flavour.md` §Raw HTML in input). The set sorts per `docs/decisions.md` §Foreign HTML sorts three ways. ### 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. ### 71. Add a README table comparing the package with the other ADF converters, each cell checked against that package's own docs or behaviour. Lands after items 7 and 46: the table names HTML and compares item 46's size figure. Its columns: which directions each converts, whether the round-trip holds, what an unknown node does, the formats, runtime dependencies and size. Candidates are the packages an npm search for ADF and markdown returns. Every cell cites that package's README or a run against its published version, and the table names each version and the date it was checked. Found while planning discoverability, 2026-10-04. Checked 2026-10-05: no other package converts HTML or holds the round-trip; the candidates are `@atlaskit/editor-markdown-transformer`, `adf-to-markdown`, `adf-to-md`, `adf2markdown`, `extended-markdown-adf-parser`, `marklassian` and `md-to-adf`. ### 80. Name the node's path and the attribute key when `not-an-adf-document` refuses a node inside the document. Lands with items 45 and 77, whose reader walks every node. Today every refused node, such as one with a `Date` in an attribute, reads `an ADF document's content holds ADF nodes: one of them is not` with an empty `path`. An export tool told this about one document in thousands then searches that document's whole tree. Give the node's path, and name its type and the attribute key as `attributeNestingMessage` does. Found by the product-owner review of items 66 and 67, 2026-10-05. ### 68. Carry a non-text inline node holding `content` or `text`, a block holding `text`, and a leaf block holding `content`. `refuseContentAndText` (`emit/inline-line.ts`) and `emitDirectiveBlock` (`emit/adf-to-markdown.ts`) refuse these with `unsupported-node-shape`, though `isAdfDocument` accepts them and the carry round-trips them; `docs/decisions.md` §The code list gives a cause the carry answers no code. Drop them from the emitting half of the README's `unsupported-node-shape` row. Found by the README-goals audit, 2026-10-04. ### 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:` and `adf:` fences, canonical and hostile. Found by the technical-principles audit, 2026-10-04. ### 81. Fail the gate unless the README's error tables list exactly the codes `ConvertErrorCode` holds. `src/result.test.ts` checks the union against the call sites only, so a code added or removed leaves the README's tables a false contract under a green gate. Assert that the tables list exactly the union. Found by the technical-principles audit of item 78, 2026-10-05. ### 46. Publish the bundle size in the README, failing the release pipeline when it drifts. Lands after item 7, which changes it. 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. Measured today, unminified: tarball 60.4 kB, unpacked 221.5 kB, JS gzipped 45.6 kB. ### 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. Lands after every other `0.3.0` item (the maintainer, 2026-10-05). 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. ### 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); lowercasing and then uppercasing folds it. 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. ### 95. Find the code-span closers an escape forms, the mark runs a line cannot spell and the text `[` that opens link text by reading the line back, in place of `escapeClosedRuns`, `unspellableRuns` and `lastLinkClose` predicting them. `escapeClosedRuns` works out which backtick strings an escape leaves, `unspellableRuns` rebuilds the reader's emphasis and highlight pairing, and `lastLinkClose` guesses which text `[` opens link text. Only the property tests catch drift between these and the reader, and it holds the project under the comprehension floor. Reading the line back costs one parse each time a line is tried. The run it carries may differ from today's, which changes lossless output (§The formats are API). ### 91. Spell an emphasis or link once across the hard breaks between two nodes it marks, in both writers. Lands after item 95, which lets the joined spelling be tried and kept only where it reads back. No reader marks a hard break, so `*One\` then `Two*` writes back as `_One_\` then `_Two_`, and a link typed across a line as two links. Joining the run across the break in `inline-line.ts` ruled worse with two comprehension panels (PR #22): a joined run that cannot be spelled needs its own fallback, first as a set of parted breaks, then as a flag the first fallback clears. ### 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. Lands after `0.3.0` is published with item 71, so each post links the GitHub repository, the README's comparison table and a README that opens with what the package is. We draft each post for the place it goes; the maintainer posts them. Found while planning discoverability, 2026-10-04. ### 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. ### 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. The Goals and G cells are provisional: no README goal covers the release path. ### 34. Read emphasis flanking by the whole character beside an astral symbol. Check whether `delimiterRunToken` (`inline-tokens.ts`), `emittedRuns` 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. ### 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. ### 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. ### 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`, `deactivatedBefore` and `openingSpellableLink` and return `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. ### 76. State the files the package does not ship once, so the build, the lint ceiling and the coverage exclusions 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 two from the third, or assert in a test that the three agree. Found by the technical-principles audit, 2026-10-04. ### 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. ### 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. ### 58. Port `ci.sh`, `publish.sh` and `docker-runner.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. ### 8. Ship a CLI. The Goals and G cells are provisional: 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.