Refactor types to use ConstructNameMap interface

Author: wooorm

.gitignore

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

index.d.ts

@@ -0,0 +1,20 @@
+export {
+  gfmStrikethroughFromMarkdown,
+  gfmStrikethroughToMarkdown
+} from './lib/index.js'
+
+// Add custom data tracked to turn a syntax tree into markdown.
+declare module 'mdast-util-to-markdown' {
+  // eslint-disable-next-line @typescript-eslint/consistent-type-definitions
+  interface ConstructNameMap {
+    /**
+     * Whole strikethrough.
+     *
+     * ```markdown
+     * > | ~~a~~
+     *     ^^^^^
+     * ```
+     */
+    strikethrough: 'strikethrough'
+  }
+}

index.js

@@ -1,3 +1,4 @@
+// Note: extra types in `index.d.ts`.
 export {
   gfmStrikethroughFromMarkdown,
   gfmStrikethroughToMarkdown

lib/index.js

@@ -3,6 +3,7 @@
  * @typedef {import('mdast-util-from-markdown').CompileContext} CompileContext
  * @typedef {import('mdast-util-from-markdown').Extension} FromMarkdownExtension
  * @typedef {import('mdast-util-from-markdown').Handle} FromMarkdownHandle
+ * @typedef {import('mdast-util-to-markdown').ConstructName} ConstructName
  * @typedef {import('mdast-util-to-markdown').Options} ToMarkdownExtension
  * @typedef {import('mdast-util-to-markdown').Handle} ToMarkdownHandle
  */
@@ -21,7 +22,9 @@ export const gfmStrikethroughFromMarkdown = {
  * List of constructs that occur in phrasing (paragraphs, headings), but cannot
  * contain strikethroughs. So they sort of cancel each other out.
  *
- * Note: keep in sync with: <https://github.com/syntax-tree/mdast-util-to-markdown/blob/c47743b/lib/unsafe.js#L11>
+ * Note: keep in sync with: <https://github.com/syntax-tree/mdast-util-to-markdown/blob/8ce8dbf/lib/unsafe.js#L14>
+ *
+ * @type {Array<ConstructName>}
  */
 const constructsWithoutStrikethrough = [
   'autolink',
@@ -38,7 +41,6 @@ export const gfmStrikethroughToMarkdown = {
     {
       character: '~',
       inConstruct: 'phrasing',
-      // @ts-expect-error: register.
       notInConstruct: constructsWithoutStrikethrough
     }
   ],
@@ -69,8 +71,7 @@ function exitStrikethrough(token) {
  */
 function handleDelete(node, _, context, safeOptions) {
   const tracker = track(safeOptions)
-  // To do: next major (?): use `delete` or `strikethrough`?
-  const exit = context.enter('emphasis')
+  const exit = context.enter('strikethrough')
   let value = tracker.move('~~')
   value += containerPhrasing(node, context, {
     ...tracker.current(),

tsconfig.json

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