Refactor types to use ConstructNameMap interface

Author: wooorm

.gitignore

@@ -4,3 +4,4 @@ node_modules/
 *.d.ts
 *.log
 yarn.lock
+!/index.d.ts

index.d.ts

@@ -0,0 +1,26 @@
+export {gfmFootnoteFromMarkdown, gfmFootnoteToMarkdown} from './lib/index.js'
+
+declare module 'mdast-util-to-markdown' {
+  // eslint-disable-next-line @typescript-eslint/consistent-type-definitions
+  interface ConstructNameMap {
+    /**
+     * Footnote reference.
+     *
+     * ```markdown
+     * > | A[^b].
+     *      ^^^^
+     * ```
+     */
+    footnoteReference: 'footnoteReference'
+
+    /**
+     * Footnote definition.
+     *
+     * ```markdown
+     * > | [^a]: B.
+     *     ^^^^^^^^
+     * ```
+     */
+    footnoteDefinition: 'footnoteDefinition'
+  }
+}

index.js

@@ -1 +1,2 @@
+// Note: extra types exported from `index.d.ts`.
 export {gfmFootnoteFromMarkdown, gfmFootnoteToMarkdown} from './lib/index.js'

lib/index.js

@@ -136,7 +136,6 @@ export function gfmFootnoteToMarkdown() {
   function footnoteReference(node, _, context, safeOptions) {
     const tracker = track(safeOptions)
     let value = tracker.move('[^')
-    // @ts-expect-error: use map.
     const exit = context.enter('footnoteReference')
     const subexit = context.enter('reference')
     value += tracker.move(
@@ -164,7 +163,6 @@ export function gfmFootnoteToMarkdown() {
   function footnoteDefinition(node, _, context, safeOptions) {
     const tracker = track(safeOptions)
     let value = tracker.move('[^')
-    // @ts-expect-error: use map.
     const exit = context.enter('footnoteDefinition')
     const subexit = context.enter('label')
     value += tracker.move(

tsconfig.json

@@ -1,5 +1,5 @@
 {
-  "include": ["**/*.js"],
+  "include": ["**/*.js", "index.d.ts"],
   "exclude": ["coverage/", "node_modules/"],
   "compilerOptions": {
     "checkJs": true,