Trim references to shadow positions from diagnostics (#306)

Author: remcohaszing

.changeset/shadow-diagnostics.md

@@ -0,0 +1,5 @@
+---
+vscode-mdx: patch
+---
+
+Trim positions that can’t be mapped to the original MDX source code from diagnostics.

packages/language-server/tests/diagnostics.test.js

@@ -90,3 +90,23 @@ test('type errors', async () => {
     ]
   })
 })
+
+test('does not resolve shadow content', async () => {
+  await connection.sendRequest(InitializeRequest.type, {
+    processId: null,
+    rootUri: null,
+    capabilities: {}
+  })
+
+  const diagnosticsPromise = waitForDiagnostics(connection)
+  const textDocument = await openTextDocument(
+    connection,
+    'node16/link-reference.mdx'
+  )
+  const diagnostics = await diagnosticsPromise
+
+  assert.deepEqual(diagnostics, {
+    uri: textDocument.uri,
+    diagnostics: []
+  })
+})

packages/language-service/lib/index.js

@@ -1,9 +1,6 @@
 /**
- * @typedef {import('mdast').Root} Root
  * @typedef {import('typescript').Diagnostic} Diagnostic
- * @typedef {import('typescript').DiagnosticWithLocation} DiagnosticWithLocation
  * @typedef {import('typescript').DocumentSpan} DocumentSpan
- * @typedef {import('typescript').IScriptSnapshot} IScriptSnapshot
  * @typedef {import('typescript').LanguageService} LanguageService
  * @typedef {import('typescript').LanguageServiceHost} LanguageServiceHost
  * @typedef {import('typescript').NavigationBarItem} NavigationBarItem
@@ -371,32 +368,37 @@ export function createMdxLanguageService(ts, host, plugins) {
   }
 
   /**
-   * @param {Diagnostic} diagnostic
+   * @template {Diagnostic} T
+   * @param {readonly T[]} diagnostics
+   * @returns {T[]}
    */
-  function patchDiagnostic(diagnostic) {
-    const fileName = diagnostic.file?.fileName
-    if (!fileName || !isMdx(fileName)) {
-      return
-    }
+  function patchDiagnostics(diagnostics) {
+    /** @type {T[]} */
+    const result = []
 
-    const snapshot = getMdxSnapshot(fileName)
+    for (const diagnostic of diagnostics) {
+      const fileName = diagnostic.file?.fileName
+      if (!fileName || !isMdx(fileName)) {
+        result.push(diagnostic)
+        continue
+      }
 
-    if (!snapshot) {
-      return
-    }
+      const snapshot = getMdxSnapshot(fileName)
 
-    if (diagnostic.start !== undefined) {
-      diagnostic.start = snapshot.getRealPosition(diagnostic.start)
-    }
-  }
+      if (!snapshot) {
+        continue
+      }
 
-  /**
-   * @param {DiagnosticWithLocation[]} diagnostics
-   */
-  function patchDiagnosticsWithLocation(diagnostics) {
-    for (const diagnostic of diagnostics) {
-      patchDiagnostic(diagnostic)
+      if (diagnostic.start === undefined) {
+        result.push(diagnostic)
+      }
+
+      if (patchTextSpan(snapshot, /** @type {TextSpan} */ (diagnostic))) {
+        result.push(diagnostic)
+      }
     }
+
+    return result
   }
 
   return {
@@ -794,11 +796,7 @@ export function createMdxLanguageService(ts, host, plugins) {
       syncSnapshot(fileName)
       const diagnostics = ls.getSemanticDiagnostics(fileName)
 
-      for (const diagnostic of diagnostics) {
-        patchDiagnostic(diagnostic)
-      }
-
-      return diagnostics
+      return patchDiagnostics(diagnostics)
     },
 
     getSignatureHelpItems: notImplemented('getSignatureHelpItems'),
@@ -809,11 +807,7 @@ export function createMdxLanguageService(ts, host, plugins) {
       syncSnapshot(fileName)
       const diagnostics = ls.getSuggestionDiagnostics(fileName)
 
-      for (const diagnostic of diagnostics) {
-        patchDiagnostic(diagnostic)
-      }
-
-      return diagnostics
+      return patchDiagnostics(diagnostics)
     },
 
     getSyntacticClassifications: notImplemented('getSyntacticClassifications'),
@@ -826,9 +820,7 @@ export function createMdxLanguageService(ts, host, plugins) {
 
       const diagnostics = ls.getSyntacticDiagnostics(fileName)
 
-      patchDiagnosticsWithLocation(diagnostics)
-
-      return diagnostics
+      return patchDiagnostics(diagnostics)
     },
 
     getTodoComments: notImplemented('getTodoComments'),

packages/monaco/tests/diagnostics.test.js

@@ -23,50 +23,3 @@ test('syntax errors', async ({editor}) => {
     }
   ])
 })
-
-test('ESM errors', async ({editor}) => {
-  const result = await editor.waitForMarkers('file:///a.mdx', async () => {
-    await editor.createModel(
-      'export const foo = /** @type {boolean} */ (42)',
-      'file:///a.mdx'
-    )
-  })
-  expect(result).toStrictEqual([
-    {
-      code: '6133',
-      endColumn: 6,
-      endLineNumber: 1,
-      message: "'props' is declared but its value is never read.",
-      owner: 'mdx',
-      relatedInformation: [],
-      resource: 'file:///a.mdx',
-      severity: 1,
-      source: undefined,
-      startColumn: 1,
-      startLineNumber: 1,
-      tags: [1]
-    }
-  ])
-})
-
-test('JSX errors', async ({editor}) => {
-  const result = await editor.waitForMarkers('file:///a.mdx', async () => {
-    await editor.createModel('{/** @type {boolean} */ (42)}', 'file:///a.mdx')
-  })
-  expect(result).toStrictEqual([
-    {
-      code: '6133',
-      endColumn: 6,
-      endLineNumber: 1,
-      message: "'props' is declared but its value is never read.",
-      owner: 'mdx',
-      relatedInformation: [],
-      resource: 'file:///a.mdx',
-      severity: 1,
-      source: undefined,
-      startColumn: 1,
-      startLineNumber: 1,
-      tags: [1]
-    }
-  ])
-})