mirror of
https://github.com/larvit/adf-codec.git
synced 2026-11-21 15:42:58 +01:00
Open the README with the call to take for each need, and widen the converter comparison
This commit is contained in:
@@ -1,15 +1,22 @@
|
||||
import * as adf2markdown from "adf2markdown";
|
||||
import * as adfCodec from "@larvit/adf-codec";
|
||||
import * as adfMd from "adf-md";
|
||||
import * as adfToMarkdown from "adf-to-markdown";
|
||||
import adfToMd from "adf-to-md";
|
||||
import { loadAdf4j } from "@nthings.dev/adf4j-wasm";
|
||||
import * as atlaskitJson from "@atlaskit/editor-json-transformer";
|
||||
import * as atlaskitMarkdown from "@atlaskit/editor-markdown-transformer";
|
||||
import { createRequire } from "node:module";
|
||||
import * as extendedParser from "extended-markdown-adf-parser";
|
||||
import * as faulander from "@faulander/md2adf";
|
||||
import * as githubMarkdownAdf from "github-markdown-adf";
|
||||
import { isDeepStrictEqual } from "node:util";
|
||||
import * as marklassian from "marklassian";
|
||||
import * as markdownToAdf from "markdown-to-adf";
|
||||
import { fromADF } from "mdast-util-from-adf";
|
||||
import mdToAdf from "md-to-adf";
|
||||
import { readFileSync } from "node:fs";
|
||||
import { toMarkdown as mdastToMarkdown } from "mdast-util-to-markdown";
|
||||
|
||||
const { defaultSchema } = createRequire(import.meta.url)("@atlaskit/adf-schema/schema-default");
|
||||
|
||||
@@ -43,6 +50,11 @@ const markdown = "***bold italic*** and [a link](https://example.com) hi @Ann\n\
|
||||
const extended = new extendedParser.Parser();
|
||||
const json = new atlaskitJson.JSONTransformer();
|
||||
const atlaskit = new atlaskitMarkdown.MarkdownTransformer(defaultSchema);
|
||||
const adf4j = await loadAdf4j();
|
||||
const succeeded = (result) => {
|
||||
if (result.type !== "Success") throw new Error(JSON.stringify(result));
|
||||
return result.value;
|
||||
};
|
||||
const converters = {
|
||||
"@atlaskit/editor-markdown-transformer": {
|
||||
toAdf: (md) => json.encode(atlaskit.parse(md)),
|
||||
@@ -52,9 +64,24 @@ const converters = {
|
||||
toAdf: (md) => adfCodec.losslessMarkdownToAdf(md).value,
|
||||
toMarkdown: (doc) => adfCodec.adfToLosslessMarkdown(doc).value,
|
||||
},
|
||||
"@faulander/md2adf": {
|
||||
toAdf: (md) => faulander.markdownToAdf(md),
|
||||
toMarkdown: (doc) => faulander.adfToMarkdown(doc),
|
||||
},
|
||||
"@nthings.dev/adf4j-wasm": { toMarkdown: (doc) => adf4j.convert(JSON.stringify(doc)) },
|
||||
"adf-md": {
|
||||
toAdf: (md) => succeeded(adfMd.markdownToAdf(md)),
|
||||
toMarkdown: (doc) => succeeded(adfMd.adfToMarkdown(doc)),
|
||||
},
|
||||
"adf-to-markdown": { toMarkdown: (doc) => adfToMarkdown.convertADFToMarkdown(doc) },
|
||||
"adf-to-md": { toMarkdown: (doc) => adfToMd.convert(doc).result },
|
||||
adf2markdown: { toMarkdown: (doc) => adf2markdown.adf2markdown(doc) },
|
||||
"github-markdown-adf": {
|
||||
toAdf: (md) => githubMarkdownAdf.mdToAdf(md),
|
||||
toMarkdown: (doc) => githubMarkdownAdf.adfToMd(doc),
|
||||
},
|
||||
"markdown-to-adf": { toAdf: (md) => markdownToAdf.markdownToAdf(md) },
|
||||
"mdast-util-from-adf": { toMarkdown: (doc) => mdastToMarkdown(fromADF(doc)) },
|
||||
"extended-markdown-adf-parser": {
|
||||
toAdf: (md) => extended.markdownToAdf(md),
|
||||
toMarkdown: (doc) => extended.adfToMarkdown(doc),
|
||||
@@ -77,11 +104,11 @@ for (const [name, { toAdf, toMarkdown }] of Object.entries(converters)) {
|
||||
console.log(`\n## ${name} ${manifest.version}`);
|
||||
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));
|
||||
if (written !== undefined && toAdf) {
|
||||
const readBack = show("read back", () => toAdf(written));
|
||||
if (readBack !== undefined) console.log("round-trip deep-equal:", isDeepStrictEqual(readBack, roundTripDoc));
|
||||
const unknown = show("unknown node to markdown", () => toMarkdown(unknownNodeDoc));
|
||||
if (toAdf && unknown !== undefined) show("unknown node read back", () => toAdf(unknown));
|
||||
}
|
||||
const unknown = toMarkdown && show("unknown node to markdown", () => toMarkdown(unknownNodeDoc));
|
||||
if (toAdf && unknown !== undefined) show("unknown node read back", () => toAdf(unknown));
|
||||
if (toAdf) show("markdown to ADF", () => toAdf(markdown));
|
||||
}
|
||||
|
||||
@@ -3,16 +3,23 @@
|
||||
set -eu
|
||||
here=$(cd "$(dirname "$0")" && pwd)
|
||||
node_image=node:26.12.1-alpine3.24
|
||||
docker run --rm --ulimit core=0 -u "$(id -u):$(id -g)" -e HOME=/tmp -v "$here:/comparison:ro" -w /tmp \
|
||||
docker run --rm --memory 2g --memory-swap 2g --ulimit core=0 -u "$(id -u):$(id -g)" -e HOME=/tmp -v "$here:/comparison:ro" -w /tmp \
|
||||
"$node_image" sh -c '
|
||||
npm install --before=2026-10-15 --ignore-scripts --no-audit --no-fund --silent \
|
||||
npm install --before=2026-10-29 --ignore-scripts --no-audit --no-fund --silent \
|
||||
@atlaskit/editor-json-transformer@10.0.0 \
|
||||
@atlaskit/editor-markdown-transformer@6.3.1 \
|
||||
@faulander/md2adf@1.0.0 \
|
||||
@larvit/adf-codec@0.2.0 \
|
||||
@nthings.dev/adf4j-wasm@1.0.2 \
|
||||
adf-md@0.2.0 \
|
||||
adf-to-markdown@1.0.1 \
|
||||
adf-to-md@1.2.1 \
|
||||
adf2markdown@1.2.0 \
|
||||
extended-markdown-adf-parser@2.4.0 \
|
||||
github-markdown-adf@1.3.0 \
|
||||
markdown-to-adf@0.2.20 \
|
||||
marklassian@1.2.1 \
|
||||
md-to-adf@0.6.4 &&
|
||||
md-to-adf@0.6.4 \
|
||||
mdast-util-from-adf@2.3.0 \
|
||||
mdast-util-to-markdown@2.2.1 &&
|
||||
cp /comparison/compare.mjs . && node compare.mjs'
|
||||
|
||||
Reference in New Issue
Block a user