Update @types/hast, utilities

syntax-tree · Aug 6, 2023 · 23a91fc · 23a91fc
1 parent 7a76496
commit 23a91fc
Show file tree

Hide file tree

Showing 15 changed files with 70 additions and 94 deletions.
diff --git a/lib/handle/comment.js b/lib/handle/comment.js
@@ -1,6 +1,6 @@
 /**
  * @typedef {import('../types.js').Comment} Comment
- * @typedef {import('../types.js').Parent} Parent
+ * @typedef {import('../types.js').Parents} Parents
  * @typedef {import('../types.js').State} State
  */
 
@@ -13,7 +13,7 @@ import {stringifyEntities} from 'stringify-entities'
  * Node to handle.
  * @param {number | undefined} _1
  * Index of `node` in `parent.
- * @param {Parent | undefined} _2
+ * @param {Parents | undefined} _2
  * Parent of `node`.
  * @param {State} state
  * Info passed around about the current state.

diff --git a/lib/handle/doctype.js b/lib/handle/doctype.js
@@ -1,6 +1,6 @@
 /**
  * @typedef {import('../types.js').DocType} DocType
- * @typedef {import('../types.js').Parent} Parent
+ * @typedef {import('../types.js').Parents} Parents
  * @typedef {import('../types.js').State} State
  */
 
@@ -11,7 +11,7 @@
  * Node to handle.
  * @param {number | undefined} _2
  * Index of `node` in `parent.
- * @param {Parent | undefined} _3
+ * @param {Parents | undefined} _3
  * Parent of `node`.
  * @param {State} state
  * Info passed around about the current state.

diff --git a/lib/handle/element.js b/lib/handle/element.js
@@ -1,6 +1,6 @@
 /**
  * @typedef {import('../types.js').State} State
- * @typedef {import('../types.js').Parent} Parent
+ * @typedef {import('../types.js').Parents} Parents
  * @typedef {import('../types.js').Element} Element
  * @typedef {import('../types.js').Properties} Properties
  * @typedef {import('../types.js').PropertyValue} PropertyValue
@@ -53,7 +53,7 @@ const constants = {
  * Node to handle.
  * @param {number | undefined} index
  * Index of `node` in `parent.
- * @param {Parent | undefined} parent
+ * @param {Parents | undefined} parent
  * Parent of `node`.
  * @param {State} state
  * Info passed around about the current state.
@@ -89,6 +89,8 @@ export function element(node, index, parent, state) {
  // categorisation.
  // This enables for example `menuitem`s, which are void in W3C HTML but not
  // void in WHATWG HTML, to be stringified properly.
+ // Note: `menuitem` has since been removed from the HTML spec, and so is no
+ // longer void.
  if (content) selfClosing = false
 
  if (attrs || !omit || !opening(node, index, parent)) {

diff --git a/lib/handle/index.js b/lib/handle/index.js
@@ -1,7 +1,7 @@
 /**
  * @typedef {import('../types.js').State} State
- * @typedef {import('../types.js').Node} Node
- * @typedef {import('../types.js').Parent} Parent
+ * @typedef {import('../types.js').Nodes} Nodes
+ * @typedef {import('../types.js').Parents} Parents
  */
 
 import {zwitch} from 'zwitch'
