Refactor code-style

Author: wooorm

lib/index.js

@@ -1,30 +1,29 @@
 /**
- * @typedef {import('property-information').Schema} Schema
- * @typedef {import('hast').Root} HastRoot
+ * @typedef {import('hast').Comment} HastComment
  * @typedef {import('hast').Doctype} HastDoctype
  * @typedef {import('hast').Element} HastElement
- * @typedef {import('hast').Comment} HastComment
- * @typedef {import('hast').Text} HastText
  * @typedef {import('hast').Nodes} HastNodes
- * @typedef {import('xast').Root} XastRoot
- * @typedef {import('xast').Element} XastElement
- * @typedef {import('xast').Text} XastText
+ * @typedef {import('hast').Root} HastRoot
+ * @typedef {import('hast').Text} HastText
+ *
+ * @typedef {import('property-information').Schema} Schema
+ *
+ * @typedef {import('xast').Attributes} XastAttributes
  * @typedef {import('xast').Comment} XastComment
  * @typedef {import('xast').Doctype} XastDoctype
- * @typedef {import('xast').Attributes} XastAttributes
- * @typedef {import('xast').RootContent} XastRootContent
- * @typedef {import('xast').Nodes} XastNodes
+ * @typedef {import('xast').Element} XastElement
  * @typedef {import('xast').ElementContent} XastElementContent
+ * @typedef {import('xast').Nodes} XastNodes
+ * @typedef {import('xast').Root} XastRoot
+ * @typedef {import('xast').RootContent} XastRootContent
+ * @typedef {import('xast').Text} XastText
  */
 
 /**
- * @typedef {'html' | 'svg'} Space
- *   Namespace.
- *
  * @typedef Options
  *   Configuration.
  * @property {Space | null | undefined} [space='html']
- *   Which space the document is in.
+ *   Which space the document is in (default: `'html'`).
  *
  *   When an `<svg>` element is found in the HTML space, this package already
  *   automatically switches to and from the SVG space when entering and exiting
@@ -33,21 +32,27 @@
  *   You can also switch explicitly with `xmlns` properties in hast, but note
  *   that only HTML and SVG are supported.
  *
+ * @typedef {'html' | 'svg'} Space
+ *   Namespace.
+ *
  * @typedef State
  *   Info passed around about the current state.
- * @property {Schema} schema
- *   Current schema.
  * @property {string | undefined} ns
  *   Namespace.
+ * @property {Schema} schema
+ *   Current schema.
  */
 
 import {stringify as commas} from 'comma-separated-tokens'
+import {find, html, svg} from 'property-information'
 import {stringify as spaces} from 'space-separated-tokens'
-import {html, svg, find} from 'property-information'
 import {position} from 'unist-util-position'
 import {webNamespaces} from 'web-namespaces'
 import {zwitch} from 'zwitch'
 
+/** @type {Options} */
+const emptyOptions = {}
+
 const own = {}.hasOwnProperty
 
 /** @type {(node: HastNodes, state: State) => XastNodes} */
@@ -57,19 +62,20 @@ const one = zwitch('type', {
   unknown
 })
 
+// To do: next major: remove `space` shortcut.
 /**
  * Turn a hast tree into a xast tree.
  *
  * @param {HastNodes} tree
  *   hast tree to transform.
- * @param {Space | Options | null | undefined} [options]
- *   Configuration.
+ * @param {Options | Space | null | undefined} [options]
+ *   Configuration (optional).
  * @returns {XastNodes}
  *   xast tree.
  */
 export function toXast(tree, options) {
   const settings =
-    typeof options === 'string' ? {space: options} : options || {}
+    typeof options === 'string' ? {space: options} : options || emptyOptions
 
   return one(tree, {
     schema: settings.space === 'svg' ? svg : html,
@@ -118,8 +124,9 @@ function root(node, state) {
   let index = -1
 
   while (++index < node.children.length) {
-    // @ts-expect-error never root.
-    children[index] = one(node.children[index], state)
+    const child = node.children[index]
+    const result = /** @type {XastRootContent} */ (one(child, state))
+    children[index] = result
   }
 
   /** @type {XastRoot} */
@@ -232,11 +239,11 @@ function element(node, state) {
 
       // Ignore nullish, false, and `NaN` values, and falsey known booleans.
       if (
-        value === undefined ||
-        value === null ||
-        value === false ||
         (typeof value === 'number' && Number.isNaN(value)) ||
-        (!value && info.boolean)
+        (!value && info.boolean) ||
+        value === false ||
+        value === null ||
+        value === undefined
       ) {
         continue
       }
@@ -268,13 +275,15 @@ function element(node, state) {
     node.tagName === 'template' &&
     node.content
   ) {
-    // @ts-expect-error: never doctype.
-    children.push(...root(node.content, childState).children)
+    const results = /** @type {Array<XastElementContent>} */ (
+      root(node.content, childState).children
+    )
+    children.push(...results)
   } else {
     while (++index < node.children.length) {
       const child = node.children[index]
-      // @ts-expect-error: never root.
-      children[index] = one(child, childState)
+      const result = /** @type {XastElementContent} */ (one(child, childState))
+      children[index] = result
     }
   }
 
@@ -291,8 +300,11 @@ function element(node, state) {
 
 /**
  * @param {HastNodes} origin
+ *   hast node.
  * @param {XastNodes} node
- * @returns {void}
+ *   xast node.
+ * @returns {undefined}
+ *   Nothing.
  */
 function patch(origin, node) {
   if (origin.position) node.position = position(origin)

package.json

@@ -49,6 +49,7 @@
     "@types/node": "^20.0.0",
     "c8": "^8.0.0",
     "hastscript": "^8.0.0",
+    "mdast-util-to-hast": "^13.0.0",
     "prettier": "^3.0.0",
     "remark-cli": "^11.0.0",
     "remark-preset-wooorm": "^9.0.0",