Refactor types

Author: wooorm

index.js

@@ -1,5 +1,11 @@
 /**
- * @typedef {import('./lib/types.js').SafeOptions} SafeOptions
+ * @typedef {import('./lib/types.js').Info} SafeOptions
+ *   To do: remove next major: renamed because it doesn’t really reflect
+ *   options, but instead info on the surrounding of the generated thing.
+ */
+
+/**
+ * @typedef {import('./lib/types.js').Info} Info
  * @typedef {import('./lib/types.js').Context} Context
  * @typedef {import('./lib/types.js').Handle} Handle
  * @typedef {import('./lib/types.js').Handlers} Handlers

lib/handle/blockquote.js

@@ -1,11 +1,8 @@
 /**
  * @typedef {import('mdast').Blockquote} Blockquote
- * @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').Parent} Parent
  * @typedef {import('../types.js').Context} Context
- * @typedef {import('../types.js').SafeOptions} SafeOptions
+ * @typedef {import('../types.js').Info} Info
  * @typedef {import('../util/indent-lines.js').Map} Map
  */
 
@@ -15,14 +12,14 @@ import {track} from '../util/track.js'
 
 /**
  * @param {Blockquote} node
- * @param {Parent|undefined} _
+ * @param {Parent | undefined} _
  * @param {Context} context
- * @param {SafeOptions} safeOptions
+ * @param {Info} info
  * @returns {string}
  */
