chore: fix lint issues

JounQin · JounQin · commit 0932a47d903b · 2025-04-22T12:07:06.000+08:00
diff --git a/package.json b/package.json
@@ -42,7 +42,8 @@
     "@types/unist": "^3.0.3",
     "@unts/patch-package": "^8.1.1",
     "concurrently": "^9.1.2",
-    "eslint": "^9.25.0",
+    "eslint": "^9.25.1",
+    "eslint-plugin-jest": "^28.11.0",
     "eslint-plugin-react": "^7.37.5",
     "globals": "^16.0.0",
     "jest": "^30.0.0-alpha.7",
diff --git a/packages/eslint-mdx/shim.d.ts b/packages/eslint-mdx/shim.d.ts
@@ -4,42 +4,26 @@ declare module 'espree/lib/token-translator' {
   export default TokenTranslator
 
   export interface Location {
-    /**
-     * The start position.
-     */
+    /** The start position. */
     start: acorn.Position
-    /**
-     * The end position.
-     */
+    /** The end position. */
     end: acorn.Position
   }
 
   export type Range = [number, number]
 
   export interface EsprimaToken {
-    /**
-     * The type of this token.
-     */
+    /** The type of this token. */
     type: string
-    /**
-     * The string content of the token.
-     */
+    /** The string content of the token. */
     value: string
-    /**
-     * Location in source text.
-     */
+    /** Location in source text. */
     loc: Location | undefined
-    /**
-     * start column.
-     */
+    /** Start column. */
     start: number | undefined
-    /**
-     * end column.
-     */
+    /** End column. */
     end: number | undefined
-    /**
-     * [start, end] range
-     */
+    /** [start, end] range */
     range: Range | undefined
   }
 
diff --git a/packages/eslint-mdx/src/helpers.ts b/packages/eslint-mdx/src/helpers.ts
@@ -17,9 +17,9 @@ export const arrayify = <T, R = T extends Array<infer S> ? S : T>(
   }, [])
 
 /**
- * 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
+ * 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
  */
 export const getPhysicalFilename = (
   filename: string,
@@ -122,5 +122,6 @@ export const nextCharOffsetFactory = (text: string) => {
 }
 
 /* istanbul ignore next */
-export const cjsRequire: CjsRequire =
-  typeof require === 'undefined' ? createRequire(import.meta.url) : require
+export const cjsRequire: CjsRequire = import.meta.url
+  ? createRequire(import.meta.url)
+  : require
diff --git a/packages/eslint-mdx/src/tokens.ts b/packages/eslint-mdx/src/tokens.ts
@@ -132,7 +132,8 @@ export const restoreTokens = (
       }
 
       /**
-       * not available yet
+       * Not available yet
+       *
        * @see https://github.com/mdx-js/mdx/issues/2034
        */
 
diff --git a/packages/eslint-mdx/src/types.ts b/packages/eslint-mdx/src/types.ts
@@ -74,7 +74,7 @@ export interface PackageJson {
 }
 
 /**
- * temporary workaround for missing `Ignore` from `unified-engine`
+ * Temporary workaround for missing `Ignore` from `unified-engine`
  *
  * See also {@link https://github.com/unifiedjs/unified-engine/pull/79}
  *
@@ -91,16 +91,10 @@ export type IgnoreClass = typeof Ignore
 export type Callback = (error?: Error, result?: boolean) => void
 
 export interface Options {
-  /**
-   *   Base.
-   */
+  /** Base. */
   cwd: string
-  /**
-   *   Whether to detect ignore files.
-   */
+  /** Whether to detect ignore files. */
   detectIgnore: boolean | undefined
-  /**
-   *   Basename of ignore files.
-   */
+  /** Basename of ignore files. */
   ignoreName?: string
 }
