Add improved internal types for zwitch

syntax-tree · Dec 13, 2022 · 515977a · 515977a
1 parent 651ce97
commit 515977a
Show file tree

Hide file tree

Showing 21 changed files with 198 additions and 59 deletions.
diff --git a/lib/handle/blockquote.js b/lib/handle/blockquote.js
@@ -1,6 +1,11 @@
 /**
  * @typedef {import('mdast').Blockquote} Blockquote
- * @typedef {import('../types.js').Handle} Handle
+ * @typedef {import('mdast').Root} Root
+ * @typedef {import('mdast').Content} Content
+ * @typedef {Root|Content} Node
+ * @typedef {Extract<Node, import('mdast').Parent>} Parent
+ * @typedef {import('../types.js').Context} Context
+ * @typedef {import('../types.js').SafeOptions} SafeOptions
  * @typedef {import('../util/indent-lines.js').Map} Map
  */
 
@@ -9,8 +14,11 @@ import {indentLines} from '../util/indent-lines.js'
 import {track} from '../util/track.js'
 
 /**
- * @type {Handle}
  * @param {Blockquote} node
+ * @param {Parent|undefined} _
+ * @param {Context} context
+ * @param {SafeOptions} safeOptions
+ * @returns {string}
  */
 export function blockquote(node, _, context, safeOptions) {
   const exit = context.enter('blockquote')

diff --git a/lib/handle/break.js b/lib/handle/break.js
@@ -1,15 +1,23 @@
 /**
- * @typedef {import('../types.js').Handle} Handle
  * @typedef {import('mdast').Break} Break
+ * @typedef {import('mdast').Root} Root
+ * @typedef {import('mdast').Content} Content
+ * @typedef {Root|Content} Node
+ * @typedef {Extract<Node, import('mdast').Parent>} Parent
+ * @typedef {import('../types.js').Context} Context
+ * @typedef {import('../types.js').SafeOptions} SafeOptions
  */
 
 import {patternInScope} from '../util/pattern-in-scope.js'
 
 /**
- * @type {Handle}
  * @param {Break} _
+ * @param {Parent|undefined} _1
+ * @param {Context} context
+ * @param {SafeOptions} safeOptions
+ * @returns {string}
  */
-export function hardBreak(_, _1, context, safe) {
+export function hardBreak(_, _1, context, safeOptions) {
   let index = -1
 
   while (++index < context.unsafe.length) {
@@ -19,7 +27,7 @@ export function hardBreak(_, _1, context, safe) {
       context.unsafe[index].character === '\n' &&
       patternInScope(context.stack, context.unsafe[index])
     ) {
-      return /[ \t]/.test(safe.before) ? '' : ' '
+      return /[ \t]/.test(safeOptions.before) ? '' : ' '
     }
   }
 

diff --git a/lib/handle/code.js b/lib/handle/code.js
@@ -1,7 +1,11 @@
 /**
  * @typedef {import('mdast').Code} Code
- * @typedef {import('../types.js').Handle} Handle
- * @typedef {import('../types.js').Exit} Exit
+ * @typedef {import('mdast').Root} Root
+ * @typedef {import('mdast').Content} Content
+ * @typedef {Root|Content} Node
+ * @typedef {Extract<Node, import('mdast').Parent>} Parent
+ * @typedef {import('../types.js').Context} Context
+ * @typedef {import('../types.js').SafeOptions} SafeOptions
  * @typedef {import('../util/indent-lines.js').Map} Map
  */
 
@@ -13,8 +17,11 @@ import {safe} from '../util/safe.js'
 import {track} from '../util/track.js'
 
 /**
- * @type {Handle}
  * @param {Code} node
+ * @param {Parent|undefined} _
+ * @param {Context} context
+ * @param {SafeOptions} safeOptions
+ * @returns {string}
  */
 export function code(node, _, context, safeOptions) {
   const marker = checkFence(context)

diff --git a/lib/handle/definition.js b/lib/handle/definition.js
@@ -1,6 +1,11 @@
 /**
  * @typedef {import('mdast').Definition} Definition
- * @typedef {import('../types.js').Handle} Handle
+ * @typedef {import('mdast').Root} Root
+ * @typedef {import('mdast').Content} Content
+ * @typedef {Root|Content} Node
+ * @typedef {Extract<Node, import('mdast').Parent>} Parent
+ * @typedef {import('../types.js').Context} Context
+ * @typedef {import('../types.js').SafeOptions} SafeOptions
  */
 
 import {association} from '../util/association.js'
@@ -9,8 +14,11 @@ import {safe} from '../util/safe.js'
 import {track} from '../util/track.js'
 
 /**
- * @type {Handle}
  * @param {Definition} node
+ * @param {Parent|undefined} _
+ * @param {Context} context
+ * @param {SafeOptions} safeOptions
+ * @returns {string}
  */
 export function definition(node, _, context, safeOptions) {
   const quote = checkQuote(context)

diff --git a/lib/handle/emphasis.js b/lib/handle/emphasis.js
@@ -1,6 +1,11 @@
 /**
  * @typedef {import('mdast').Emphasis} Emphasis
- * @typedef {import('../types.js').Handle} Handle
+ * @typedef {import('mdast').Root} Root
+ * @typedef {import('mdast').Content} Content
+ * @typedef {Root|Content} Node
+ * @typedef {Extract<Node, import('mdast').Parent>} Parent
+ * @typedef {import('../types.js').Context} Context
+ * @typedef {import('../types.js').SafeOptions} SafeOptions
  */
 
 import {checkEmphasis} from '../util/check-emphasis.js'
@@ -14,8 +19,11 @@ emphasis.peek = emphasisPeek
 // There’s no way around that though, except for injecting zero-width stuff.
 // Do we need to safeguard against that?
 /**
- * @type {Handle}
  * @param {Emphasis} node
+ * @param {Parent|undefined} _
+ * @param {Context} context
+ * @param {SafeOptions} safeOptions
+ * @returns {string}
  */
 export function emphasis(node, _, context, safeOptions) {
   const marker = checkEmphasis(context)
@@ -35,8 +43,10 @@ export function emphasis(node, _, context, safeOptions) {
 }
 
 /**
- * @type {Handle}
  * @param {Emphasis} _
+ * @param {Parent|undefined} _1
+ * @param {Context} context
+ * @returns {string}
  */
 function emphasisPeek(_, _1, context) {
   return context.options.emphasis || '*'

diff --git a/lib/handle/heading.js b/lib/handle/heading.js
@@ -1,16 +1,23 @@
 /**
  * @typedef {import('mdast').Heading} Heading
- * @typedef {import('../types.js').Handle} Handle
- * @typedef {import('../types.js').Exit} Exit
+ * @typedef {import('mdast').Root} Root
+ * @typedef {import('mdast').Content} Content
+ * @typedef {Root|Content} Node
+ * @typedef {Extract<Node, import('mdast').Parent>} Parent
+ * @typedef {import('../types.js').Context} Context
+ * @typedef {import('../types.js').SafeOptions} SafeOptions
  */
 
 import {formatHeadingAsSetext} from '../util/format-heading-as-setext.js'
 import {containerPhrasing} from '../util/container-phrasing.js'
 import {track} from '../util/track.js'
 
 /**
- * @type {Handle}
  * @param {Heading} node
+ * @param {Parent|undefined} _
+ * @param {Context} context
+ * @param {SafeOptions} safeOptions
+ * @returns {string}
  */
 export function heading(node, _, context, safeOptions) {
   const rank = Math.max(Math.min(6, node.depth || 1), 1)

diff --git a/lib/handle/html.js b/lib/handle/html.js
@@ -1,20 +1,22 @@
 /**
  * @typedef {import('mdast').HTML} HTML
- * @typedef {import('../types.js').Handle} Handle
+ * @typedef {import('mdast').Root} Root
+ * @typedef {import('mdast').Content} Content
+ * @typedef {Root|Content} Node
  */
 
 html.peek = htmlPeek
 
 /**
- * @type {Handle}
  * @param {HTML} node
+ * @returns {string}
  */
 export function html(node) {
   return node.value || ''
 }
 
 /**
- * @type {Handle}
+ * @returns {string}
  */
 function htmlPeek() {
   return '<'

diff --git a/lib/handle/image-reference.js b/lib/handle/image-reference.js
@@ -1,6 +1,11 @@
 /**
  * @typedef {import('mdast').ImageReference} ImageReference
- * @typedef {import('../types.js').Handle} Handle
+ * @typedef {import('mdast').Root} Root
+ * @typedef {import('mdast').Content} Content
+ * @typedef {Root|Content} Node
+ * @typedef {Extract<Node, import('mdast').Parent>} Parent
+ * @typedef {import('../types.js').Context} Context
+ * @typedef {import('../types.js').SafeOptions} SafeOptions
  */
 
 import {association} from '../util/association.js'
@@ -10,8 +15,11 @@ import {track} from '../util/track.js'
 imageReference.peek = imageReferencePeek
 
 /**
- * @type {Handle}
  * @param {ImageReference} node
+ * @param {Parent|undefined} _
+ * @param {Context} context
+ * @param {SafeOptions} safeOptions
+ * @returns {string}
  */
 export function imageReference(node, _, context, safeOptions) {
   const type = node.referenceType
@@ -57,7 +65,7 @@ export function imageReference(node, _, context, safeOptions) {
 }
 
 /**
- * @type {Handle}
+ * @returns {string}
  */
 function imageReferencePeek() {
   return '!'

diff --git a/lib/handle/image.js b/lib/handle/image.js
@@ -1,6 +1,11 @@
 /**
  * @typedef {import('mdast').Image} Image
- * @typedef {import('../types.js').Handle} Handle
+ * @typedef {import('mdast').Root} Root
+ * @typedef {import('mdast').Content} Content
+ * @typedef {Root|Content} Node
+ * @typedef {Extract<Node, import('mdast').Parent>} Parent
+ * @typedef {import('../types.js').Context} Context
+ * @typedef {import('../types.js').SafeOptions} SafeOptions
  */
 
 import {checkQuote} from '../util/check-quote.js'
@@ -10,8 +15,11 @@ import {track} from '../util/track.js'
 image.peek = imagePeek
 
 /**
- * @type {Handle}
  * @param {Image} node
+ * @param {Parent|undefined} _
+ * @param {Context} context
+ * @param {SafeOptions} safeOptions
+ * @returns {string}
  */
 export function image(node, _, context, safeOptions) {
   const quote = checkQuote(context)
@@ -74,7 +82,7 @@ export function image(node, _, context, safeOptions) {
 }
 
 /**
- * @type {Handle}
+ * @returns {string}
  */
 function imagePeek() {
   return '!'

diff --git a/lib/handle/inline-code.js b/lib/handle/inline-code.js
@@ -1,15 +1,21 @@
 /**
  * @typedef {import('mdast').InlineCode} InlineCode
- * @typedef {import('../types.js').Handle} Handle
+ * @typedef {import('mdast').Root} Root
+ * @typedef {import('mdast').Content} Content
+ * @typedef {Root|Content} Node
+ * @typedef {Extract<Node, import('mdast').Parent>} Parent
+ * @typedef {import('../types.js').Context} Context
  */
 
 import {patternCompile} from '../util/pattern-compile.js'
 
 inlineCode.peek = inlineCodePeek
 
 /**
- * @type {Handle}
  * @param {InlineCode} node
+ * @param {Parent|undefined} _
+ * @param {Context} context
+ * @returns {string}
  */
 export function inlineCode(node, _, context) {
   let value = node.value || ''
@@ -69,7 +75,7 @@ export function inlineCode(node, _, context) {
 }
 
 /**
- * @type {Handle}
+ * @returns {string}
  */
 function inlineCodePeek() {
   return '`'

diff --git a/lib/handle/link-reference.js b/lib/handle/link-reference.js
@@ -1,6 +1,11 @@
 /**
  * @typedef {import('mdast').LinkReference} LinkReference
- * @typedef {import('../types.js').Handle} Handle
+ * @typedef {import('mdast').Root} Root
+ * @typedef {import('mdast').Content} Content
+ * @typedef {Root|Content} Node
+ * @typedef {Extract<Node, import('mdast').Parent>} Parent
+ * @typedef {import('../types.js').Context} Context
+ * @typedef {import('../types.js').SafeOptions} SafeOptions
  */
 
 import {association} from '../util/association.js'
@@ -11,8 +16,11 @@ import {track} from '../util/track.js'
 linkReference.peek = linkReferencePeek
 
 /**
- * @type {Handle}
  * @param {LinkReference} node
+ * @param {Parent|undefined} _
+ * @param {Context} context
+ * @param {SafeOptions} safeOptions
+ * @returns {string}
  */
 export function linkReference(node, _, context, safeOptions) {
   const type = node.referenceType
@@ -58,7 +66,7 @@ export function linkReference(node, _, context, safeOptions) {
 }
 
 /**
- * @type {Handle}
+ * @returns {string}
  */
 function linkReferencePeek() {
   return '['

diff --git a/lib/handle/link.js b/lib/handle/link.js
@@ -1,6 +1,11 @@
 /**
  * @typedef {import('mdast').Link} Link
- * @typedef {import('../types.js').Handle} Handle
+ * @typedef {import('mdast').Root} Root
+ * @typedef {import('mdast').Content} Content
+ * @typedef {Root|Content} Node
+ * @typedef {Extract<Node, import('mdast').Parent>} Parent
+ * @typedef {import('../types.js').Context} Context
+ * @typedef {import('../types.js').SafeOptions} SafeOptions
  * @typedef {import('../types.js').Exit} Exit
  */
 
@@ -13,8 +18,11 @@ import {track} from '../util/track.js'
 link.peek = linkPeek
 
 /**
- * @type {Handle}
  * @param {Link} node
+ * @param {Parent|undefined} _
+ * @param {Context} context
+ * @param {SafeOptions} safeOptions
+ * @returns {string}
  */
 export function link(node, _, context, safeOptions) {
   const quote = checkQuote(context)
@@ -104,8 +112,10 @@ export function link(node, _, context, safeOptions) {
 }
 
 /**
- * @type {Handle}
  * @param {Link} node
+ * @param {Parent|undefined} _
+ * @param {Context} context
+ * @returns {string}
  */
 function linkPeek(node, _, context) {
   return formatLinkAsAutolink(node, context) ? '<' : '['