Use @import tags

remcohaszing · remcohaszing · commit bafdc57e39c7 · 2024-06-21T15:57:40.000+02:00
TypeScript 5.5 allows us to use `@import` tags to import types. This
syntax looks cleaner, but also they are actual type imports. They don’t
redefine types.
diff --git a/packages/language-server/index.js b/packages/language-server/index.js
@@ -1,9 +1,8 @@
 #!/usr/bin/env node
 
 /**
- * @typedef {import('@mdx-js/language-service').Commands} Commands
- * @typedef {import('unified').PluggableList} PluggableList
- * @typedef {import('unified').Plugin} Plugin
+ * @import {Commands} from '@mdx-js/language-service'
+ * @import {PluggableList, Plugin} from 'unified'
  */
 
 import assert from 'node:assert'
diff --git a/packages/language-server/test/completion.test.js b/packages/language-server/test/completion.test.js
@@ -1,5 +1,5 @@
 /**
- * @typedef {import('@volar/test-utils').LanguageServerHandle} LanguageServerHandle
+ * @import {LanguageServerHandle} from '@volar/test-utils'
  */
 import assert from 'node:assert/strict'
 import {afterEach, beforeEach, test} from 'node:test'
diff --git a/packages/language-server/test/definitions.test.js b/packages/language-server/test/definitions.test.js
@@ -1,5 +1,5 @@
 /**
- * @typedef {import('@volar/test-utils').LanguageServerHandle} LanguageServerHandle
+ * @import {LanguageServerHandle} from '@volar/test-utils'
  */
 import assert from 'node:assert/strict'
 import {afterEach, beforeEach, test} from 'node:test'
diff --git a/packages/language-server/test/diagnostics.test.js b/packages/language-server/test/diagnostics.test.js
@@ -1,5 +1,5 @@
 /**
- * @typedef {import('@volar/test-utils').LanguageServerHandle} LanguageServerHandle
+ * @import {LanguageServerHandle} from '@volar/test-utils'
  */
 import assert from 'node:assert/strict'
 import {afterEach, beforeEach, test} from 'node:test'
diff --git a/packages/language-server/test/document-link.test.js b/packages/language-server/test/document-link.test.js
@@ -1,5 +1,5 @@
 /**
- * @typedef {import('@volar/test-utils').LanguageServerHandle} LanguageServerHandle
+ * @import {LanguageServerHandle} from '@volar/test-utils'
  */
 import assert from 'node:assert/strict'
 import {afterEach, beforeEach, test} from 'node:test'
diff --git a/packages/language-server/test/document-symbols.test.js b/packages/language-server/test/document-symbols.test.js
@@ -1,5 +1,5 @@
 /**
- * @typedef {import('@volar/test-utils').LanguageServerHandle} LanguageServerHandle
+ * @import {LanguageServerHandle} from '@volar/test-utils'
  */
 import assert from 'node:assert/strict'
 import {afterEach, beforeEach, test} from 'node:test'
diff --git a/packages/language-server/test/folding-ranges.test.js b/packages/language-server/test/folding-ranges.test.js
@@ -1,5 +1,5 @@
 /**
- * @typedef {import('@volar/test-utils').LanguageServerHandle} LanguageServerHandle
+ * @import {LanguageServerHandle} from '@volar/test-utils'
  */
 import assert from 'node:assert/strict'
 import {afterEach, beforeEach, test} from 'node:test'
diff --git a/packages/language-server/test/hover.test.js b/packages/language-server/test/hover.test.js
@@ -1,5 +1,5 @@
 /**
- * @typedef {import('@volar/test-utils').LanguageServerHandle} LanguageServerHandle
+ * @import {LanguageServerHandle} from '@volar/test-utils'
  */
 import assert from 'node:assert/strict'
 import {afterEach, beforeEach, test} from 'node:test'
diff --git a/packages/language-server/test/initialize.test.js b/packages/language-server/test/initialize.test.js
@@ -1,5 +1,5 @@
 /**
- * @typedef {import('@volar/test-utils').LanguageServerHandle} LanguageServerHandle
+ * @import {LanguageServerHandle} from '@volar/test-utils'
  */
 import assert from 'node:assert/strict'
 import {afterEach, beforeEach, test} from 'node:test'
diff --git a/packages/language-server/test/no-tsconfig.test.js b/packages/language-server/test/no-tsconfig.test.js
@@ -1,5 +1,5 @@
 /**
- * @typedef {import('@volar/test-utils').LanguageServerHandle} LanguageServerHandle
+ * @import {LanguageServerHandle} from '@volar/test-utils'
  */
 import assert from 'node:assert/strict'
 import {afterEach, beforeEach, test} from 'node:test'
