feat: support specifying remarkConfigPath manually (#589)

JounQin · web-flow · commit 7b5e7489f596 · 2025-07-04T15:09:20.000+08:00
diff --git a/.changeset/large-items-thank.md b/.changeset/large-items-thank.md
@@ -0,0 +1,6 @@
+---
+"eslint-plugin-mdx": minor
+"eslint-mdx": minor
+---
+
+feat: support specifying `remarkConfigPath` manually
diff --git a/README.md b/README.md
@@ -100,6 +100,10 @@ npm i -D eslint-plugin-mdx
     // optional, if you want to disable language mapper, set it to `false`
     // if you want to override the default language mapper inside, you can provide your own
     "mdx/language-mapper": {},
+    // optional, same as the `parserOptions.ignoreRemarkConfig`, you have to specify it twice unfortunately
+    "mdx/ignore-remark-config": true,
+    // optional, same as the `parserOptions.remarkConfigPath`, you have to specify it twice unfortunately
+    "mdx/remark-config-path": "path/to/your/remarkrc",
   },
 }
 ```
@@ -120,6 +124,10 @@ export default [
       // optional, if you want to disable language mapper, set it to `false`
       // if you want to override the default language mapper inside, you can provide your own
       languageMapper: {},
+      // optional, same as the `parserOptions.ignoreRemarkConfig`, you have to specify it twice unfortunately
+      ignoreRemarkConfig: true,
+      // optional, same as the `parserOptions.remarkConfigPath`, you have to specify it twice unfortunately
+      remarkConfigPath: 'path/to/your/remarkrc',
     }),
   },
   {
@@ -148,6 +156,8 @@ eslint . --ext js,md,mdx
 
 3. `ignoreRemarkConfig` (`boolean`): Ignore the `remark` configuration defined in the project.
 
+4. `remarkConfigPath` (`string`): Specify the path to the `remark` configuration file, could be relative to `CWD` or absolute path.
+
 ## Parser API
 
 ### `MDXCode`
diff --git a/packages/eslint-mdx/README.md b/packages/eslint-mdx/README.md
@@ -100,6 +100,10 @@ npm i -D eslint-plugin-mdx
     // optional, if you want to disable language mapper, set it to `false`
     // if you want to override the default language mapper inside, you can provide your own
     "mdx/language-mapper": {},
+    // optional, same as the `parserOptions.ignoreRemarkConfig`, you have to specify it twice unfortunately
+    "mdx/ignore-remark-config": true,
+    // optional, same as the `parserOptions.remarkConfigPath`, you have to specify it twice unfortunately
+    "mdx/remark-config-path": "path/to/your/remarkrc",
   },
 }
 ```