diff --git a/packages/eslint-mdx/src/worker.ts b/packages/eslint-mdx/src/worker.ts
@@ -231,9 +231,9 @@ runAsWorker(
     sharedTokens.length = 0
 
     /**
-     * unified plugins are using ESM version of acorn,
-     * so we have to use the same version as well,
-     * otherwise the TokenType will be different class
+     * Unified plugins are using ESM version of acorn, so we have to use the
+     * same version as well, otherwise the TokenType will be different class
+     *
      * @see also https://github.com/acornjs/acorn-jsx/issues/133
      */
     if (!acornParser) {
@@ -754,7 +754,8 @@ runAsWorker(
         }
 
         /**
-         * Copied from @see https://github.com/eslint/espree/blob/1584ddb00f0b4e3ada764ac86ae20e1480003de3/lib/espree.js#L227-L241
+         * Copied from @see
+         * https://github.com/eslint/espree/blob/1584ddb00f0b4e3ada764ac86ae20e1480003de3/lib/espree.js#L227-L241
          */
         const templateElement = node
 
diff --git a/packages/eslint-plugin-mdx/src/configs/recommended.ts b/packages/eslint-plugin-mdx/src/configs/recommended.ts
@@ -29,9 +29,7 @@ const addPrettierRules = () => {
     /* istanbul ignore next */
     const version = meta?.version || ''
 
-    /**
-     * @see https://github.com/prettier/eslint-plugin-prettier/releases/tag/v5.1.2
-     */
+    /** @see https://github.com/prettier/eslint-plugin-prettier/releases/tag/v5.1.2 */
     const [major, minor, patch] = version.split('.')
 
     /* istanbul ignore if -- We can't cover all versions in one test */
diff --git a/packages/eslint-plugin-mdx/src/helpers.ts b/packages/eslint-plugin-mdx/src/helpers.ts
@@ -23,5 +23,6 @@ export const getGlobals = <
   )
 
 /* istanbul ignore next */
-export const cjsRequire: CjsRequire =
-  typeof require === 'undefined' ? createRequire(import.meta.url) : require
+export const cjsRequire: CjsRequire = import.meta.url
+  ? createRequire(import.meta.url)
+  : require
diff --git a/packages/eslint-plugin-mdx/src/processors/markdown.ts b/packages/eslint-plugin-mdx/src/processors/markdown.ts
@@ -1,6 +1,4 @@
-/**
- * {@link https://github.com/eslint/markdown/blob/f17311eb250fe3f41a24fd52be9c6713d12b7d67/src/processor.js}
- */
+/** {@link https://github.com/eslint/markdown/blob/f17311eb250fe3f41a24fd52be9c6713d12b7d67/src/processor.js} */
 
 import type { AST, Linter, Rule } from 'eslint'
 import type { Node, Parent, Nodes, Root, RootContentMap } from 'mdast'
@@ -23,6 +21,7 @@ const blocksCache: Map<string, CodeBlock[]> = new Map()
 
 /**
  * Performs a depth-first traversal of the Markdown AST.
+ *
  * @param node A Markdown AST node.
  * @param callbacks A map of node types to callbacks.
  */
@@ -66,9 +65,10 @@ const eslintCommentRegex = /^(?:eslint\b|global\s)/u
 
 /**
  * Extracts `eslint-*` or `global` comments from HTML/MDX comments if present.
+ *
  * @param value The text content of an HTML/MDX AST node.
- * @returns The comment's text without the opening and closing tags or
- *     an empty string if the text is not an ESLint HTML/MDX comment.
+ * @returns The comment's text without the opening and closing tags or an empty
+ *   string if the text is not an ESLint HTML/MDX comment.
  */
 function getComment(value: string, isMdx = false) {
   const [commentStart, commentEnd] = COMMENTS[+isMdx]
@@ -96,8 +96,9 @@ function getComment(value: string, isMdx = false) {
 const leadingWhitespaceRegex = /^[>\s]*/u
 
 /**
- * Gets the offset for the first column of the node's first line in the
- * original source text.
+ * Gets the offset for the first column of the node's first line in the original
+ * source text.
+ *
  * @param node A Markdown code block AST node.
  * @returns The offset for the first column of the node's first line.
  */
@@ -108,10 +109,11 @@ function getBeginningOfLineOffset(node: Node) {
 /**
  * Gets the leading text, typically whitespace with possible blockquote chars,
  * used to indent a code block.
+ *
  * @param text The text of the file.
  * @param node A Markdown code block AST node.
- * @returns The text from the start of the first line to the opening
- *     fence of the code block.
+ * @returns The text from the start of the first line to the opening fence of
+ *   the code block.
  */
 function getIndentText(text: string, node: Node) {
   return leadingWhitespaceRegex.exec(
@@ -122,7 +124,8 @@ function getIndentText(text: string, node: Node) {
 /**
  * When applying fixes, the postprocess step needs to know how to map fix ranges
  * from their location in the linted JS to the original offset in the Markdown.
- * Configuration comments and indentation trimming both complicate this process.
+ * Configuration comments and indentation trimming both complicate this
+ * process.
  *
  * Configuration comments appear in the linted JS but not in the Markdown code
  * block. Fixes to configuration comments would cause undefined behavior and
@@ -142,23 +145,24 @@ function getIndentText(text: string, node: Node) {
  * suffix of the corresponding line in the Markdown code block. There are no
  * differences within the line, so the mapping need only provide the offset
  * delta at the beginning of each line.
+ *
  * @param text The text of the file.
  * @param node A Markdown code block AST node.
- * @param comments List of configuration comment strings that will be
- *     inserted at the beginning of the code block.
- * @returns A list of offset-based adjustments, where lookups are
- *     done based on the `js` key, which represents the range in the linted JS,
- *     and the `md` key is the offset delta that, when added to the JS range,
- *     returns the corresponding location in the original Markdown source.
+ * @param comments List of configuration comment strings that will be inserted
+ *   at the beginning of the code block.
+ * @returns A list of offset-based adjustments, where lookups are done based on
+ *   the `js` key, which represents the range in the linted JS, and the `md` key
+ *   is the offset delta that, when added to the JS range, returns the
+ *   corresponding location in the original Markdown source.
  */
 function getBlockRangeMap(text: string, node: Node, comments: string[]) {
   /**
    * The parser sets the fenced code block's start offset to wherever content
    * should normally begin (typically the first column of the line, but more
    * inside a list item, for example). The code block's opening fence may be
    * further indented by up to three characters. If the code block has
-   * additional indenting, the opening fence's first backtick may be up to
-   * three whitespace characters after the start offset.
+   * additional indenting, the opening fence's first backtick may be up to three
+   * whitespace characters after the start offset.
    */
   const startOffset = getBeginningOfLineOffset(node)
 
@@ -178,8 +182,8 @@ function getBlockRangeMap(text: string, node: Node, comments: string[]) {
   const baseIndent = getIndentText(text, node).length
 
   /**
-   * Track the length of any inserted configuration comments at the beginning
-   * of the linted JS and start the JS offset lookup keys at this index.
+   * Track the length of any inserted configuration comments at the beginning of
+   * the linted JS and start the JS offset lookup keys at this index.
    */
   const commentLength = comments.reduce(
     (len, comment) => len + comment.length + 1,
@@ -188,9 +192,9 @@ function getBlockRangeMap(text: string, node: Node, comments: string[]) {
 
   /**
    * In case there are configuration comments, initialize the map so that the
-   * first lookup index is always 0. If there are no configuration comments,
-   * the lookup index will also be 0, and the lookup should always go to the
-   * last range that matches, skipping this initialization entry.
+   * first lookup index is always 0. If there are no configuration comments, the
+   * lookup index will also be 0, and the lookup should always go to the last
+   * range that matches, skipping this initialization entry.
    */
   const rangeMap: RangeMap[] = [
     {
@@ -247,6 +251,7 @@ const codeBlockFileNameRegex =
 
 /**
  * Parses the file name from a block meta, if available.
+ *
  * @param block A code block.
  * @returns The filename, if parsed from block meta.
  */
@@ -259,6 +264,7 @@ function fileNameFromMeta(block: CodeBlock) {
 
 /**
  * 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.
@@ -278,10 +284,10 @@ function preprocess(sourceText: string, filename: string) {
 
   /**
    * During the depth-first traversal, keep track of any sequences of HTML/MDX
-   * comment nodes containing `eslint-*` or `global` comments. If a code
-   * block immediately follows such a sequence, insert the comments at the
-   * top of the code block. Any non-ESLint comment or other node type breaks
-   * and empties the sequence.
+   * comment nodes containing `eslint-*` or `global` comments. If a code block
+   * immediately follows such a sequence, insert the comments at the top of the
+   * code block. Any non-ESLint comment or other node type breaks and empties
+   * the sequence.
    */
   let allComments: string[] = []
 
@@ -301,6 +307,7 @@ function preprocess(sourceText: string, filename: string) {
 
     /**
      * Visit a code node.
+     *
      * @param node The visited node.
      */
     code(node) {
@@ -331,6 +338,7 @@ function preprocess(sourceText: string, filename: string) {
 
     /**
      * Visit an HTML node.
+     *
      * @param node The visited node.
      */
     html(node) {
@@ -357,6 +365,7 @@ function preprocess(sourceText: string, filename: string) {
 
 /**
  * Adjusts a fix in a code block.
+ *
  * @param block A code block.
  * @param fix A fix to adjust.
  * @returns The fix with adjusted ranges.
@@ -382,6 +391,7 @@ function adjustFix(block: CodeBlock, fix: Rule.Fix): Rule.Fix {
 
 /**
  * Creates a map function that adjusts messages in a code block.
+ *
  * @param block A code block.
  * @returns A function that adjusts messages in a code block.
  */
@@ -395,6 +405,7 @@ function adjustBlock(block: CodeBlock) {
 
   /**
    * Adjusts ESLint messages to point to the correct location in the Markdown.
+   *
    * @param message A message from ESLint.
    * @returns The same message, but adjusted to the correct location.
    */
@@ -447,6 +458,7 @@ function adjustBlock(block: CodeBlock) {
 
 /**
  * Excludes unsatisfiable rules from the list of messages.
+ *
  * @param message A message from the linter.
  * @returns True if the message should be included in output.
  */
@@ -456,8 +468,9 @@ function excludeUnsatisfiableRules(message: Linter.LintMessage) {
 
 /**
  * Transforms generated messages for output.
- * @param messages An array containing one array of messages
- *     for each code block returned from `preprocess`.
+ *
+ * @param messages An array containing one array of messages for each code block
+ *   returned from `preprocess`.
  * @param filename The filename of the file
  * @returns A flattened array of messages with mapped locations.
  */
diff --git a/packages/eslint-plugin-mdx/src/processors/options.ts b/packages/eslint-plugin-mdx/src/processors/options.ts
@@ -1,5 +1,6 @@
 /**
- * based on @link https://github.com/sveltejs/eslint-plugin-svelte3/blob/master/src/processor_options.js
+ * Based on @link
+ * https://github.com/sveltejs/eslint-plugin-svelte3/blob/master/src/processor_options.js
  */
 
 import type * as ESLint from 'eslint'
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -132,7 +132,8 @@ export const restoreTokens = (`
`132`	`132`	`}`
`133`	`133`
`134`	`134`	`/**`
`135`		`- * not available yet`
	`135`	`+ * Not available yet`
	`136`	`+ *`
`136`	`137`	`* @see https://github.com/mdx-js/mdx/issues/2034`
`137`	`138`	`*/`
`138`	`139`
Original file line number	Diff line number	Diff line change
`@@ -23,5 +23,6 @@ export const getGlobals = <`
`23`	`23`	`)`
`24`	`24`
`25`	`25`	`/* istanbul ignore next */`
`26`		`-export const cjsRequire: CjsRequire =`
`27`		`- typeof require === 'undefined' ? createRequire(import.meta.url) : require`
	`26`	`+export const cjsRequire: CjsRequire = import.meta.url`
	`27`	`+ ? createRequire(import.meta.url)`
	`28`	`+ : require`