github-markdown-adf 1.1.0 → 1.3.0

package/dist/index.mjs

@@ -1,10 +1,13 @@
-import { unified } from "unified";
-import remarkParse from "remark-parse";
-import remarkGfm from "remark-gfm";
+import { fromMarkdown } from "mdast-util-from-markdown";
+import { gfmFromMarkdown } from "mdast-util-gfm";
+import { gfm } from "micromark-extension-gfm";
 //#region src/md-to-adf/parser.ts
-const processor = unified().use(remarkParse).use(remarkGfm);
+const markdownParseOptions = {
+	extensions: [gfm()],
+	mdastExtensions: [gfmFromMarkdown()]
+};
 function parseMarkdown(markdown) {
-	return processor.parse(markdown);
+	return fromMarkdown(markdown, markdownParseOptions);
 }
 //#endregion
 //#region src/utils/language.ts
@@ -35,6 +38,7 @@ function normalizeLanguage(lang) {
 //#region src/md-to-adf/transform/marks.ts
 const OPEN_HTML_TAG = /^<(ins|sub|sup)>$/i;
 const CLOSE_HTML_TAG = /^<\/(ins|sub|sup)>$/i;
+const MENTION_PATTERN = /(^|[^A-Za-z0-9_@])@([A-Za-z0-9](?:[A-Za-z0-9._-]*[A-Za-z0-9])?)(?=$|[^A-Za-z0-9._@-])/g;
 function htmlTagToMark(tag) {
 	const t = tag.toLowerCase();
 	if (t === "ins") return { type: "underline" };
@@ -48,7 +52,7 @@ function htmlTagToMark(tag) {
 	};
 	return null;
 }
-function phrasingToInlineNodes(nodes) {
+function phrasingToInlineNodes(nodes, options) {
 	const markStack = [];
 	const result = [];
 	for (const node of nodes) {
@@ -64,22 +68,22 @@ function phrasingToInlineNodes(nodes) {
 				continue;
 			}
 		}
-		result.push(...phrasingToInline(node, markStack.slice()));
+		result.push(...phrasingToInline(node, markStack.slice(), options));
 	}
 	return result;
 }
-function phrasingToInline(node, inheritedMarks) {
+function phrasingToInline(node, inheritedMarks, options) {
 	switch (node.type) {
 		case "text":
 			if (!node.value) return [];
-			return [makeText(node.value, inheritedMarks)];
+			return textToInlineNodes(node.value, inheritedMarks, options);
 		case "inlineCode": {
 			const marks = [...inheritedMarks.filter((m) => m.type === "link"), { type: "code" }];
 			return [makeText(node.value, marks)];
 		}
-		case "strong": return node.children.flatMap((c) => phrasingToInline(c, [...inheritedMarks, { type: "strong" }]));
-		case "emphasis": return node.children.flatMap((c) => phrasingToInline(c, [...inheritedMarks, { type: "em" }]));
-		case "delete": return node.children.flatMap((c) => phrasingToInline(c, [...inheritedMarks, { type: "strike" }]));
+		case "strong": return node.children.flatMap((c) => phrasingToInline(c, [...inheritedMarks, { type: "strong" }], options));
+		case "emphasis": return node.children.flatMap((c) => phrasingToInline(c, [...inheritedMarks, { type: "em" }], options));
+		case "delete": return node.children.flatMap((c) => phrasingToInline(c, [...inheritedMarks, { type: "strike" }], options));
 		case "link": {
 			const linkMark = {
 				type: "link",
@@ -88,7 +92,7 @@ function phrasingToInline(node, inheritedMarks) {
 					...node.title ? { title: node.title } : {}
 				}
 			};
-			return node.children.flatMap((c) => phrasingToInline(c, [...inheritedMarks, linkMark]));
+			return node.children.flatMap((c) => phrasingToInline(c, [...inheritedMarks, linkMark], options));
 		}
 		case "image": return [{
 			type: "inlineCard",
@@ -101,6 +105,27 @@ function phrasingToInline(node, inheritedMarks) {
 		default: return [];
 	}
 }
+function textToInlineNodes(value, marks, options) {
+	if (!options?.mentions || marks.length > 0) return [makeText(value, marks)];
+	const result = [];
+	let lastIndex = 0;
+	for (const match of value.matchAll(MENTION_PATTERN)) {
+		const matchIndex = match.index ?? 0;
+		const prefix = match[1] ?? "";
+		const username = match[2];
+		if (!username) continue;
+		const mentionStart = matchIndex + prefix.length;
+		const mentionEnd = matchIndex + match[0].length;
+		appendTextNode(result, value.slice(lastIndex, mentionStart), marks);
+		const mentionNode = makeMentionNode(username, options.mentions);
+		if (mentionNode) result.push(mentionNode);
+		else appendTextNode(result, value.slice(mentionStart, mentionEnd), marks);
+		lastIndex = mentionEnd;
+	}
+	if (result.length === 0) return [makeText(value, marks)];
+	appendTextNode(result, value.slice(lastIndex), marks);
+	return result;
+}
 function makeText(value, marks) {
 	const node = {
 		type: "text",
@@ -109,6 +134,31 @@ function makeText(value, marks) {
 	if (marks.length > 0) node.marks = marks;
 	return node;
 }
+function appendTextNode(result, value, marks) {
+	if (!value) return;
+	const previousNode = result[result.length - 1];
+	if (previousNode?.type === "text" && sameMarks(previousNode.marks, marks)) {
+		previousNode.text += value;
+		return;
+	}
+	result.push(makeText(value, marks));
+}
+function makeMentionNode(username, mentions) {
+	const attrs = typeof mentions === "function" ? mentions(username) : {
+		id: username,
+		text: `@${username}`
+	};
+	if (!attrs) return null;
+	return {
+		type: "mention",
+		attrs
+	};
+}
+function sameMarks(leftMarks, rightMarks) {
+	const normalizedLeft = leftMarks ?? [];
+	if (normalizedLeft.length !== rightMarks.length) return false;
+	return normalizedLeft.every((mark, index) => JSON.stringify(mark) === JSON.stringify(rightMarks[index]));
+}
 function parseHtmlInline(html, inheritedMarks) {
 	const stripped = html.replace(/<[^>]+>/g, "");
 	if (stripped) return [makeText(stripped, inheritedMarks)];
@@ -116,17 +166,17 @@ function parseHtmlInline(html, inheritedMarks) {
 }
 //#endregion
 //#region src/md-to-adf/transform/blocks.ts
-function transformHeading(node) {
+function transformHeading(node, options) {
 	return {
 		type: "heading",
 		attrs: { level: node.depth },
-		content: phrasingToInlineNodes(node.children)
+		content: phrasingToInlineNodes(node.children, options)
 	};
 }
-function transformParagraph(node) {
+function transformParagraph(node, options) {
 	return {
 		type: "paragraph",
-		content: phrasingToInlineNodes(node.children)
+		content: phrasingToInlineNodes(node.children, options)
 	};
 }
 function transformCode(node) {
@@ -150,7 +200,7 @@ const ALERT_TO_PANEL = {
 	WARNING: "warning",
 	CAUTION: "error"
 };
-function buildPanelContent(firstChild, restChildren, transformChildren) {
+function buildPanelContent(firstChild, restChildren, transformChildren, options) {
 	const remainingText = firstChild.children[0].value.replace(ALERT_PATTERN, "").trim();
 	const remainingInlines = firstChild.children.slice(1);
 	const contentNodes = [];
@@ -162,7 +212,7 @@ function buildPanelContent(firstChild, restChildren, transformChildren) {
 				value: remainingText
 			}] : [], ...remainingInlines]
 		};
-		if (paragraph.children.length > 0) contentNodes.push(transformParagraph(paragraph));
+		if (paragraph.children.length > 0) contentNodes.push(transformParagraph(paragraph, options));
 	}
 	contentNodes.push(...transformChildren(restChildren));
 	if (contentNodes.length === 0) contentNodes.push({
@@ -171,7 +221,7 @@ function buildPanelContent(firstChild, restChildren, transformChildren) {
 	});
 	return contentNodes;
 }
-function tryTransformAlert(node, transformChildren) {
+function tryTransformAlert(node, transformChildren, options) {
 	const firstChild = node.children[0];
 	if (firstChild?.type !== "paragraph") return null;
 	const firstText = firstChild.children[0];
@@ -179,15 +229,15 @@ function tryTransformAlert(node, transformChildren) {
 	const match = ALERT_PATTERN.exec(firstText.value);
 	if (!match) return null;
 	const panelType = ALERT_TO_PANEL[(match[1] ?? "NOTE").toUpperCase()] ?? "info";
-	const content = buildPanelContent(firstChild, node.children.slice(1), transformChildren);
+	const content = buildPanelContent(firstChild, node.children.slice(1), transformChildren, options);
 	return {
 		type: "panel",
 		attrs: { panelType },
 		content
 	};
 }
-function transformBlockquote(node, transformChildren) {
-	const panel = tryTransformAlert(node, transformChildren);
+function transformBlockquote(node, transformChildren, options) {
+	const panel = tryTransformAlert(node, transformChildren, options);
 	if (panel) return panel;
 	const content = transformChildren(node.children);
 	return {
@@ -351,33 +401,33 @@ function generateId() {
 }
 //#endregion
 //#region src/md-to-adf/transform/lists.ts
-function transformList(node, transformBlock) {
-	if (node.children.some((item) => item.checked !== null && item.checked !== void 0)) return transformTaskList(node);
-	if (node.ordered) return transformOrderedList(node, transformBlock);
-	return transformBulletList(node, transformBlock);
+function transformList(node, transformBlock, options) {
+	if (node.children.some((item) => item.checked !== null && item.checked !== void 0)) return transformTaskList(node, options);
+	if (node.ordered) return transformOrderedList(node, transformBlock, options);
+	return transformBulletList(node, transformBlock, options);
 }
-function transformBulletList(node, transformBlock) {
+function transformBulletList(node, transformBlock, options) {
 	return {
 		type: "bulletList",
-		content: node.children.map((item) => transformListItem(item, transformBlock))
+		content: node.children.map((item) => transformListItem(item, transformBlock, options))
 	};
 }
-function transformOrderedList(node, transformBlock) {
+function transformOrderedList(node, transformBlock, options) {
 	const result = {
 		type: "orderedList",
-		content: node.children.map((item) => transformListItem(item, transformBlock))
+		content: node.children.map((item) => transformListItem(item, transformBlock, options))
 	};
 	if (node.start !== null && node.start !== void 0 && node.start !== 1) result.attrs = { order: node.start };
 	return result;
 }
-function transformListItem(node, transformBlock) {
+function transformListItem(node, transformBlock, options) {
 	const content = [];
 	for (const child of node.children) if (child.type === "paragraph") content.push({
 		type: "paragraph",
-		content: phrasingToInlineNodes(child.children)
+		content: phrasingToInlineNodes(child.children, options)
 	});
 	else if (child.type === "list") {
-		const nestedList = transformList(child, transformBlock);
+		const nestedList = transformList(child, transformBlock, options);
 		if (nestedList.type === "taskList") {
 			const para = {
 				type: "paragraph",
@@ -414,11 +464,11 @@ function transformListItem(node, transformBlock) {
 		content
 	};
 }
-function transformTaskList(node) {
+function transformTaskList(node, options) {
 	const listId = generateId();
 	const items = node.children.map((listItem) => {
 		const state = listItem.checked === true ? "DONE" : "TODO";
-		const inlineContent = listItem.children.filter((c) => c.type === "paragraph").flatMap((c) => phrasingToInlineNodes(c.children));
+		const inlineContent = listItem.children.filter((c) => c.type === "paragraph").flatMap((c) => phrasingToInlineNodes(c.children, options));
 		const taskItem = {
 			type: "taskItem",
 			attrs: {
@@ -437,7 +487,7 @@ function transformTaskList(node) {
 }
 //#endregion
 //#region src/md-to-adf/transform/tables.ts
-function transformTable(node) {
+function transformTable(node, options) {
 	const rows = node.children;
 	if (rows.length === 0) return {
 		type: "table",
@@ -448,19 +498,19 @@ function transformTable(node) {
 	const adfRows = [];
 	if (headerRow) adfRows.push({
 		type: "tableRow",
-		content: headerRow.children.map((cell) => transformTableHeader(cell))
+		content: headerRow.children.map((cell) => transformTableHeader(cell, options))
 	});
 	for (const row of bodyRows) adfRows.push({
 		type: "tableRow",
-		content: row.children.map((cell) => transformTableCell(cell))
+		content: row.children.map((cell) => transformTableCell(cell, options))
 	});
 	return {
 		type: "table",
 		content: adfRows
 	};
 }
-function transformTableHeader(cell) {
-	const inlines = phrasingToInlineNodes(cell.children);
+function transformTableHeader(cell, options) {
+	const inlines = phrasingToInlineNodes(cell.children, options);
 	return {
 		type: "tableHeader",
 		attrs: {},
@@ -470,8 +520,8 @@ function transformTableHeader(cell) {
 		}]
 	};
 }
-function transformTableCell(cell) {
-	const inlines = phrasingToInlineNodes(cell.children);
+function transformTableCell(cell, options) {
+	const inlines = phrasingToInlineNodes(cell.children, options);
 	return {
 		type: "tableCell",
 		attrs: {},
@@ -483,42 +533,42 @@ function transformTableCell(cell) {
 }
 //#endregion
 //#region src/md-to-adf/transform/index.ts
-function transformRoot(root) {
+function transformRoot(root, options) {
 	return {
 		version: 1,
 		type: "doc",
-		content: transformNodes(root.children)
+		content: transformNodes(root.children, options)
 	};
 }
-function transformNodes(nodes) {
+function transformNodes(nodes, options) {
 	const result = [];
 	const detailsPairs = buildDetailsPairs(nodes);
 	let i = 0;
 	while (i < nodes.length) {
-		const expand = tryTransformExpand(nodes, i, detailsPairs, transformBlock);
+		const expand = tryTransformExpand(nodes, i, detailsPairs, (node) => transformBlock(node, options));
 		if (expand) {
 			result.push(expand.node);
 			i = expand.next;
 			continue;
 		}
-		const transformed = transformBlock(nodes[i]);
+		const transformed = transformBlock(nodes[i], options);
 		if (transformed) result.push(transformed);
 		i++;
 	}
 	return result;
 }
-function transformBlock(node) {
+function transformBlock(node, options) {
 	switch (node.type) {
-		case "heading": return transformHeading(node);
-		case "paragraph": return transformParagraph(node);
+		case "heading": return transformHeading(node, options);
+		case "paragraph": return transformParagraph(node, options);
 		case "code": return transformCode(node);
 		case "thematicBreak": return transformThematicBreak(node);
 		case "blockquote": return transformBlockquote(node, (children) => children.flatMap((c) => {
-			const r = transformBlock(c);
+			const r = transformBlock(c, options);
 			return r ? [r] : [];
-		}));
-		case "list": return transformList(node, transformBlock);
-		case "table": return transformTable(node);
+		}), options);
+		case "list": return transformList(node, (blockNode) => transformBlock(blockNode, options), options);
+		case "table": return transformTable(node, options);
 		case "html": return transformHtmlBlock(node);
 		default: return null;
 	}
@@ -545,8 +595,8 @@ function sanitizeText(text) {
 }
 //#endregion
 //#region src/md-to-adf/index.ts
-function mdToAdf(markdown) {
-	return transformRoot(parseMarkdown(sanitizeText(markdown)));
+function mdToAdf(markdown, options) {
+	return transformRoot(parseMarkdown(sanitizeText(markdown)), options);
 }
 //#endregion
 //#region src/utils/escape.ts
@@ -613,6 +663,7 @@ function serializeInline(node, options) {
 		case "hardBreak": return "\\\n";
 		case "mention":
 			if (options?.mentions === false) return node.attrs.text ?? node.attrs.id;
+			if (typeof options?.mentions === "function") return options.mentions(node.attrs);
 			return node.attrs.text ?? `@${node.attrs.id}`;
 		case "emoji": return node.attrs.text ?? `:${node.attrs.shortName}:`;
 		case "date": return node.attrs.timestamp;