@@ -120,6 +124,10 @@ export default [
       // optional, if you want to disable language mapper, set it to `false`
       // if you want to override the default language mapper inside, you can provide your own
       languageMapper: {},
+      // optional, same as the `parserOptions.ignoreRemarkConfig`, you have to specify it twice unfortunately
+      ignoreRemarkConfig: true,
+      // optional, same as the `parserOptions.remarkConfigPath`, you have to specify it twice unfortunately
+      remarkConfigPath: 'path/to/your/remarkrc',
     }),
   },
   {
@@ -148,6 +156,8 @@ eslint . --ext js,md,mdx
 
 3. `ignoreRemarkConfig` (`boolean`): Ignore the `remark` configuration defined in the project.
 
+4. `remarkConfigPath` (`string`): Specify the path to the `remark` configuration file, could be relative to `CWD` or absolute path.
+
 ## Parser API
 
 ### `MDXCode`
diff --git a/packages/eslint-mdx/src/parser.ts b/packages/eslint-mdx/src/parser.ts
@@ -26,6 +26,7 @@ export class Parser {
       filePath,
       sourceType,
       ignoreRemarkConfig,
+      remarkConfigPath,
       extensions,
       markdownExtensions,
     }: ParserOptions,
@@ -55,6 +56,7 @@ export class Parser {
         code,
         isMdx,
         ignoreRemarkConfig,
+        remarkConfigPath,
       })
     } catch (err: unknown) {
       /* istanbul ignore if */
diff --git a/packages/eslint-mdx/src/types.ts b/packages/eslint-mdx/src/types.ts
@@ -10,6 +10,7 @@ export interface ParserOptions extends Linter.ParserOptions {
   markdownExtensions?: string[] | string
   filePath?: string
   ignoreRemarkConfig?: boolean
+  remarkConfigPath?: string
 }
 
 export interface NormalPosition {
@@ -22,13 +23,17 @@ export interface NormalPosition {
   range: [number, number]
 }
 
-export interface WorkerOptions {
+export interface SyncOptions {
+  cwd?: string
+  ignoreRemarkConfig?: boolean
+  remarkConfigPath?: string
+}
+
+export interface WorkerOptions extends SyncOptions {
   filePath: string
   code: string
-  cwd?: string
   isMdx: boolean
   process?: boolean
-  ignoreRemarkConfig?: boolean
 }
 
 export interface WorkerParseResult {
diff --git a/packages/eslint-mdx/src/worker.ts b/packages/eslint-mdx/src/worker.ts
@@ -86,19 +86,26 @@ const ignoreCheckCache = new Map<
   (filePath: string) => Promise<boolean>
 >()
 
-const getRemarkConfig = async (filePath: string, cwd: string) => {
-  let configLoad = configLoadCache.get(cwd)
+const getRemarkConfig = async (
+  filePath: string,
+  cwd: string,
+  remarkConfigPath?: string,
+) => {
+  const cacheKey = remarkConfigPath ? `${cwd}\0${remarkConfigPath}` : cwd
+
+  let configLoad = configLoadCache.get(cacheKey)
 
   if (!configLoad) {
     const config = new Configuration({
       cwd,
       packageField: 'remarkConfig',
       pluginPrefix: 'remark',
       rcName: '.remarkrc',
+      rcPath: remarkConfigPath,
       detectConfig: true,
     })
     configLoad = promisify(config.load.bind(config))
-    configLoadCache.set(cwd, configLoad)
+    configLoadCache.set(cacheKey, configLoad)
   }
 
   if (!Ignore) {
@@ -109,7 +116,7 @@ const getRemarkConfig = async (filePath: string, cwd: string) => {
     )) as { Ignore: IgnoreClass })
   }
 
-  let ignoreCheck = ignoreCheckCache.get(cwd)
+  let ignoreCheck = ignoreCheckCache.get(cacheKey)
 
   if (!ignoreCheck) {
     const ignore = new Ignore({
@@ -118,7 +125,7 @@ const getRemarkConfig = async (filePath: string, cwd: string) => {
       detectIgnore: true,
     })
     ignoreCheck = promisify(ignore.check.bind(ignore))
-    ignoreCheckCache.set(cwd, ignoreCheck)
+    ignoreCheckCache.set(cacheKey, ignoreCheck)
   }
 
   return configLoad(filePath)
@@ -142,6 +149,7 @@ export const getRemarkProcessor = async (
   isMdx: boolean,
   ignoreRemarkConfig?: boolean,
   cwd = process.cwd(),
+  remarkConfigPath?: string,
 ) => {
   const initCacheKey = `${String(isMdx)}-${cwd}\0${filePath}`
 
@@ -153,7 +161,7 @@ export const getRemarkProcessor = async (
 
   const result = ignoreRemarkConfig
     ? null
-    : await getRemarkConfig(filePath, cwd)
+    : await getRemarkConfig(filePath, cwd, remarkConfigPath)
 
   const cacheKey = result?.filePath
     ? `${String(isMdx)}-${result.filePath}`
@@ -227,6 +235,8 @@ runAsWorker(
     isMdx,
     process,
     ignoreRemarkConfig,
+    remarkConfigPath,
+    // eslint-disable-next-line sonarjs/cognitive-complexity
   }: WorkerOptions): Promise<WorkerResult> => {
     sharedTokens.length = 0
 
@@ -245,6 +255,7 @@ runAsWorker(
       isMdx,
       ignoreRemarkConfig,
       cwd,
+      remarkConfigPath,
     )
 
     const fileOptions: VFileOptions = {
@@ -254,7 +265,9 @@ runAsWorker(
     }
 
     if (process) {
-      if (await ignoreCheckCache.get(cwd)(filePath)) {
+      const cacheKey = remarkConfigPath ? `${cwd}\0${remarkConfigPath}` : cwd
+
+      if (await ignoreCheckCache.get(cacheKey)(filePath)) {
         return {
           messages: [],
         }
diff --git a/packages/eslint-plugin-mdx/README.md b/packages/eslint-plugin-mdx/README.md
@@ -100,6 +100,10 @@ npm i -D eslint-plugin-mdx
     // optional, if you want to disable language mapper, set it to `false`
     // if you want to override the default language mapper inside, you can provide your own
     "mdx/language-mapper": {},
+    // optional, same as the `parserOptions.ignoreRemarkConfig`, you have to specify it twice unfortunately
+    "mdx/ignore-remark-config": true,
+    // optional, same as the `parserOptions.remarkConfigPath`, you have to specify it twice unfortunately
+    "mdx/remark-config-path": "path/to/your/remarkrc",
   },
 }
 ```
@@ -120,6 +124,10 @@ export default [
       // optional, if you want to disable language mapper, set it to `false`
       // if you want to override the default language mapper inside, you can provide your own
       languageMapper: {},
+      // optional, same as the `parserOptions.ignoreRemarkConfig`, you have to specify it twice unfortunately
+      ignoreRemarkConfig: true,
+      // optional, same as the `parserOptions.remarkConfigPath`, you have to specify it twice unfortunately
+      remarkConfigPath: 'path/to/your/remarkrc',
     }),
   },
   {
@@ -148,6 +156,8 @@ eslint . --ext js,md,mdx
 
 3. `ignoreRemarkConfig` (`boolean`): Ignore the `remark` configuration defined in the project.
 
+4. `remarkConfigPath` (`string`): Specify the path to the `remark` configuration file, could be relative to `CWD` or absolute path.
+
 ## Parser API
 
 ### `MDXCode`
diff --git a/packages/eslint-plugin-mdx/src/processors/markdown.ts b/packages/eslint-plugin-mdx/src/processors/markdown.ts
@@ -4,7 +4,7 @@ import fs from 'node:fs'
 import path from 'node:path'
 
 import type { AST, Linter, Rule } from 'eslint'
-import { performSyncWork } from 'eslint-mdx'
+import { type SyncOptions, performSyncWork } from 'eslint-mdx'
 import type { Node, Parent, Nodes, Root, RootContentMap } from 'mdast'
 import type { MdxFlowExpression, MdxTextExpression } from 'mdast-util-mdx'
 
@@ -293,14 +293,19 @@ function getOnDiskFilepath(filepath: string): string {
  * @param filename The filename of the file
  * @returns Source code blocks to lint.
  */
-function preprocess(sourceText: string, filename: string) {
+function preprocess(
+  sourceText: string,
+  filename: string,
+  syncOptions: SyncOptions,
+) {
   // istanbul ignore next
   const text = sourceText.startsWith(BOM) ? sourceText.slice(1) : sourceText
   const { root } = performSyncWork({
     filePath: getOnDiskFilepath(filename),
     code: text,
     // FIXME: how to read `extensions` and `markdownExtensions` parser options?
     isMdx: filename.endsWith('.mdx'),
+    ...syncOptions,
   })
   const blocks: CodeBlock[] = []
 
diff --git a/packages/eslint-plugin-mdx/src/processors/options.ts b/packages/eslint-plugin-mdx/src/processors/options.ts
@@ -48,8 +48,10 @@ ESLinter.prototype.verify = function (
     ) ?? config
   ).settings ?? {}) as ESLintMdxSettings
 
-  processorOptions.lintCodeBlocks = settings['mdx/code-blocks'] === true
+  processorOptions.lintCodeBlocks = settings['mdx/code-blocks']
   processorOptions.languageMapper = settings['mdx/language-mapper']
+  processorOptions.ignoreRemarkConfig = settings['mdx/ignore-remark-config']
+  processorOptions.remarkConfigPath = settings['mdx/remark-config-path']
 
   // call original Linter#verify
   return verify.call(this, code, config, options as ESLint.Linter.LintOptions)
diff --git a/packages/eslint-plugin-mdx/src/processors/remark.ts b/packages/eslint-plugin-mdx/src/processors/remark.ts
@@ -7,29 +7,31 @@ import { getShortLang } from './helpers.js'
 import { markdownProcessor } from './markdown.js'
 import { processorOptions as defaultProcessorOptions } from './options.js'
 
-export const createRemarkProcessor = (
-  processorOptions = defaultProcessorOptions,
-): Linter.Processor => ({
+export const createRemarkProcessor = ({
+  languageMapper,
+  lintCodeBlocks,
+  ...syncOptions
+} = defaultProcessorOptions): Linter.Processor => ({
   meta: {
     name: 'mdx/remark',
     version: meta.version,
   },
   supportsAutofix: true,
   preprocess(text, filename) {
-    if (!processorOptions.lintCodeBlocks) {
+    if (!lintCodeBlocks) {
       return [text]
     }
 
     return [
       text,
       ...markdownProcessor
-        .preprocess(text, filename)
+        .preprocess(text, filename, syncOptions)
         .map(({ text, filename }) => ({
           text,
           filename:
             filename.slice(0, filename.lastIndexOf('.')) +
             '.' +
-            getShortLang(filename, processorOptions.languageMapper),
+            getShortLang(filename, languageMapper),
         })),
     ]
   },
diff --git a/packages/eslint-plugin-mdx/src/processors/types.ts b/packages/eslint-plugin-mdx/src/processors/types.ts
@@ -1,12 +1,15 @@
+import type { SyncOptions } from 'eslint-mdx'
 import type { Code } from 'mdast'
 
 export interface ESLintMdxSettings {
   'mdx/code-blocks'?: boolean
   'mdx/language-mapper'?: Record<string, string> | false
+  'mdx/ignore-remark-config'?: boolean
+  'mdx/remark-config-path'?: string
 }
 
-export interface ProcessorOptions {
-  lintCodeBlocks: boolean
+export interface ProcessorOptions extends SyncOptions {
+  lintCodeBlocks?: boolean
   languageMapper?: Record<string, string> | false
 }
 
diff --git a/test/__snapshots__/fixtures.test.ts.snap b/test/__snapshots__/fixtures.test.ts.snap
@@ -1677,6 +1677,8 @@ exports[`fixtures should match all snapshots: comments.mdx 1`] = `
 ]
 `;
 
+exports[`fixtures should match all snapshots: custom-remarkrc/test.md 1`] = `[]`;
+
 exports[`fixtures should match all snapshots: details.mdx 1`] = `
 [
   {
diff --git a/test/fixtures.test.ts b/test/fixtures.test.ts
@@ -10,8 +10,14 @@ import { config, configs } from 'typescript-eslint'
 
 import * as mdx from 'eslint-plugin-mdx'
 
-const getCli = (lintCodeBlocks = false, fix?: boolean) =>
-  new TSESLint.ESLint({
+const fixturesDir = path.resolve('test/fixtures')
+
+const getCli = (lintCodeBlocks = false, fix?: boolean) => {
+  const remarkConfigPath = path.resolve(
+    fixturesDir,
+    'custom-remarkrc/my-remarkrc.mjs',
+  )
+  return new TSESLint.ESLint({
     fix,
     overrideConfigFile: true,
     overrideConfig: config(
@@ -30,8 +36,6 @@ const getCli = (lintCodeBlocks = false, fix?: boolean) =>
         }),
         languageOptions: {
           parserOptions: {
-            ecmaVersion: 'latest',
-            sourceType: 'module',
             ecmaFeatures: {
               jsx: true,
             },
@@ -51,13 +55,24 @@ const getCli = (lintCodeBlocks = false, fix?: boolean) =>
           'react/self-closing-comp': 'error',
         },
       },
+      {
+        files: ['**/custom-remarkrc/test.md'],
+        processor: mdx.createRemarkProcessor({
+          lintCodeBlocks,
+          remarkConfigPath,
+        }),
+        languageOptions: {
+          parserOptions: {
+            remarkConfigPath,
+          },
+        },
+      },
     ),
   })
+}
 
 const ONE_MINUTE = 60_000
 
-const fixturesDir = path.resolve('test/fixtures')
-
 const relative = (filePath: string) =>
   path.relative(fixturesDir, filePath).replaceAll('\\', '/')
 
diff --git a/test/fixtures/custom-remarkrc/my-remarkrc.mjs b/test/fixtures/custom-remarkrc/my-remarkrc.mjs
diff --git a/test/fixtures/custom-remarkrc/test.md b/test/fixtures/custom-remarkrc/test.md
