Add indentLines helper on state

Author: wooorm

index.d.ts

@@ -314,10 +314,10 @@ export type {
   Handlers,
   Info,
   Join,
+  Map,
   Options,
   State,
-  Unsafe,
-  Map
+  Unsafe
 } from './lib/types.js'
 // Deprecated.
 export type SafeOptions = Info

lib/configure.js

@@ -10,7 +10,7 @@
  */
 export function configure(base, extension) {
   let index = -1
-  /** @type {string} */
+  /** @type {keyof Options} */
   let key
 
   // First do subextensions.

lib/handle/blockquote.js

@@ -3,11 +3,10 @@
  * @typedef {import('../types.js').Parent} Parent
  * @typedef {import('../types.js').State} State
  * @typedef {import('../types.js').Info} Info
- * @typedef {import('../util/indent-lines.js').Map} Map
+ * @typedef {import('../types.js').Map} Map
  */
 
 import {containerFlow} from '../util/container-flow.js'
-import {indentLines} from '../util/indent-lines.js'
 import {track} from '../util/track.js'
 
 /**
@@ -22,7 +21,10 @@ export function blockquote(node, _, state, info) {
   const tracker = track(info)
   tracker.move('> ')
   tracker.shift(2)
-  const value = indentLines(containerFlow(node, state, tracker.current()), map)
+  const value = state.indentLines(
+    containerFlow(node, state, tracker.current()),
+    map
+  )
   exit()
   return value
 }

lib/handle/code.js

@@ -3,13 +3,12 @@
  * @typedef {import('../types.js').Parent} Parent
  * @typedef {import('../types.js').State} State
  * @typedef {import('../types.js').Info} Info
- * @typedef {import('../util/indent-lines.js').Map} Map
+ * @typedef {import('../types.js').Map} Map
  */
 
 import {longestStreak} from 'longest-streak'
 import {formatCodeAsIndented} from '../util/format-code-as-indented.js'
 import {checkFence} from '../util/check-fence.js'
-import {indentLines} from '../util/indent-lines.js'
 import {safe} from '../util/safe.js'
 import {track} from '../util/track.js'
 
@@ -27,7 +26,7 @@ export function code(node, _, state, info) {
 
   if (formatCodeAsIndented(node, state)) {
     const exit = state.enter('codeIndented')
-    const value = indentLines(raw, map)
+    const value = state.indentLines(raw, map)
     exit()
     return value
   }

lib/handle/list-item.js

@@ -1,6 +1,6 @@
 /**
  * @typedef {import('mdast').ListItem} ListItem
- * @typedef {import('../util/indent-lines.js').Map} Map
+ * @typedef {import('../types.js').Map} Map
  * @typedef {import('../types.js').Parent} Parent
  * @typedef {import('../types.js').State} State
  * @typedef {import('../types.js').Info} Info
@@ -9,7 +9,6 @@
 import {checkBullet} from '../util/check-bullet.js'
 import {checkListItemIndent} from '../util/check-list-item-indent.js'
 import {containerFlow} from '../util/container-flow.js'
-import {indentLines} from '../util/indent-lines.js'
 import {track} from '../util/track.js'
 
 /**
@@ -49,7 +48,10 @@ export function listItem(node, parent, state, info) {
   tracker.move(bullet + ' '.repeat(size - bullet.length))
   tracker.shift(size)
   const exit = state.enter('listItem')
-  const value = indentLines(containerFlow(node, state, tracker.current()), map)
+  const value = state.indentLines(
+    containerFlow(node, state, tracker.current()),
+    map
+  )
   exit()
 
   return value

lib/index.js

@@ -11,6 +11,7 @@ import {configure} from './configure.js'
 import {handle as handlers} from './handle/index.js'
 import {join} from './join.js'
 import {unsafe} from './unsafe.js'
+import {indentLines} from './util/indent-lines.js'
 
 /**
  * Turn an mdast syntax tree into markdown.
@@ -26,6 +27,7 @@ export function toMarkdown(tree, options = {}) {
   /** @type {State} */
   const state = {
     enter,
+    indentLines,
     stack: [],
     unsafe: [],
     join: [],

lib/types.js

@@ -32,6 +32,27 @@
  * @typedef {TrackFields & SafeFields} Info
  *   Info on the surrounding of the node that is serialized.
  *
+ * @callback Map
+ *   Map function to pad a single line.
+ * @param {string} value
+ *   A single line of serialized markdown.
+ * @param {number} line
+ *   Line number relative to the fragment.
+ * @param {boolean} blank
+ *   Whether the line is considered blank in markdown.
+ * @returns {string}
+ *   Padded line.
+ *
+
+ * @callback IndentLines
+ *   Pad serialized markdown.
+ * @param {string} value
+ *   Whole fragment of serialized markdown.
+ * @param {Map} map
+ *   Map function.
+ * @returns {string}
+ *   Padded value.
+ *
  * @callback Enter
  *   Enter something.
  * @param {ConstructName} name
@@ -50,6 +71,8 @@
  *   Stack of constructs we’re in.
  * @property {Array<number>} indexStack
  *   Positions of child nodes in their parents.
+ * @property {IndentLines} indentLines
+ *   Pad serialized markdown.
  * @property {Enter} enter
  *   Enter a construct (returns a corresponding exit function).
  * @property {Options} options

lib/util/indent-lines.js

@@ -1,17 +1,11 @@
 /**
- * @callback Map
- * @param {string} value
- * @param {number} line
- * @param {boolean} blank
- * @returns {string}
+ * @typedef {import('../types.js').IndentLines} IndentLines
  */
 
 const eol = /\r?\n|\r/g
 
 /**
- * @param {string} value
- * @param {Map} map
- * @returns {string}
+ * @type {IndentLines}
  */
 export function indentLines(value, map) {
   /** @type {Array<string>} */

readme.md

@@ -277,6 +277,21 @@ after a list, in which case a comment will be injected to break them up:
 
 ### `Map`
 
+Map function to pad a single line (TypeScript type).
+
+###### Parameters
+
+*   `value` (`string`)
+    — a single line of serialized markdown
+*   `line` (`number`)
+    — line number relative to the fragment
+*   `blank` (`boolean`)
+    — whether the line is considered blank in markdown
+
+###### Returns
+
+Padded line (`string`).
+
 ### `Options`
 
 Configuration (TypeScript type).
@@ -447,6 +462,9 @@ Info passed around about the current state (TypeScript type).
     — positions of child nodes in their parents
 *   `enter` (`(construct: ConstructName) => () => void`)
     — enter a construct (returns a corresponding exit function)
+    (see [`ConstructName`][constructname])
+*   `indentLines` (`(value: string, map: Map) => string`)
+    — pad serialized markdown (see [`Map`][map])
 *   `options` ([`Options`][options])
     — applied user configuration
 *   `unsafe` ([`Array<Unsafe>`][unsafe])
@@ -647,6 +665,8 @@ abide by its terms.
 
 [join]: #join
 
+[map]: #map
+
 [options]: #options
 
 [state]: #state