feat: custom gfm plugin for gt-remark

.changeset/sixty-poems-smash.md

@@ -0,0 +1,5 @@
+---
+'gt-remark': patch
+---
+
+Adding custom GFM plugin

packages/remark/package.json

@@ -45,10 +45,19 @@
   },
   "homepage": "https://generaltranslation.com/",
   "dependencies": {
-    "mdast-util-find-and-replace": "^3.0.1"
+    "mdast-util-find-and-replace": "^3.0.1",
+    "mdast-util-gfm-footnote": "^2.1.0",
+    "mdast-util-gfm-strikethrough": "^2.0.0",
+    "mdast-util-gfm-table": "^2.0.0",
+    "mdast-util-gfm-task-list-item": "^2.0.0",
+    "micromark-extension-gfm-footnote": "^2.1.0",
+    "micromark-extension-gfm-strikethrough": "^2.1.0",
+    "micromark-extension-gfm-table": "^2.1.1",
+    "micromark-extension-gfm-task-list-item": "^2.1.0"
   },
   "devDependencies": {
     "@types/mdast": "^4.0.4",
+    "remark-parse": "^11.0.0",
     "remark-stringify": "^11.0.0",
     "typescript": "^5.7.3",
     "unified": "^11.0.5",

packages/remark/src/__tests__/index.test.ts

@@ -1,7 +1,8 @@
 import { describe, it, expect } from 'vitest';
 import { unified } from 'unified';
+import remarkParse from 'remark-parse';
 import remarkStringify from 'remark-stringify';
-import escapeHtmlInTextNodes from '../index';
+import escapeHtmlInTextNodes, { remarkGfmCustom } from '../index';
 import type { Root, Text, Paragraph, Code, InlineCode } from 'mdast';
 
 describe('escapeHtmlInTextNodes', () => {
@@ -41,7 +42,7 @@
       ruleSpaces: false,
       handlers: {
         // Custom handler to prevent escaping (matches production usage)
         text(node: any) {
           return node.value;
         },
       },
@@ -420,3 +421,52 @@
     });
   });
 });
+
+describe('remarkGfmCustom', () => {
+  const processMarkdown = (markdown: string) => {
+    const processor = unified()
+      .use(remarkParse)
+      .use(remarkGfmCustom)
+      .use(remarkStringify, {
+        bullet: '-',
+        emphasis: '_',
+        strong: '*',
+        rule: '-',
+        ruleRepetition: 3,
+        ruleSpaces: false,
+        handlers: {
+          text(node: any) {
+            return node.value;
+          },
+        },
+      });
+
+    return String(processor.processSync(markdown));
+  };
+
+  it('should keep bare URLs as plain text', () => {
+    const input =
+      'See https://github.com/ClickHouse/ClickHouse/issues/92752 for details.';
+    const result = processMarkdown(input);
+    expect(result).toContain(
+      'See https://github.com/ClickHouse/ClickHouse/issues/92752 for details.'
+    );
+    expect(result).not.toContain(
+      '<https://github.com/ClickHouse/ClickHouse/issues/92752>'
+    );
+    expect(result).not.toContain(
+      '[https://github.com/ClickHouse/ClickHouse/issues/92752]'
+    );
+  });
+
+  it('should keep GFM tables working', () => {
+    const input = [
+      '| Format | Support | Notes |',
+      '|---|---|---|',
+      '| JSON | OK | Supports `JSON` |',
+    ].join('\n');
+    const result = processMarkdown(input);
+    expect(result).toMatch(/\| Format \| Support \| Notes\s*\|/);
+    expect(result).toMatch(/\| JSON\s+\| OK\s+\| Supports `JSON` \|/);
+  });
+});

packages/remark/src/index.ts

@@ -1,6 +1,23 @@
 import type { Plugin } from 'unified';
 import type { Root } from 'mdast';
 import { findAndReplace } from 'mdast-util-find-and-replace';
+import { gfmFootnote } from 'micromark-extension-gfm-footnote';
+import { gfmStrikethrough } from 'micromark-extension-gfm-strikethrough';
+import { gfmTable } from 'micromark-extension-gfm-table';
+import { gfmTaskListItem } from 'micromark-extension-gfm-task-list-item';
+import {
+  gfmFootnoteFromMarkdown,
+  gfmFootnoteToMarkdown,
+} from 'mdast-util-gfm-footnote';
+import {
+  gfmStrikethroughFromMarkdown,
+  gfmStrikethroughToMarkdown,
+} from 'mdast-util-gfm-strikethrough';
+import { gfmTableFromMarkdown, gfmTableToMarkdown } from 'mdast-util-gfm-table';
+import {
+  gfmTaskListItemFromMarkdown,
+  gfmTaskListItemToMarkdown,
+} from 'mdast-util-gfm-task-list-item';
 
 const IGNORE_ALWAYS = [
   'code',
@@ -53,5 +70,39 @@ const escapeHtmlInTextNodes: Plugin<[], Root> = function () {
   };
 };
 
+const remarkGfmCustom: Plugin = function () {
+  const data = this.data() as {
+    micromarkExtensions?: unknown[];
+    fromMarkdownExtensions?: unknown[];
+    toMarkdownExtensions?: unknown[];
+  };
+
+  const micromarkExtensions =
+    data.micromarkExtensions || (data.micromarkExtensions = []);
+  const fromMarkdownExtensions =
+    data.fromMarkdownExtensions || (data.fromMarkdownExtensions = []);
+  const toMarkdownExtensions =
+    data.toMarkdownExtensions || (data.toMarkdownExtensions = []);
+
+  micromarkExtensions.push(
+    gfmStrikethrough(),
+    gfmTable(),
+    gfmTaskListItem(),
+    gfmFootnote()
+  );
+  fromMarkdownExtensions.push(
+    gfmStrikethroughFromMarkdown(),
+    gfmTableFromMarkdown(),
+    gfmTaskListItemFromMarkdown(),
+    gfmFootnoteFromMarkdown()
+  );
+  toMarkdownExtensions.push(
+    gfmStrikethroughToMarkdown(),
+    gfmTableToMarkdown(),
+    gfmTaskListItemToMarkdown(),
+    gfmFootnoteToMarkdown()
+  );
+};
+
 export default escapeHtmlInTextNodes;
-export { escapeHtmlInTextNodes };
+export { escapeHtmlInTextNodes, remarkGfmCustom };