fix: use unified performSyncWork for parsing with remark config (#583)

Author: JounQin

.changeset/sour-icons-complain.md

@@ -0,0 +1,5 @@
+---
+"eslint-plugin-mdx": patch
+---
+
+fix: use unified `performSyncWork` for parsing with remark config

package.json

@@ -51,6 +51,7 @@
     "path-serializer": "^0.5.0",
     "prettier": "^3.5.3",
     "react": "^19.1.0",
+    "remark-math": "^6.0.0",
     "rimraf": "^6.0.1",
     "simple-git-hooks": "^2.13.0",
     "ts-node": "^10.9.2",
@@ -102,7 +103,8 @@
   "prettier": "@1stg/prettier-config",
   "remarkConfig": {
     "plugins": [
-      "@1stg/preset"
+      "@1stg/preset",
+      "remark-math"
     ]
   },
   "typeCoverage": {

packages/eslint-plugin-mdx/src/from-markdown.ts

@@ -1,10 +1,13 @@
 /** {@link https://github.com/eslint/markdown/blob/f17311eb250fe3f41a24fd52be9c6713d12b7d67/src/processor.js} */
 
+import fs from 'node:fs'
+import path from 'node:path'
+
 import type { AST, Linter, Rule } from 'eslint'
+import { performSyncWork } from 'eslint-mdx'
 import type { Node, Parent, Nodes, Root, RootContentMap } from 'mdast'
 import type { MdxFlowExpression, MdxTextExpression } from 'mdast-util-mdx'
 
-import { fromMarkdown } from '../from-markdown.js'
 import { meta } from '../meta.js'
 
 import type { CodeBlock, RangeMap } from './types.js'
@@ -262,22 +265,43 @@ function fileNameFromMeta(block: CodeBlock) {
     ?.groups.filename.replaceAll(/\s+/gu, '_')
 }
 
+/**
+ * Given a filepath, get the nearest path that is a regular file. The filepath
+ * provided by eslint may be a virtual filepath rather than a file on disk. This
+ * attempts to transform a virtual path into an on-disk path
+ */
+function getOnDiskFilepath(filepath: string): string {
+  let fallback: boolean | undefined
+  try {
+    /* istanbul ignore next -- `throwIfNoEntry` compatibility */
+    if (!fs.statSync(filepath, { throwIfNoEntry: false })) {
+      fallback = true
+    }
+  } catch (err) {
+    /* istanbul ignore next -- https://github.com/eslint/eslint/issues/11989 */
+    if ((err as NodeJS.ErrnoException).code === 'ENOTDIR') {
+      fallback = true
+    }
+  }
+  return fallback ? getOnDiskFilepath(path.dirname(filepath)) : filepath
+}
+
 /**
  * Extracts lintable code blocks from Markdown text.
  *
  * @param sourceText The text of the file.
  * @param filename The filename of the file
  * @returns Source code blocks to lint.
  */
-
 function preprocess(sourceText: string, filename: string) {
   // istanbul ignore next
   const text = sourceText.startsWith(BOM) ? sourceText.slice(1) : sourceText
-  const ast = fromMarkdown(
-    text,
+  const { root } = performSyncWork({
+    filePath: getOnDiskFilepath(filename),
+    code: text,
     // FIXME: how to read `extensions` and `markdownExtensions` parser options?
-    filename.endsWith('.mdx'),
-  )
+    isMdx: filename.endsWith('.mdx'),
+  })
   const blocks: CodeBlock[] = []
 
   blocksCache.set(filename, blocks)
@@ -300,7 +324,7 @@ function preprocess(sourceText: string, filename: string) {
     }
   }
 
-  traverse(ast, {
+  traverse(root, {
     '*'() {
       allComments = []
     },

packages/eslint-plugin-mdx/src/processors/markdown.ts

@@ -1224,6 +1224,8 @@ exports[`fixtures should match all snapshots: 488.mdx 1`] = `
 ]
 `;
 
+exports[`fixtures should match all snapshots: 576.mdx 1`] = `[]`;
+
 exports[`fixtures should match all snapshots: acorn.mdx 1`] = `
 [
   {

test/__snapshots__/fixtures.test.ts.snap

@@ -1,4 +1,4 @@
-// Jest Snapshot v1, https://goo.gl/fbAQLP
+// Jest Snapshot v1, https://jestjs.io/docs/snapshot-testing
 
 exports[`parser should match all AST snapshots: 287.mdx 1`] = `
 {
@@ -36769,6 +36769,55 @@ exports[`parser should match all AST snapshots: 488.mdx 1`] = `
 }
 `;
 
+exports[`parser should match all AST snapshots: 576.mdx 1`] = `
+{
+  "body": [],
+  "comments": [],
+  "end": 159,
+  "loc": {
+    "end": {
+      "column": 1,
+      "line": 6,
+      "offset": 159,
+    },
+    "start": {
+      "column": 1,
+      "line": 1,
+      "offset": 0,
+    },
+  },
+  "range": [
+    0,
+    159,
+  ],
+  "sourceType": undefined,
+  "start": 0,
+  "tokens": [
+    {
+      "end": 143,
+      "loc": {
+        "end": {
+          "column": 30,
+          "line": 5,
+        },
+        "start": {
+          "column": 0,
+          "line": 5,
+        },
+      },
+      "range": [
+        113,
+        143,
+      ],
+      "start": 113,
+      "type": "JSXText",
+      "value": "the aggregate amount would be ",
+    },
+  ],
+  "type": "Program",
+}
+`;
+
 exports[`parser should match all AST snapshots: acorn.mdx 1`] = `"Unexpected character \`\\\` (U+005C) in name, expected a name character such as letters, digits, \`$\`, or \`_\`; whitespace before attributes; or the end of the tag"`;
 
 exports[`parser should match all AST snapshots: adjacent.mdx 1`] = `

test/__snapshots__/parser.test.ts.snap

@@ -0,0 +1,5 @@
+$$
+\forall \epsilon > 0, \exists \delta > 0 \text{ s.t. } |x - a| < \delta \Rightarrow |f(x) - b| < \epsilon
+$$
+
+the aggregate amount would be $100Mm*10^{18}$

test/fixtures/576.mdx

@@ -3433,6 +3433,7 @@ __metadata:
     path-serializer: "npm:^0.5.0"
     prettier: "npm:^3.5.3"
     react: "npm:^19.1.0"
+    remark-math: "npm:^6.0.0"
     rimraf: "npm:^6.0.1"
     simple-git-hooks: "npm:^2.13.0"
     ts-node: "npm:^10.9.2"
@@ -4571,6 +4572,13 @@ __metadata:
   languageName: node
   linkType: hard
 
+"@types/katex@npm:^0.16.0":
+  version: 0.16.7
+  resolution: "@types/katex@npm:0.16.7"
+  checksum: 10c0/68dcb9f68a90513ec78ca0196a142e15c2a2c270b1520d752bafd47a99207115085a64087b50140359017d7e9c870b3c68e7e4d36668c9e348a9ef0c48919b5a
+  languageName: node
+  linkType: hard
+
 "@types/keyv@npm:^3.1.4":
   version: 3.1.4
   resolution: "@types/keyv@npm:3.1.4"
@@ -6325,6 +6333,13 @@ __metadata:
   languageName: node
   linkType: hard
 
+"commander@npm:^8.3.0":
+  version: 8.3.0
+  resolution: "commander@npm:8.3.0"
+  checksum: 10c0/8b043bb8322ea1c39664a1598a95e0495bfe4ca2fad0d84a92d7d1d8d213e2a155b441d2470c8e08de7c4a28cf2bc6e169211c49e1b21d9f7edc6ae4d9356060
+  languageName: node
+  linkType: hard
+
 "commander@npm:^9.4.1":
   version: 9.5.0
   resolution: "commander@npm:9.5.0"
@@ -10157,6 +10172,17 @@ __metadata:
   languageName: node
   linkType: hard
 
+"katex@npm:^0.16.0":
+  version: 0.16.22
+  resolution: "katex@npm:0.16.22"
+  dependencies:
+    commander: "npm:^8.3.0"
+  bin:
+    katex: cli.js
+  checksum: 10c0/07b8b1f07ae53171b5f1ea0cf6f18841d2055825c8b11cd81cfe039afcd3af2cfc84ad033531ee3875088329105195b039c267e0dd4b0c237807e3c3b2009913
+  languageName: node
+  linkType: hard
+
 "keyv@npm:^4.0.0, keyv@npm:^4.5.4":
   version: 4.5.4
   resolution: "keyv@npm:4.5.4"
@@ -10694,6 +10720,21 @@ __metadata:
   languageName: node
   linkType: hard
 
+"mdast-util-math@npm:^3.0.0":
+  version: 3.0.0
+  resolution: "mdast-util-math@npm:3.0.0"
+  dependencies:
+    "@types/hast": "npm:^3.0.0"
+    "@types/mdast": "npm:^4.0.0"
+    devlop: "npm:^1.0.0"
+    longest-streak: "npm:^3.0.0"
+    mdast-util-from-markdown: "npm:^2.0.0"
+    mdast-util-to-markdown: "npm:^2.1.0"
+    unist-util-remove-position: "npm:^5.0.0"
+  checksum: 10c0/d4e839e38719f26872ed78aac18339805a892f1b56585a9cb8668f34e221b4f0660b9dfe49ec96dbbe79fd1b63b648608a64046d8286bcd2f9d576e80b48a0a1
+  languageName: node
+  linkType: hard
+
 "mdast-util-mdx-expression@npm:^2.0.0":
   version: 2.0.1
   resolution: "mdast-util-mdx-expression@npm:2.0.1"
@@ -10782,7 +10823,7 @@ __metadata:
   languageName: node
   linkType: hard
 
-"mdast-util-to-markdown@npm:^2.0.0":
+"mdast-util-to-markdown@npm:^2.0.0, mdast-util-to-markdown@npm:^2.1.0":
   version: 2.1.2
   resolution: "mdast-util-to-markdown@npm:2.1.2"
   dependencies:
@@ -11026,6 +11067,21 @@ __metadata:
   languageName: node
   linkType: hard
 
+"micromark-extension-math@npm:^3.0.0":
+  version: 3.1.0
+  resolution: "micromark-extension-math@npm:3.1.0"
+  dependencies:
+    "@types/katex": "npm:^0.16.0"
+    devlop: "npm:^1.0.0"
+    katex: "npm:^0.16.0"
+    micromark-factory-space: "npm:^2.0.0"
+    micromark-util-character: "npm:^2.0.0"
+    micromark-util-symbol: "npm:^2.0.0"
+    micromark-util-types: "npm:^2.0.0"
+  checksum: 10c0/56e6f2185a4613f9d47e7e98cf8605851c990957d9229c942b005e286c8087b61dc9149448d38b2f8be6d42cc6a64aad7e1f2778ddd86fbbb1a2f48a3ca1872f
+  languageName: node
+  linkType: hard
+
 "micromark-extension-mdx-expression@npm:^3.0.0":
   version: 3.0.1
   resolution: "micromark-extension-mdx-expression@npm:3.0.1"
@@ -13496,6 +13552,18 @@ __metadata:
   languageName: node
   linkType: hard
 
+"remark-math@npm:^6.0.0":
+  version: 6.0.0
+  resolution: "remark-math@npm:6.0.0"
+  dependencies:
+    "@types/mdast": "npm:^4.0.0"
+    mdast-util-math: "npm:^3.0.0"
+    micromark-extension-math: "npm:^3.0.0"
+    unified: "npm:^11.0.0"
+  checksum: 10c0/859613c4db194bb6b3c9c063661dc52b8ceda9c5cf3256b42f73d93eb8f38a6d634eb5f976fe094425f6f1035aaf329eb49ada314feb3b2b1073326b6d3aaa02
+  languageName: node
+  linkType: hard
+
 "remark-mdx@npm:^3.1.0":
   version: 3.1.0
   resolution: "remark-mdx@npm:3.1.0"
@@ -15272,6 +15340,16 @@ __metadata:
   languageName: node
   linkType: hard
 
+"unist-util-remove-position@npm:^5.0.0":
+  version: 5.0.0
+  resolution: "unist-util-remove-position@npm:5.0.0"
+  dependencies:
+    "@types/unist": "npm:^3.0.0"
+    unist-util-visit: "npm:^5.0.0"
+  checksum: 10c0/e8c76da4399446b3da2d1c84a97c607b37d03d1d92561e14838cbe4fdcb485bfc06c06cfadbb808ccb72105a80643976d0660d1fe222ca372203075be9d71105
+  languageName: node
+  linkType: hard
+
 "unist-util-stringify-position@npm:^4.0.0":
   version: 4.0.0
   resolution: "unist-util-stringify-position@npm:4.0.0"