Remove some unneeded ts-expect-errors

mdx-js · Oct 15, 2024 · 6ccc003 · 6ccc003
1 parent 6819e55
commit 6ccc003
Show file tree

Hide file tree

Showing 10 changed files with 79 additions and 53 deletions.
diff --git a/docs/_asset/editor.jsx b/docs/_asset/editor.jsx
@@ -662,9 +662,7 @@ function cleanUnistNode(node) {
  */
 function removeFromEstree(node) {
   delete node.loc
-  // @ts-expect-error: this field is added by acorn.
   delete node.start
-  // @ts-expect-error: this field is added by acorn.
   delete node.end
   delete node.range
 }
diff --git a/docs/docs/getting-started.mdx b/docs/docs/getting-started.mdx
@@ -454,7 +454,7 @@ for more info.
      * @returns {unknown}
      */
     function compiler(tree) {
-      // @ts-expect-error TS2349: This expression *is* callable, `estreeToBabel` types are wrong.
+      // @ts-expect-error: TS2349: This expression *is* callable, `estreeToBabel` types are wrong.
       return estreeToBabel(tree)
     }
   }
@@ -526,7 +526,7 @@ for more info.
      * @returns {unknown}
      */
     function compiler(tree) {
-      // @ts-expect-error TS2349: This expression *is* callable, `estreeToBabel` types are wrong.
+      // @ts-expect-error: TS2349: This expression *is* callable, `estreeToBabel` types are wrong.
       return estreeToBabel(tree)
     }
   }

diff --git a/packages/mdx/lib/core.js b/packages/mdx/lib/core.js
@@ -5,6 +5,7 @@
  * @import {Options as RemarkRehypeOptions} from 'remark-rehype'
  * @import {SourceMapGenerator} from 'source-map'
  * @import {PluggableList, Processor} from 'unified'
+ * @import {Node} from 'unist'
  */
 
 /**
@@ -217,6 +218,8 @@ export function createProcessor(options) {
   }
 
   pipeline
+    // @ts-expect-error: `Program` is close enough to a `Node`,
+    // but type inference has trouble with it and bridges.
     .use(rehypeRecma, settings)
     .use(recmaDocument, settings)
     .use(recmaJsxRewrite, settings)
@@ -225,8 +228,10 @@ export function createProcessor(options) {
     pipeline.use(recmaJsxBuild, settings)
   }
 
+  // @ts-expect-error: `Program` is close enough to a `Node`,
+  // but type inference has trouble with it and bridges.
   pipeline.use(recmaStringify, settings).use(settings.recmaPlugins || [])
 
-  // @ts-expect-error: we added plugins with if-checks, which TS doesn’t get.
+  // @ts-expect-error: TS doesn’t get the plugins we added with if-statements.
   return pipeline
 }
diff --git a/packages/mdx/lib/plugin/recma-stringify.js b/packages/mdx/lib/plugin/recma-stringify.js
@@ -1,6 +1,6 @@
 /**
  * @import {Program} from 'estree-jsx'
- * @import {Plugin, Processor} from 'unified'
+ * @import {Processor} from 'unified'
  * @import {VFile} from 'vfile'
  * @import {ProcessorOptions} from '../core.js'
  */
