Refactor to use @imports

wooorm · Oct 1, 2024 · ee13c50 · ee13c50
1 parent 34ceb6b
commit ee13c50
Show file tree

Hide file tree

Showing 6 changed files with 9 additions and 20 deletions.
diff --git a/lib/all.js b/lib/all.js
@@ -1,5 +1,5 @@
 /**
- * @typedef {import('highlight.js').LanguageFn} LanguageFn
+ * @import {LanguageFn} from 'highlight.js'
  */
 
 import $1c from 'highlight.js/lib/languages/1c'

diff --git a/lib/common.js b/lib/common.js
@@ -1,5 +1,5 @@
 /**
- * @typedef {import('highlight.js').LanguageFn} LanguageFn
+ * @import {LanguageFn} from 'highlight.js'
  */
 
 import arduino from 'highlight.js/lib/languages/arduino'

diff --git a/lib/index.js b/lib/index.js
@@ -1,13 +1,6 @@
 /**
- * @typedef {import('hast').Element} Element
- * @typedef {import('hast').ElementContent} ElementContent
- * @typedef {import('hast').Root} Root
- * @typedef {import('hast').RootData} RootData
- *
- * @typedef {import('highlight.js').Emitter} Emitter
- * @typedef {import('highlight.js').HLJSOptions} HljsOptions
- * @typedef {import('highlight.js').HighlightResult} HighlightResult
- * @typedef {import('highlight.js').LanguageFn} LanguageFn
+ * @import {ElementContent, Element, RootData, Root} from 'hast'
+ * @import {Emitter, HLJSOptions as HljsOptions, HighlightResult, LanguageFn} from 'highlight.js'
  */
 
 /**

diff --git a/readme.md b/readme.md
@@ -444,9 +444,8 @@ somewhere in your types, as that registers the new fields on the file.
 
 ```js
 /**
- * @typedef {import('hast').Root} Root
- *
- * @typedef {import('lowlight')}
+ * @import {Root} from 'hast'
+ * @import {} from 'lowlight'
  */
 
 import {VFile} from 'vfile'

diff --git a/script/build-registry.js b/script/build-registry.js
@@ -81,7 +81,7 @@ console.log(
 function generate(list, base) {
   return [
     '/**',
-    " * @typedef {import('highlight.js').LanguageFn} LanguageFn",
+    " * @import {LanguageFn} from 'highlight.js'",
     ' */',
     '',
     ...(base ? ["import {grammars as base} from './" + base + ".js'"] : []),

diff --git a/script/support.js b/script/support.js
@@ -1,9 +1,6 @@
 /**
- * @typedef {import('highlight.js').LanguageFn} LanguageFn
- *
- * @typedef {import('mdast').ListItem} ListItem
- * @typedef {import('mdast').PhrasingContent} PhrasingContent
- * @typedef {import('mdast').Root} Root
+ * @import {LanguageFn} from 'highlight.js'
+ * @import {ListItem, PhrasingContent, Root} from 'mdast'
  */
 
 import fs from 'node:fs/promises'