fix: parsing many comments error due to mutable regex (#227)

Co-authored-by: JounQin <[email protected]>

Author: nd0ut

packages/eslint-mdx/src/parser.ts

@@ -13,7 +13,11 @@ import {
   normalizePosition,
   restoreNodeLocation,
 } from './helper'
-import { COMMENT_CONTENT_REGEX, isComment } from './regexp'
+import {
+  COMMENT_CONTENT_REGEX,
+  COMMENT_CONTENT_REGEX_GLOBAL,
+  isComment,
+} from './regexp'
 import { traverse } from './traverse'
 import {
   Comment,
@@ -101,7 +105,7 @@ export class Parser {
           inline: !!parent && parent.type !== 'root',
         },
         value: value.replace(
-          COMMENT_CONTENT_REGEX,
+          COMMENT_CONTENT_REGEX_GLOBAL,
           (
             matched: string,
             $0: string,

packages/eslint-mdx/src/regexp.ts

@@ -26,6 +26,7 @@ export const selfClosingTag =
 export const comment = '<!---->|<!--(?:-?[^>-])(?:-?[^-])*-->'
 export const commentOpen = '(<!---*)'
 export const commentClose = '(-*-->)'
+export const commentContent = `${commentOpen}([\\s\\S]*?)${commentClose}`
 
 export const OPEN_TAG_REGEX = new RegExp(`^(?:${openTag})$`)
 export const CLOSE_TAG_REGEX = new RegExp(`^(?:${closeTag})$`)
@@ -34,10 +35,8 @@ export const OPEN_CLOSE_TAG_REGEX = new RegExp(
 )
 export const SELF_CLOSING_TAG_REGEX = new RegExp(`^(?:${selfClosingTag})$`)
 export const COMMENT_REGEX = new RegExp(`^(?:${comment})$`)
-export const COMMENT_CONTENT_REGEX = new RegExp(
-  `${commentOpen}([\\s\\S]*?)${commentClose}`,
-  'g',
-)
+export const COMMENT_CONTENT_REGEX = new RegExp(commentContent)
+export const COMMENT_CONTENT_REGEX_GLOBAL = new RegExp(commentContent, 'g')
 
 export const isOpenTag = (text: string) => OPEN_TAG_REGEX.test(text)
 export const isCloseTag = (text: string) => CLOSE_TAG_REGEX.test(text)

test/parser.test.ts

@@ -219,4 +219,12 @@ describe('parser', () => {
         filePath: 'test.md',
       }),
     ).not.toThrow())
+
+  it('should work with multiple comments', () =>
+    expect(() =>
+      parser.parse('<!-- * foo -->\n<!-- * bar -->', {
+        ...parserOptions,
+        filePath: 'test.mdx',
+      }),
+    ).not.toThrow())
 })