diff --git a/packages/language-server/test/prepare-rename.test.js b/packages/language-server/test/prepare-rename.test.js
@@ -1,5 +1,5 @@
 /**
- * @typedef {import('@volar/test-utils').LanguageServerHandle} LanguageServerHandle
+ * @import {LanguageServerHandle} from '@volar/test-utils'
  */
 import assert from 'node:assert/strict'
 import {afterEach, beforeEach, test} from 'node:test'
diff --git a/packages/language-server/test/rename.test.js b/packages/language-server/test/rename.test.js
@@ -1,5 +1,5 @@
 /**
- * @typedef {import('@volar/test-utils').LanguageServerHandle} LanguageServerHandle
+ * @import {LanguageServerHandle} from '@volar/test-utils'
  */
 import assert from 'node:assert/strict'
 import {afterEach, beforeEach, test} from 'node:test'
diff --git a/packages/language-server/test/syntax-toggle.test.js b/packages/language-server/test/syntax-toggle.test.js
@@ -1,6 +1,6 @@
 /**
- * @typedef {import('@volar/test-utils').LanguageServerHandle} LanguageServerHandle
- * @typedef {import('@mdx-js/language-service').SyntaxToggleParams} SyntaxToggleParams
+ * @import {LanguageServerHandle} from '@volar/test-utils'
+ * @import {SyntaxToggleParams} from '@mdx-js/language-service'
  */
 import assert from 'node:assert/strict'
 import {afterEach, beforeEach, test} from 'node:test'
diff --git a/packages/language-server/test/utils.js b/packages/language-server/test/utils.js
@@ -1,8 +1,3 @@
-/**
- * @typedef {import('@volar/language-server').TextDocumentItem} TextDocumentItem
- * @typedef {import('@volar/language-server').PublishDiagnosticsParams} PublishDiagnosticsParams
- */
-
 import {createRequire} from 'node:module'
 import path from 'node:path'
 import {URI, Utils} from 'vscode-uri'
diff --git a/packages/language-service/lib/commands.js b/packages/language-service/lib/commands.js
@@ -1,8 +1,6 @@
 /**
- * @typedef {import('@volar/language-service').Range} Range
- * @typedef {import('@volar/language-service').LanguageServiceContext} LanguageServiceContext
- * @typedef {import('@volar/language-service').TextEdit} TextEdit
- * @typedef {import('mdast').Nodes} Nodes
+ * @import {LanguageServiceContext, Range, TextEdit} from '@volar/language-service'
+ * @import {Nodes} from 'mdast'
  */
 
 /**
diff --git a/packages/language-service/lib/language-plugin.js b/packages/language-service/lib/language-plugin.js
@@ -1,7 +1,7 @@
 /**
- * @typedef {import('@volar/language-service').LanguagePlugin<string | URI, VirtualMdxCode>} LanguagePlugin
- * @typedef {import('unified').PluggableList} PluggableList
- * @typedef {import('vscode-uri').URI} URI
+ * @import {LanguagePlugin} from '@volar/language-service'
+ * @import {PluggableList} from 'unified'
+ * @import {URI} from 'vscode-uri'
  */
 
 import remarkMdx from 'remark-mdx'
@@ -19,7 +19,7 @@ import {VirtualMdxCode} from './virtual-code.js'
  *   If true, check MDX files strictly.
  * @param {string} jsxImportSource
  *   The JSX import source to use in the embedded JavaScript file.
