From faf43dcd3aa4d165def7dc554701f93d1b2f77d9 Mon Sep 17 00:00:00 2001 From: Lilleman auf Larv Date: Wed, 14 Oct 2026 20:02:04 +0200 Subject: [PATCH] =?UTF-8?q?Answer=20prose=20round=201:=200=20=F0=9F=94=B4,?= =?UTF-8?q?=204=20=F0=9F=9F=A1;=20say=20what=20each=20package=20was=20give?= =?UTF-8?q?n,=20drop=20our=20row's=20version,=20state=20the=20pin=20invari?= =?UTF-8?q?ant?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 14 ++++++++------ converter-comparison/compare.mjs | 2 +- converter-comparison/run.sh | 2 +- todo.md | 5 +++-- 4 files changed, 13 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index a333776..a235703 100644 --- a/README.md +++ b/README.md @@ -194,15 +194,17 @@ UI. They know markdown and not ADF, and rely on every spelling saying what it me ## Other ADF converters -Serves [Goals](#goals) 3. Every npm package converting ADF to or from markdown with over 1,000 -downloads a week, at the version named, checked 2026-10-14 by running its published code with its -default options on one document holding marks, a link, a mention, a status, a panel and a list, and -on one holding a node type it cannot know: -[`converter-comparison/`](https://github.com/larvit/adf-codec/tree/main/converter-comparison). +Serves [Goals](#goals) 3. The table lists every other npm package that converts ADF to or from +markdown and has over 1,000 downloads a week. On 2026-10-14, +[`converter-comparison/`](https://github.com/larvit/adf-codec/tree/main/converter-comparison) ran +each package's published code, at the version the table names, with its default options. A package +writing markdown got a document holding marks, a link, a mention, a status, a panel and a list, and +a document holding a node type it cannot know. A package reading markdown got markdown holding the +same marks and link. | Package | Converts | ADF to markdown to ADF | A node type it does not know | Formats | Direct runtime dependencies | | --- | --- | --- | --- | --- | --- | -| `@larvit/adf-codec` 0.2.0 | both ways | the same document | kept | markdown: lossless, portable, CommonMark | 0 | +| `@larvit/adf-codec` | both ways | the same document | kept | markdown: lossless, portable; CommonMark in | 0 | | `@atlaskit/editor-markdown-transformer` 6.3.1 | markdown to ADF, through `@atlaskit/editor-json-transformer` 10.0.0; ADF to markdown throws "This is not implemented yet" | – | – | markdown | 5 | | `adf-to-markdown` 1.0.1 | ADF to markdown | – | dropped with its text | markdown | 0 | | `adf-to-md` 1.2.1 | ADF to markdown | – | dropped with its text, as are mentions, statuses and panels | markdown | 1 | diff --git a/converter-comparison/compare.mjs b/converter-comparison/compare.mjs index f52d6f8..d167ae2 100644 --- a/converter-comparison/compare.mjs +++ b/converter-comparison/compare.mjs @@ -75,7 +75,7 @@ const show = (label, call) => { for (const [name, { toAdf, toMarkdown }] of Object.entries(converters)) { const manifest = JSON.parse(readFileSync(`node_modules/${name}/package.json`, "utf8")); console.log(`\n## ${name} ${manifest.version}`); - console.log("runtime dependencies:", Object.keys(manifest.dependencies ?? {}).length); + console.log("direct runtime dependencies:", Object.keys(manifest.dependencies ?? {}).length); const written = toMarkdown && show("ADF to markdown", () => toMarkdown(roundTripDoc)); if (written !== undefined) { const readBack = toAdf && show("read back", () => toAdf(written)); diff --git a/converter-comparison/run.sh b/converter-comparison/run.sh index cd35ab0..475c8e2 100755 --- a/converter-comparison/run.sh +++ b/converter-comparison/run.sh @@ -1,5 +1,5 @@ #!/bin/sh -# Re-checks the README's comparison table against each package's published version. +# Keep these versions and --before in step with the README's comparison table. set -eu here=$(cd "$(dirname "$0")" && pwd) node_image=node:24.21.0-alpine3.24 diff --git a/todo.md b/todo.md index 195a9d5..2cf7d4d 100644 --- a/todo.md +++ b/todo.md @@ -71,8 +71,9 @@ ### 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. Each post links the GitHub repository, the README's comparison table and a README that opens with -what the package is. Before posting, `converter-comparison/run.sh` checks the table again with -`0.3.0` and today's date in `--before`. We draft each post for the place it goes; the maintainer posts them once +what the package is. 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, then bring the +README table, its versions and its date in step with the output. We draft each post for the place it goes; the maintainer posts them once `0.3.0` is published. Found while planning discoverability, 2026-10-04. ### 114. Build code-marked text holding no mark besides `link` and `annotation`, in every reader, and have `adfToLosslessMarkdown` carry code text holding any other mark.