@@ -10,18 +10,15 @@ import {jsx, toJs} from 'estree-util-to-js'
 /**
  * Serialize an esast (estree) program to JavaScript.
  *
- * @type {Plugin<[Readonly<ProcessorOptions>], Program, string>}
+ * @this {Processor<undefined, undefined, undefined, Program, string>}
+ *   Processor.
+ * @param {Readonly<ProcessorOptions>} options
+ *   Configuration.
  */
 export function recmaStringify(options) {
-  // eslint-disable-next-line unicorn/no-this-assignment
-  const self =
-    // @ts-expect-error: TS is wrong about `this`.
-    /** @type {Processor<undefined, undefined, undefined, Program, string>} */ (
-      this
-    )
   const {SourceMapGenerator} = options
 
-  self.compiler = compiler
+  this.compiler = compiler
 
   /**
    * @param {Program} tree

diff --git a/packages/mdx/lib/types.d.ts b/packages/mdx/lib/types.d.ts
@@ -1,3 +1,4 @@
+import type {Program as EstreeProgram} from 'estree'
 import type {Data as UnistData} from 'unist'
 
 interface EsastData extends UnistData {
@@ -63,3 +64,9 @@ declare module 'mdast-util-mdx-jsx' {
     _mdxExplicitJsx?: boolean | null | undefined
   }
 }
+
+declare module 'unified' {
+  interface CompileResultMap {
+    EstreeProgram: EstreeProgram
+  }
+}
diff --git a/packages/mdx/lib/util/estree-util-create.js b/packages/mdx/lib/util/estree-util-create.js
@@ -15,8 +15,7 @@
  */
 export function create(from, to) {
   /** @type {Array<keyof Node>} */
-  // @ts-expect-error: `start`, `end`, `comments` are custom Acorn fields.
-  const fields = ['start', 'end', 'loc', 'range', 'comments']
+  const fields = ['start', 'end', 'loc', 'range']
   let index = -1
 
   while (++index < fields.length) {

diff --git a/packages/preact/test/index.jsx b/packages/preact/test/index.jsx
@@ -37,9 +37,9 @@ test('@mdx-js/preact', async function (t) {
         render(
           <MDXProvider
             components={{
-              // @ts-expect-error TODO configure TypeScript project references
+              // @ts-expect-error: TODO configure TypeScript project references
               h1(properties) {
-                // @ts-expect-error TODO configure TypeScript project references
+                // @ts-expect-error: TODO configure TypeScript project references
                 return <h1 style={{color: 'tomato'}} {...properties} />
               }
             }}
@@ -68,7 +68,7 @@ test('@mdx-js/preact', async function (t) {
              * @returns
              *   Element.
              */
-            // @ts-expect-error TODO configure TypeScript project references
+            // @ts-expect-error: TODO configure TypeScript project references
             wrapper(properties) {
               return <div id="layout" {...properties} />
             }
@@ -93,23 +93,23 @@ test('@mdx-js/preact', async function (t) {
         render(
           <MDXProvider
             components={{
-              // @ts-expect-error TODO configure TypeScript project references
+              // @ts-expect-error: TODO configure TypeScript project references
               h1(properties) {
-                // @ts-expect-error TODO configure TypeScript project references
+                // @ts-expect-error: TODO configure TypeScript project references
                 return <h1 style={{color: 'tomato'}} {...properties} />
               },
-              // @ts-expect-error TODO configure TypeScript project references
+              // @ts-expect-error: TODO configure TypeScript project references
               h2(properties) {
-                // @ts-expect-error TODO configure TypeScript project references
+                // @ts-expect-error: TODO configure TypeScript project references
                 return <h2 style={{color: 'rebeccapurple'}} {...properties} />
               }
             }}
           >
             <MDXProvider
               components={{
-                // @ts-expect-error TODO configure TypeScript project references
+                // @ts-expect-error: TODO configure TypeScript project references
                 h2(properties) {
-                  // @ts-expect-error TODO configure TypeScript project references
+                  // @ts-expect-error: TODO configure TypeScript project references
                   return <h2 style={{color: 'papayawhip'}} {...properties} />
                 }
               }}
@@ -133,24 +133,24 @@ test('@mdx-js/preact', async function (t) {
       render(
         <MDXProvider
           components={{
-            // @ts-expect-error TODO configure TypeScript project references
+            // @ts-expect-error: TODO configure TypeScript project references
             h1(properties) {
-              // @ts-expect-error TODO configure TypeScript project references
+              // @ts-expect-error: TODO configure TypeScript project references
               return <h1 style={{color: 'tomato'}} {...properties} />
             },
-            // @ts-expect-error TODO configure TypeScript project references
+            // @ts-expect-error: TODO configure TypeScript project references
             h2(properties) {
-              // @ts-expect-error TODO configure TypeScript project references
+              // @ts-expect-error: TODO configure TypeScript project references
               return <h2 style={{color: 'rebeccapurple'}} {...properties} />
             }
           }}
         >
           <MDXProvider
-            // @ts-expect-error TODO configure TypeScript project references
+            // @ts-expect-error: TODO configure TypeScript project references
             components={function () {
               return {
                 h2(properties) {
-                  // @ts-expect-error TODO configure TypeScript project references
+                  // @ts-expect-error: TODO configure TypeScript project references
                   return <h2 style={{color: 'papayawhip'}} {...properties} />
                 }
               }
@@ -176,9 +176,9 @@ test('@mdx-js/preact', async function (t) {
         render(
           <MDXProvider
             components={{
-              // @ts-expect-error TODO configure TypeScript project references
+              // @ts-expect-error: TODO configure TypeScript project references
               h1(properties) {
-                // @ts-expect-error TODO configure TypeScript project references
+                // @ts-expect-error: TODO configure TypeScript project references
                 return <h1 style={{color: 'tomato'}} {...properties} />
               }
             }}
@@ -205,20 +205,20 @@ test('@mdx-js/preact', async function (t) {
         render(
           <MDXProvider
             components={{
-              // @ts-expect-error TODO configure TypeScript project references
+              // @ts-expect-error: TODO configure TypeScript project references
               h1(properties) {
-                // @ts-expect-error TODO configure TypeScript project references
+                // @ts-expect-error: TODO configure TypeScript project references
                 return <h1 style={{color: 'tomato'}} {...properties} />
               }
             }}
           >
             <MDXProvider
               disableParentContext
-              // @ts-expect-error TODO configure TypeScript project references
+              // @ts-expect-error: TODO configure TypeScript project references
               components={function () {
                 return {
                   h2(properties) {
-                    // @ts-expect-error TODO configure TypeScript project references
+                    // @ts-expect-error: TODO configure TypeScript project references
                     return <h2 style={{color: 'papayawhip'}} {...properties} />
                   }
                 }

diff --git a/packages/remark-mdx/lib/index.js b/packages/remark-mdx/lib/index.js
@@ -19,15 +19,15 @@ const emptyOptions = {}
  * Add support for MDX (JSX: `<Video id={123} />`, export/imports: `export {x}
  * from 'y'`; and expressions: `{1 + 1}`).
  *
+ * @this {Processor}
+ *   Processor.
  * @param {Readonly<Options> | null | undefined} [options]
  *   Configuration (optional).
  * @returns {undefined}
  *   Nothing.
  */
 export default function remarkMdx(options) {
-  // @ts-expect-error: TS is wrong about `this`.
-  // eslint-disable-next-line unicorn/no-this-assignment
-  const self = /** @type {Processor} */ (this)
+  const self = this
   const settings = options || emptyOptions
   const data = self.data()
 

diff --git a/packages/remark-mdx/package.json b/packages/remark-mdx/package.json
@@ -54,7 +54,8 @@
     "prettier": true,
     "rules": {
       "logical-assignment-operators": "off",
-      "n/file-extension-in-import": "off"
+      "n/file-extension-in-import": "off",
+      "unicorn/no-this-assignment": "off"
     }
   }
 }
diff --git a/website/types.d.ts b/website/types.d.ts
@@ -1,5 +1,36 @@
 import type {Author} from './generate.js'
 
+// Register data on `estree`.
+declare module 'estree' {
+  interface BaseNode {
+    /**
+     * Field patched by `acorn`.
+     *
+     * Registered by types for the MDX website for the playground.
+     */
+    end?: number | undefined
+
+    /**
+     * Field patched by `acorn`.
+     *
+     * Registered by types for the MDX website for the playground.
+     */
+    start?: number | undefined
+  }
+}
+
+// Register data on hast.
+declare module 'hast' {
+  interface ElementData {
+    /**
+     * `meta` field available on `<code>` elements; added by `mdast-util-to-hast`.
+     *
+     * Registered by `website/types.d.ts` for the MDX website.
+     */
+    meta?: string | null | undefined
+  }
+}
+
 // Add custom data supported when `rehype-document` is added.
 declare module 'vfile' {
   interface DataMapMeta {
@@ -22,15 +53,3 @@ declare module 'vfile' {
     meta: DataMapMeta
   }
 }
-
-// Register data on hast.
-declare module 'hast' {
-  interface ElementData {
-    /**
-     * `meta` field available on `<code>` elements; added by `mdast-util-to-hast`.
-     *
-     * Registered by `website/types.d.ts` for the MDX website.
-     */
-    meta?: string | null | undefined
-  }
-}