-export function blockquote(node, _, context, safeOptions) {
+export function blockquote(node, _, context, info) {
   const exit = context.enter('blockquote')
-  const tracker = track(safeOptions)
+  const tracker = track(info)
   tracker.move('> ')
   tracker.shift(2)
   const value = indentLines(

lib/handle/break.js

@@ -1,23 +1,20 @@
 /**
  * @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').Parent} Parent
  * @typedef {import('../types.js').Context} Context
- * @typedef {import('../types.js').SafeOptions} SafeOptions
+ * @typedef {import('../types.js').Info} Info
  */
 
 import {patternInScope} from '../util/pattern-in-scope.js'
 
 /**
  * @param {Break} _
- * @param {Parent|undefined} _1
+ * @param {Parent | undefined} _1
  * @param {Context} context
- * @param {SafeOptions} safeOptions
+ * @param {Info} info
  * @returns {string}
  */
-export function hardBreak(_, _1, context, safeOptions) {
+export function hardBreak(_, _1, context, info) {
   let index = -1
 
   while (++index < context.unsafe.length) {
@@ -27,7 +24,7 @@ export function hardBreak(_, _1, context, safeOptions) {
       context.unsafe[index].character === '\n' &&
       patternInScope(context.stack, context.unsafe[index])
     ) {
-      return /[ \t]/.test(safeOptions.before) ? '' : ' '
+      return /[ \t]/.test(info.before) ? '' : ' '
     }
   }
 

lib/handle/code.js

@@ -1,11 +1,8 @@
 /**
  * @typedef {import('mdast').Code} Code
- * @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').Parent} Parent
  * @typedef {import('../types.js').Context} Context
- * @typedef {import('../types.js').SafeOptions} SafeOptions
+ * @typedef {import('../types.js').Info} Info
  * @typedef {import('../util/indent-lines.js').Map} Map
  */
 
@@ -18,12 +15,12 @@ import {track} from '../util/track.js'
 
 /**
  * @param {Code} node
- * @param {Parent|undefined} _
+ * @param {Parent | undefined} _
  * @param {Context} context
- * @param {SafeOptions} safeOptions
+ * @param {Info} info
  * @returns {string}
  */
-export function code(node, _, context, safeOptions) {
+export function code(node, _, context, info) {
   const marker = checkFence(context)
   const raw = node.value || ''
   const suffix = marker === '`' ? 'GraveAccent' : 'Tilde'
@@ -35,7 +32,7 @@ export function code(node, _, context, safeOptions) {
     return value
   }
 
-  const tracker = track(safeOptions)
+  const tracker = track(info)
   const sequence = marker.repeat(Math.max(longestStreak(raw, marker) + 1, 3))
   const exit = context.enter('codeFenced')
   let value = tracker.move(sequence)

lib/handle/definition.js

@@ -1,11 +1,8 @@
 /**
  * @typedef {import('mdast').Definition} Definition
- * @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').Parent} Parent
  * @typedef {import('../types.js').Context} Context
- * @typedef {import('../types.js').SafeOptions} SafeOptions
+ * @typedef {import('../types.js').Info} Info
  */
 
 import {association} from '../util/association.js'
@@ -15,17 +12,17 @@ import {track} from '../util/track.js'
 
 /**
  * @param {Definition} node
- * @param {Parent|undefined} _
+ * @param {Parent | undefined} _
  * @param {Context} context
- * @param {SafeOptions} safeOptions
+ * @param {Info} info
  * @returns {string}
  */
-export function definition(node, _, context, safeOptions) {
+export function definition(node, _, context, info) {
   const quote = checkQuote(context)
   const suffix = quote === '"' ? 'Quote' : 'Apostrophe'
   const exit = context.enter('definition')
   let subexit = context.enter('label')
-  const tracker = track(safeOptions)
+  const tracker = track(info)
   let value = tracker.move('[')
   value += tracker.move(
     safe(context, association(node), {

lib/handle/emphasis.js

@@ -1,11 +1,8 @@
 /**
  * @typedef {import('mdast').Emphasis} Emphasis
- * @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').Parent} Parent
  * @typedef {import('../types.js').Context} Context
- * @typedef {import('../types.js').SafeOptions} SafeOptions
+ * @typedef {import('../types.js').Info} Info
  */
 
 import {checkEmphasis} from '../util/check-emphasis.js'
@@ -20,15 +17,15 @@ emphasis.peek = emphasisPeek
 // Do we need to safeguard against that?
 /**
  * @param {Emphasis} node
- * @param {Parent|undefined} _
+ * @param {Parent | undefined} _
  * @param {Context} context
- * @param {SafeOptions} safeOptions
+ * @param {Info} info
  * @returns {string}
  */
-export function emphasis(node, _, context, safeOptions) {
+export function emphasis(node, _, context, info) {
   const marker = checkEmphasis(context)
   const exit = context.enter('emphasis')
-  const tracker = track(safeOptions)
+  const tracker = track(info)
   let value = tracker.move(marker)
   value += tracker.move(
     containerPhrasing(node, context, {
@@ -44,7 +41,7 @@ export function emphasis(node, _, context, safeOptions) {
 
 /**
  * @param {Emphasis} _
- * @param {Parent|undefined} _1
+ * @param {Parent | undefined} _1
  * @param {Context} context
  * @returns {string}
  */

lib/handle/heading.js

@@ -1,11 +1,8 @@
 /**
  * @typedef {import('mdast').Heading} Heading
- * @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').Parent} Parent
  * @typedef {import('../types.js').Context} Context
- * @typedef {import('../types.js').SafeOptions} SafeOptions
+ * @typedef {import('../types.js').Info} Info
  */
 
 import {formatHeadingAsSetext} from '../util/format-heading-as-setext.js'
@@ -14,14 +11,14 @@ import {track} from '../util/track.js'
 
 /**
  * @param {Heading} node
- * @param {Parent|undefined} _
+ * @param {Parent | undefined} _
  * @param {Context} context
- * @param {SafeOptions} safeOptions
+ * @param {Info} info
  * @returns {string}
  */
-export function heading(node, _, context, safeOptions) {
+export function heading(node, _, context, info) {
   const rank = Math.max(Math.min(6, node.depth || 1), 1)
-  const tracker = track(safeOptions)
+  const tracker = track(info)
 
   if (formatHeadingAsSetext(node, context)) {
     const exit = context.enter('headingSetext')

lib/handle/html.js

@@ -1,8 +1,5 @@
 /**
  * @typedef {import('mdast').HTML} HTML
- * @typedef {import('mdast').Root} Root
- * @typedef {import('mdast').Content} Content
- * @typedef {Root|Content} Node
  */
 
 html.peek = htmlPeek

lib/handle/image-reference.js

@@ -1,11 +1,8 @@
 /**
  * @typedef {import('mdast').ImageReference} ImageReference
- * @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').Parent} Parent
  * @typedef {import('../types.js').Context} Context
- * @typedef {import('../types.js').SafeOptions} SafeOptions
+ * @typedef {import('../types.js').Info} Info
  */
 
 import {association} from '../util/association.js'
@@ -16,16 +13,16 @@ imageReference.peek = imageReferencePeek
 
 /**
  * @param {ImageReference} node
- * @param {Parent|undefined} _
+ * @param {Parent | undefined} _
  * @param {Context} context
- * @param {SafeOptions} safeOptions
+ * @param {Info} info
  * @returns {string}
  */
-export function imageReference(node, _, context, safeOptions) {
+export function imageReference(node, _, context, info) {
   const type = node.referenceType
   const exit = context.enter('imageReference')
   let subexit = context.enter('label')
-  const tracker = track(safeOptions)
+  const tracker = track(info)
   let value = tracker.move('![')
   const alt = safe(context, node.alt, {
     before: value,

lib/handle/image.js

@@ -1,11 +1,8 @@
 /**
  * @typedef {import('mdast').Image} Image
- * @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').Parent} Parent
  * @typedef {import('../types.js').Context} Context
- * @typedef {import('../types.js').SafeOptions} SafeOptions
+ * @typedef {import('../types.js').Info} Info
  */
 
 import {checkQuote} from '../util/check-quote.js'
@@ -16,17 +13,17 @@ image.peek = imagePeek
 
 /**
  * @param {Image} node
- * @param {Parent|undefined} _
+ * @param {Parent | undefined} _
  * @param {Context} context
- * @param {SafeOptions} safeOptions
+ * @param {Info} info
  * @returns {string}
  */
-export function image(node, _, context, safeOptions) {
+export function image(node, _, context, info) {
   const quote = checkQuote(context)
   const suffix = quote === '"' ? 'Quote' : 'Apostrophe'
   const exit = context.enter('image')
   let subexit = context.enter('label')
-  const tracker = track(safeOptions)
+  const tracker = track(info)
   let value = tracker.move('![')
   value += tracker.move(
     safe(context, node.alt, {before: value, after: ']', ...tracker.current()})

lib/handle/inline-code.js

@@ -1,9 +1,6 @@
 /**
  * @typedef {import('mdast').InlineCode} InlineCode
- * @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').Parent} Parent
  * @typedef {import('../types.js').Context} Context
  */
 
@@ -13,7 +10,7 @@ inlineCode.peek = inlineCodePeek
 
 /**
  * @param {InlineCode} node
- * @param {Parent|undefined} _
+ * @param {Parent | undefined} _
  * @param {Context} context
  * @returns {string}
  */
@@ -48,7 +45,7 @@ export function inlineCode(node, _, context) {
   while (++index < context.unsafe.length) {
     const pattern = context.unsafe[index]
     const expression = patternCompile(pattern)
-    /** @type {RegExpExecArray|null} */
+    /** @type {RegExpExecArray | null} */
     let match
 
     // Only look for `atBreak`s.

lib/handle/link-reference.js

@@ -1,11 +1,8 @@
 /**
  * @typedef {import('mdast').LinkReference} LinkReference
- * @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').Parent} Parent
  * @typedef {import('../types.js').Context} Context
- * @typedef {import('../types.js').SafeOptions} SafeOptions
+ * @typedef {import('../types.js').Info} Info
  */
 
 import {association} from '../util/association.js'
@@ -17,16 +14,16 @@ linkReference.peek = linkReferencePeek
 
 /**
  * @param {LinkReference} node
- * @param {Parent|undefined} _
+ * @param {Parent | undefined} _
  * @param {Context} context
- * @param {SafeOptions} safeOptions
+ * @param {Info} info
  * @returns {string}
  */
-export function linkReference(node, _, context, safeOptions) {
+export function linkReference(node, _, context, info) {
   const type = node.referenceType
   const exit = context.enter('linkReference')
   let subexit = context.enter('label')
-  const tracker = track(safeOptions)
+  const tracker = track(info)
   let value = tracker.move('[')
   const text = containerPhrasing(node, context, {
     before: value,