- * @returns {LanguagePlugin}
+ * @returns {LanguagePlugin<string | URI, VirtualMdxCode>}
  *   A Volar language plugin to support MDX.
  */
 export function createMdxLanguagePlugin(
diff --git a/packages/language-service/lib/mdast-utils.js b/packages/language-service/lib/mdast-utils.js
@@ -1,7 +1,6 @@
 /**
- * @typedef {import('mdast').Nodes} Nodes
- * @typedef {import('unist').Point} Point
- * @typedef {import('unist').Position} Position
+ * @import {Nodes} from 'mdast'
+ * @import {Point, Position} from 'unist'
  */
 
 /**
diff --git a/packages/language-service/lib/script-snapshot.js b/packages/language-service/lib/script-snapshot.js
@@ -1,5 +1,5 @@
 /**
- * @typedef {import('typescript').IScriptSnapshot} IScriptSnapshot
+ * @import {IScriptSnapshot} from 'typescript'
  */
 
 /**
diff --git a/packages/language-service/lib/service-plugin.js b/packages/language-service/lib/service-plugin.js
@@ -1,7 +1,6 @@
 /**
- * @typedef {import('@volar/language-service').DataTransferItem} DataTransferItem
- * @typedef {import('@volar/language-service').LanguageServicePlugin<Provide>} LanguageServicePlugin
- * @typedef {import('./commands.js').SyntaxToggle} SyntaxToggle
+ * @import {DataTransferItem, LanguageServicePlugin} from '@volar/language-service'
+ * @import {SyntaxToggle} from './commands.js'
  */
 
 /**
diff --git a/packages/language-service/lib/tsconfig.js b/packages/language-service/lib/tsconfig.js
@@ -1,8 +1,5 @@
 /**
- * @typedef {import('typescript').ParsedCommandLine} ParsedCommandLine
- * @typedef {import('unified').Pluggable} Pluggable
- * @typedef {import('unified').PluggableList} PluggableList
- * @typedef {import('unified').Plugin} Plugin
+ * @import {Pluggable, PluggableList, Plugin} from 'unified'
  */
 
 /**
diff --git a/packages/language-service/lib/virtual-code.js b/packages/language-service/lib/virtual-code.js
@@ -1,14 +1,11 @@
 /**
- * @typedef {import('@volar/language-service').CodeMapping} CodeMapping
- * @typedef {import('@volar/language-service').VirtualCode} VirtualCode
- * @typedef {import('estree').ExportDefaultDeclaration} ExportDefaultDeclaration
- * @typedef {import('estree').Program} Program
- * @typedef {import('mdast').Nodes} Nodes
- * @typedef {import('mdast').Root} Root
- * @typedef {import('mdast-util-mdxjs-esm').MdxjsEsm} MdxjsEsm
- * @typedef {import('typescript').IScriptSnapshot} IScriptSnapshot
- * @typedef {import('unified').Processor<Root>} Processor
- * @typedef {import('vfile-message').VFileMessage} VFileMessage
+ * @import {CodeMapping, VirtualCode} from '@volar/language-service'
+ * @import {ExportDefaultDeclaration, Program} from 'estree'
+ * @import {Nodes, Root} from 'mdast'
+ * @import {MdxjsEsm} from 'mdast-util-mdxjs-esm'
+ * @import {IScriptSnapshot} from 'typescript'
+ * @import {Processor} from 'unified'
+ * @import {VFileMessage} from 'vfile-message'
  */
 
 import {walk} from 'estree-walker'
@@ -765,7 +762,7 @@ export class VirtualMdxCode {
   /**
    * @param {IScriptSnapshot} snapshot
    *   The original TypeScript snapshot.
-   * @param {Processor} processor
+   * @param {Processor<Root>} processor
    *   The unified processor to use for parsing.
    * @param {boolean} checkMdx
    *   If true, insert a `@check-js` comment into the virtual JavaScript code.
diff --git a/packages/language-service/test/language-plugin.js b/packages/language-service/test/language-plugin.js
@@ -1,7 +1,3 @@
-/**
- * @typedef {import('@volar/language-service').VirtualCode} VirtualCode
- */
-
 import assert from 'node:assert/strict'
 import {test} from 'node:test'
 import {createMdxLanguagePlugin} from '@mdx-js/language-service'
diff --git a/packages/language-service/test/tsconfig.js b/packages/language-service/test/tsconfig.js
@@ -1,5 +1,5 @@
 /**
- * @typedef {import('unified').Plugin} Plugin
+ * @import {Plugin} from 'unified'
  */
 
 import assert from 'node:assert/strict'
diff --git a/packages/typescript-plugin/index.cjs b/packages/typescript-plugin/index.cjs
@@ -1,7 +1,10 @@
 'use strict'
 
 /**
- * @typedef {import('typescript').TsConfigSourceFile} TsConfigSourceFile
+ * @import {TsConfigSourceFile} from 'typescript'
+ */
+
+/**
  * @typedef {import('unified', {with: {'resolution-mode': 'import'}}).Plugin} Plugin
  */
 
diff --git a/packages/vscode-mdx/src/extension.js b/packages/vscode-mdx/src/extension.js
@@ -1,7 +1,6 @@
 /**
- * @typedef {import('@volar/language-server').TextEdit} TextEdit
- * @typedef {import('@volar/vscode').LabsInfo} LabsInfo
- * @typedef {import('vscode').ExtensionContext} ExtensionContext
+ * @import {LabsInfo, TextEdit} from '@volar/vscode'
+ * @import {ExtensionContext} from 'vscode'
  */
 
 import * as languageServerProtocol from '@volar/language-server/protocol.js'