@@ -13,7 +13,7 @@ import {root} from './root.js'
 import {text} from './text.js'
 
 /**
- * @type {(node: Node, index: number | undefined, parent: Parent | undefined, state: State) => string}
+ * @type {(node: Nodes, index: number | undefined, parent: Parents | undefined, state: State) => string}
  */
 export const handle = zwitch('type', {
  invalid,

diff --git a/lib/handle/raw.js b/lib/handle/raw.js
@@ -1,6 +1,6 @@
 /**
  * @typedef {import('../types.js').State} State
- * @typedef {import('../types.js').Parent} Parent
+ * @typedef {import('../types.js').Parents} Parents
  * @typedef {import('../types.js').Raw} Raw
  */
 
@@ -13,7 +13,7 @@ import {text} from './text.js'
  * Node to handle.
  * @param {number | undefined} index
  * Index of `node` in `parent.
- * @param {Parent | undefined} parent
+ * @param {Parents | undefined} parent
  * Parent of `node`.
  * @param {State} state
  * Info passed around about the current state.

diff --git a/lib/handle/root.js b/lib/handle/root.js
@@ -1,6 +1,6 @@
 /**
  * @typedef {import('../types.js').Root} Root
- * @typedef {import('../types.js').Parent} Parent
+ * @typedef {import('../types.js').Parents} Parents
  * @typedef {import('../types.js').State} State
  */
 
@@ -11,7 +11,7 @@
  * Node to handle.
  * @param {number | undefined} _1
  * Index of `node` in `parent.
- * @param {Parent | undefined} _2
+ * @param {Parents | undefined} _2
  * Parent of `node`.
  * @param {State} state
  * Info passed around about the current state.

diff --git a/lib/handle/text.js b/lib/handle/text.js
@@ -1,6 +1,6 @@
 /**
  * @typedef {import('../types.js').State} State
- * @typedef {import('../types.js').Parent} Parent
+ * @typedef {import('../types.js').Parents} Parents
  * @typedef {import('../types.js').Raw} Raw
  * @typedef {import('../types.js').Text} Text
  */
@@ -14,7 +14,7 @@ import {stringifyEntities} from 'stringify-entities'
  * Node to handle.
  * @param {number | undefined} _
  * Index of `node` in `parent.
- * @param {Parent | undefined} parent
+ * @param {Parents | undefined} parent
  * Parent of `node`.
  * @param {State} state
  * Info passed around about the current state.

diff --git a/lib/index.js b/lib/index.js
@@ -1,7 +1,7 @@
 /**
- * @typedef {import('./types.js').Node} Node
- * @typedef {import('./types.js').Parent} Parent
- * @typedef {import('./types.js').Content} Content
+ * @typedef {import('./types.js').Nodes} Nodes
+ * @typedef {import('./types.js').Parents} Parents
+ * @typedef {import('./types.js').RootContent} RootContent
  * @typedef {import('./types.js').Options} Options
  * @typedef {import('./types.js').State} State
  */
@@ -13,7 +13,7 @@ import {handle} from './handle/index.js'
 /**
  * Serialize hast as HTML.
  *
- * @param {Node | Array<Content>} tree
+ * @param {Nodes | Array<RootContent>} tree
  * Tree to serialize.
  * @param {Options | null | undefined} [options]
  * Configuration.
@@ -71,11 +71,11 @@ export function toHtml(tree, options) {
  *
  * @this {State}
  * Info passed around about the current state.
- * @param {Node} node
+ * @param {Nodes} node
  * Node to handle.
  * @param {number | undefined} index
  * Index of `node` in `parent.
- * @param {Parent | undefined} parent
+ * @param {Parents | undefined} parent
  * Parent of `node`.
  * @returns {string}
  * Serialized node.
@@ -89,7 +89,7 @@ function one(node, index, parent) {
  *
  * @this {State}
  * Info passed around about the current state.
- * @param {Parent | undefined} parent
+ * @param {Parents | undefined} parent
  * Parent whose children to serialize.
  * @returns {string}
  */

diff --git a/lib/omission/closing.js b/lib/omission/closing.js
@@ -1,6 +1,6 @@
 /**
  * @typedef {import('../types.js').Element} Element
- * @typedef {import('../types.js').Parent} Parent
+ * @typedef {import('../types.js').Parents} Parents
  */
 
 import {whitespace} from 'hast-util-whitespace'
@@ -19,7 +19,6 @@ export const closing = omission({
  rp: rubyElement,
  optgroup,
  option,
- menuitem,
  colgroup: headOrColgroupOrCaption,
  caption: headOrColgroupOrCaption,
  thead,
@@ -37,7 +36,7 @@ export const closing = omission({
  * Element.
  * @param {number | undefined} index
  * Index of element in parent.
- * @param {Parent | undefined} parent
+ * @param {Parents | undefined} parent
  * Parent of element.
  * @returns {boolean}
  * Whether the closing tag can be omitted.
@@ -58,7 +57,7 @@ function headOrColgroupOrCaption(_, index, parent) {
  * Element.
  * @param {number | undefined} index
  * Index of element in parent.
- * @param {Parent | undefined} parent
+ * @param {Parents | undefined} parent
  * Parent of element.
  * @returns {boolean}
  * Whether the closing tag can be omitted.
@@ -75,7 +74,7 @@ function html(_, index, parent) {
  * Element.
  * @param {number | undefined} index
  * Index of element in parent.
- * @param {Parent | undefined} parent
+ * @param {Parents | undefined} parent
  * Parent of element.
  * @returns {boolean}
  * Whether the closing tag can be omitted.
@@ -92,7 +91,7 @@ function body(_, index, parent) {
  * Element.
  * @param {number | undefined} index
  * Index of element in parent.
- * @param {Parent | undefined} parent
+ * @param {Parents | undefined} parent
  * Parent of element.
  * @returns {boolean}
  * Whether the closing tag can be omitted.
@@ -153,7 +152,7 @@ function p(_, index, parent) {
  * Element.
  * @param {number | undefined} index
  * Index of element in parent.
- * @param {Parent | undefined} parent
+ * @param {Parents | undefined} parent
  * Parent of element.
  * @returns {boolean}
  * Whether the closing tag can be omitted.
@@ -170,7 +169,7 @@ function li(_, index, parent) {
  * Element.
  * @param {number | undefined} index
  * Index of element in parent.
- * @param {Parent | undefined} parent
+ * @param {Parents | undefined} parent
  * Parent of element.
  * @returns {boolean}
  * Whether the closing tag can be omitted.
@@ -191,7 +190,7 @@ function dt(_, index, parent) {
  * Element.
  * @param {number | undefined} index
  * Index of element in parent.
- * @param {Parent | undefined} parent
+ * @param {Parents | undefined} parent
  * Parent of element.
  * @returns {boolean}
  * Whether the closing tag can be omitted.
@@ -212,7 +211,7 @@ function dd(_, index, parent) {
  * Element.
  * @param {number | undefined} index
  * Index of element in parent.
- * @param {Parent | undefined} parent
+ * @param {Parents | undefined} parent
  * Parent of element.
  * @returns {boolean}
  * Whether the closing tag can be omitted.
@@ -233,7 +232,7 @@ function rubyElement(_, index, parent) {
  * Element.
  * @param {number | undefined} index
  * Index of element in parent.
- * @param {Parent | undefined} parent
+ * @param {Parents | undefined} parent
  * Parent of element.
  * @returns {boolean}
  * Whether the closing tag can be omitted.
@@ -250,7 +249,7 @@ function optgroup(_, index, parent) {
  * Element.
  * @param {number | undefined} index
  * Index of element in parent.
- * @param {Parent | undefined} parent
+ * @param {Parents | undefined} parent
  * Parent of element.
  * @returns {boolean}
  * Whether the closing tag can be omitted.
@@ -264,37 +263,14 @@ function option(_, index, parent) {
  )
 }
 
-/**
- * Whether to omit `</menuitem>`.
- *
- * @param {Element} _
- * Element.
- * @param {number | undefined} index
- * Index of element in parent.
- * @param {Parent | undefined} parent
- * Parent of element.
- * @returns {boolean}
- * Whether the closing tag can be omitted.
- */
-function menuitem(_, index, parent) {
- const next = siblingAfter(parent, index)
- return (
- !next ||
- (next.type === 'element' &&
- (next.tagName === 'menuitem' ||
- next.tagName === 'hr' ||
- next.tagName === 'menu'))
- )
-}
-
 /**
  * Whether to omit `</thead>`.
  *
  * @param {Element} _
  * Element.
  * @param {number | undefined} index
  * Index of element in parent.
- * @param {Parent | undefined} parent
+ * @param {Parents | undefined} parent
  * Parent of element.
  * @returns {boolean}
  * Whether the closing tag can be omitted.
@@ -315,7 +291,7 @@ function thead(_, index, parent) {
  * Element.
  * @param {number | undefined} index
  * Index of element in parent.
- * @param {Parent | undefined} parent
+ * @param {Parents | undefined} parent
  * Parent of element.
  * @returns {boolean}
  * Whether the closing tag can be omitted.
@@ -336,7 +312,7 @@ function tbody(_, index, parent) {
  * Element.
  * @param {number | undefined} index
  * Index of element in parent.
- * @param {Parent | undefined} parent
+ * @param {Parents | undefined} parent
  * Parent of element.
  * @returns {boolean}
  * Whether the closing tag can be omitted.
@@ -352,7 +328,7 @@ function tfoot(_, index, parent) {
  * Element.
  * @param {number | undefined} index
  * Index of element in parent.
- * @param {Parent | undefined} parent
+ * @param {Parents | undefined} parent
  * Parent of element.
  * @returns {boolean}
  * Whether the closing tag can be omitted.
@@ -369,7 +345,7 @@ function tr(_, index, parent) {
  * Element.
  * @param {number | undefined} index
  * Index of element in parent.
- * @param {Parent | undefined} parent
+ * @param {Parents | undefined} parent
  * Parent of element.
  * @returns {boolean}
  * Whether the closing tag can be omitted.

diff --git a/lib/omission/opening.js b/lib/omission/opening.js
@@ -1,7 +1,7 @@
 /**
  * @typedef {import('../types.js').Element} Element
- * @typedef {import('../types.js').Parent} Parent
- * @typedef {import('../types.js').Content} Content
+ * @typedef {import('../types.js').Parents} Parents
+ * @typedef {import('../types.js').RootContent} RootContent
  */
 
 import {whitespace} from 'hast-util-whitespace'
@@ -94,7 +94,7 @@ function body(node) {
  * Element.
  * @param {number | undefined} index
  * Index of element in parent.
- * @param {Parent | undefined} parent
+ * @param {Parents | undefined} parent
  * Parent of element.
  * @returns {boolean}
  * Whether the opening tag can be omitted.
@@ -124,7 +124,7 @@ function colgroup(node, index, parent) {
  * Element.
  * @param {number | undefined} index
  * Index of element in parent.
- * @param {Parent | undefined} parent
+ * @param {Parents | undefined} parent
  * Parent of element.
  * @returns {boolean}
  * Whether the opening tag can be omitted.