Skip to content

Commit

Permalink
Change to return undefined from enter, exit
Browse files Browse the repository at this point in the history
If you make extensions to this, get the current node yourself.
  • Loading branch information
wooorm committed Jul 9, 2023
1 parent 779364c commit 18f4bb0
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 28 deletions.
60 changes: 34 additions & 26 deletions dev/lib/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -117,9 +117,9 @@
* Capture some of the output data.
* @property {(this: CompileContext) => string} resume
* Stop capturing and access the output data.
* @property {<Kind extends Nodes>(this: CompileContext, node: Kind, token: Token, onError?: OnEnterError) => Kind} enter
* @property {(this: CompileContext, node: Nodes, token: Token, onError?: OnEnterError) => undefined} enter
* Enter a token.
* @property {(this: CompileContext, token: Token, onError?: OnExitError) => Nodes} exit
* @property {(this: CompileContext, token: Token, onError?: OnExitError) => undefined} exit
* Exit a token.
* @property {TokenizeContext['sliceSerialize']} sliceSerialize
* Get the string value of a token.
Expand All @@ -135,7 +135,6 @@
* Configuration.
*/

// To do: next major: don’t return given `Nodes` from `enter`.
// To do: next major: remove setter/getter.

import {ok as assert} from 'devlop'
Expand Down Expand Up @@ -517,15 +516,16 @@ function compiler(options) {

// Create a new list item.
if (event[1].type === types.listItemPrefix) {
listItem = {
/** @type {Token} */
const item = {
type: 'listItem',
_spread: false,
start: Object.assign({}, event[1].start),
// @ts-expect-error: we’ll add `end` in a second.
end: undefined
}
// @ts-expect-error: `listItem` is most definitely defined, TS...
events.splice(index, 0, ['enter', listItem, event[2]])
listItem = item
events.splice(index, 0, ['enter', item, event[2]])
index++
length++
firstBlankLineIndex = undefined
Expand Down Expand Up @@ -601,30 +601,31 @@ function compiler(options) {
}

/**
* @template {Nodes} Kind
* Node type.
* @this {CompileContext}
* Context.
* @param {Kind} node
* @param {Nodes} node
* Node to enter.
* @param {Token} token
* Corresponding token.
* @param {OnEnterError | undefined} [errorHandler]
* Handle the case where this token is open, but it is closed by something else.
* @returns {Kind}
* The given node.
* @returns {undefined}
* Nothing.
*/
function enter(node, token, errorHandler) {
const parent = this.stack[this.stack.length - 1]
assert(parent, 'expected `parent`')
assert('children' in parent, 'expected `parent`')
// @ts-expect-error: Assume `Node` can exist as a child of `parent`.
parent.children.push(node)
/** @type {Array<Nodes>} */
const siblings = parent.children
siblings.push(node)
this.stack.push(node)
this.tokenStack.push([token, errorHandler])
// @ts-expect-error: `end` will be patched later.
node.position = {start: point(token.start)}
return node
node.position = {
start: point(token.start),
// @ts-expect-error: `end` will be patched later.
end: undefined
}
}

/**
Expand Down Expand Up @@ -656,8 +657,8 @@ function compiler(options) {
* Corresponding token.
* @param {OnExitError | undefined} [onExitError]
* Handle the case where another token is open.
* @returns {Nodes}
* The closed node.
* @returns {undefined}
* Nothing.
*/
function exit(token, onExitError) {
const node = this.stack.pop()
Expand All @@ -684,7 +685,6 @@ function compiler(options) {
assert(node.type !== 'fragment', 'unexpected fragment `exit`ed')
assert(node.position, 'expected `position` to be defined')
node.position.end = point(token.end)
return node
}

/**
Expand Down Expand Up @@ -892,16 +892,20 @@ function compiler(options) {
const node = this.stack[this.stack.length - 1]
assert(node, 'expected node on stack')
assert('children' in node, 'expected parent on stack')
/** @type {Array<Nodes>} */
const siblings = node.children

let tail = node.children[node.children.length - 1]
let tail = siblings[siblings.length - 1]

if (!tail || tail.type !== 'text') {
// Add a new text node.
tail = text()
// @ts-expect-error: we’ll add `end` later.
tail.position = {start: point(token.start)}
// @ts-expect-error: Assume `parent` accepts `text`.
node.children.push(tail)
tail.position = {
start: point(token.start),
// @ts-expect-error: we’ll add `end` later.
end: undefined
}
siblings.push(tail)
}

this.stack.push(tail)
Expand Down Expand Up @@ -1301,8 +1305,12 @@ function compiler(options) {

/** @returns {Heading} */
function heading() {
// @ts-expect-error `depth` will be set later.
return {type: 'heading', depth: undefined, children: []}
return {
type: 'heading',
// @ts-expect-error `depth` will be set later.
depth: 0,
children: []
}
}

/** @returns {Break} */
Expand Down
4 changes: 2 additions & 2 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -177,9 +177,9 @@ mdast compiler context (TypeScript type).
— capture some of the output data
* `resume` (`() => string`)
— stop capturing and access the output data
* `enter` (`(node: Node, token: Token, onError?: OnEnterError) => Node`)
* `enter` (`(node: Node, token: Token, onError?: OnEnterError) => undefined`)
— enter a token
* `exit` (`(token: Token, onError?: OnExitError) => Node`)
* `exit` (`(token: Token, onError?: OnExitError) => undefined`)
— exit a token
* `sliceSerialize` (`(token: Token, expandTabs?: boolean) => string`)
— get the string value of a token
Expand Down

0 comments on commit 18f4bb0

Please sign in to comment.