Refactor code-style

Author: wooorm

index.d.ts

@@ -1,8 +1,8 @@
-import type {Literal} from 'hast'
+import type {Data, Literal} from 'hast'
 import type {State} from './lib/state.js'
 
 // Expose types.
-export type {State, Handler, Handlers, Options} from './lib/state.js'
+export type {Handler, Handlers, Options, State} from './lib/state.js'
 
 // To do: next major: remove.
 /**
@@ -13,33 +13,39 @@ export type H = State
 // Expose JS API.
 export {handlers as defaultHandlers} from './lib/handlers/index.js'
 // To do: next major: remove.
-export {one, all} from './lib/state.js'
+export {all, one} from './lib/state.js'
 export {toHast} from './lib/index.js'
 
-// Expose node type.
 /**
  * Raw string of HTML embedded into HTML AST.
  */
-// eslint-disable-next-line @typescript-eslint/consistent-type-definitions
 export interface Raw extends Literal {
   /**
-   * Node type.
+   * Node type of raw.
    */
   type: 'raw'
+
+  /**
+   * Data associated with the hast raw.
+   */
+  data?: RawData | undefined
 }
 
+/**
+ * Info associated with hast raw nodes by the ecosystem.
+ */
+export interface RawData extends Data {}
+
 // Register nodes in content.
 declare module 'hast' {
-  // eslint-disable-next-line @typescript-eslint/consistent-type-definitions
-  interface RootContentMap {
+  interface ElementContentMap {
     /**
      * Raw string of HTML embedded into HTML AST.
      */
     raw: Raw
   }
 
-  // eslint-disable-next-line @typescript-eslint/consistent-type-definitions
-  interface ElementContentMap {
+  interface RootContentMap {
     /**
      * Raw string of HTML embedded into HTML AST.
      */

lib/handlers/blockquote.js

@@ -4,6 +4,9 @@
  * @typedef {import('../state.js').State} State
  */
 
+// Make VS Code show references to the above types.
+''
+
 /**
  * Turn an mdast `blockquote` node into hast.
  *

lib/handlers/break.js

@@ -5,6 +5,9 @@
  * @typedef {import('../state.js').State} State
  */
 
+// Make VS Code show references to the above types.
+''
+
 /**
  * Turn an mdast `break` node into hast.
  *

lib/handlers/code.js

@@ -3,9 +3,11 @@
  * @typedef {import('hast').Properties} Properties
  * @typedef {import('mdast').Code} Code
  * @typedef {import('../state.js').State} State
-
  */
 
+// Make VS Code show references to the above types.
+''
+
 /**
  * Turn an mdast `code` node into hast.
  *
@@ -20,7 +22,7 @@ export function code(state, node) {
   const value = node.value ? node.value + '\n' : ''
   // To do: next major, use `node.lang` w/o regex, the splitting’s been going
   // on for years in remark now.
-  const lang = node.lang ? node.lang.match(/^[^ \t]+(?=[ \t]|$)/) : null
+  const lang = node.lang ? node.lang.match(/^[^ \t]+(?=[ \t]|$)/) : undefined
   /** @type {Properties} */
   const properties = {}
 

lib/handlers/delete.js

@@ -2,9 +2,11 @@
  * @typedef {import('hast').Element} Element
  * @typedef {import('mdast').Delete} Delete
  * @typedef {import('../state.js').State} State
-
  */
 
+// Make VS Code show references to the above types.
+''
+
 /**
  * Turn an mdast `delete` node into hast.
  *

lib/handlers/emphasis.js

@@ -4,6 +4,9 @@
  * @typedef {import('../state.js').State} State
  */
 
+// Make VS Code show references to the above types.
+''
+
 /**
  * Turn an mdast `emphasis` node into hast.
  *

lib/handlers/footnote-reference.js

@@ -1,6 +1,6 @@
 /**
- * @typedef {import('mdast').FootnoteReference} FootnoteReference
  * @typedef {import('hast').Element} Element
+ * @typedef {import('mdast').FootnoteReference} FootnoteReference
  * @typedef {import('../state.js').State} State
  */
 

lib/handlers/heading.js

@@ -4,6 +4,9 @@
  * @typedef {import('../state.js').State} State
  */
 
+// Make VS Code show references to the above types.
+''
+
 /**
  * Turn an mdast `heading` node into hast.
  *

lib/handlers/html.js

@@ -1,10 +1,13 @@
 /**
  * @typedef {import('hast').Element} Element
- * @typedef {import('mdast').HTML} Html
+ * @typedef {import('mdast').Html} Html
  * @typedef {import('../state.js').State} State
  * @typedef {import('../../index.js').Raw} Raw
  */
 
+// Make VS Code show references to the above types.
+''
+
 /**
  * Turn an mdast `html` node into hast (`raw` node in dangerous mode, otherwise
  * nothing).
@@ -13,7 +16,7 @@
  *   Info passed around.
  * @param {Html} node
  *   mdast node.
- * @returns {Raw | Element | null}
+ * @returns {Element | Raw | undefined}
  *   hast node.
  */
 export function html(state, node) {
@@ -24,6 +27,5 @@ export function html(state, node) {
     return state.applyData(node, result)
   }
 
-  // To do: next major: return `undefined`.
-  return null
+  return undefined
 }

lib/handlers/image-reference.js

@@ -1,6 +1,6 @@
 /**
- * @typedef {import('hast').ElementContent} ElementContent
  * @typedef {import('hast').Element} Element
+ * @typedef {import('hast').ElementContent} ElementContent
  * @typedef {import('hast').Properties} Properties
  * @typedef {import('mdast').ImageReference} ImageReference
  * @typedef {import('../state.js').State} State
@@ -16,7 +16,7 @@ import {revert} from '../revert.js'
  *   Info passed around.
  * @param {ImageReference} node
  *   mdast node.
- * @returns {ElementContent | Array<ElementContent>}
+ * @returns {Array<ElementContent> | ElementContent}
  *   hast node.
  */
 export function imageReference(state, node) {

lib/handlers/index.js

@@ -59,6 +59,5 @@ export const handlers = {
 
 // Return nothing for nodes that are ignored.
 function ignore() {
-  // To do: next major: return `undefined`.
-  return null
+  return undefined
 }

lib/handlers/inline-code.js

@@ -5,6 +5,9 @@
  * @typedef {import('../state.js').State} State
  */
 
+// Make VS Code show references to the above types.
+''
+
 /**
  * Turn an mdast `inlineCode` node into hast.
  *

lib/handlers/link-reference.js

@@ -16,7 +16,7 @@ import {revert} from '../revert.js'
  *   Info passed around.
  * @param {LinkReference} node
  *   mdast node.
- * @returns {ElementContent | Array<ElementContent>}
+ * @returns {Array<ElementContent> | ElementContent}
  *   hast node.
  */
 export function linkReference(state, node) {

lib/handlers/list-item.js

@@ -2,17 +2,13 @@
  * @typedef {import('hast').Element} Element
  * @typedef {import('hast').ElementContent} ElementContent
  * @typedef {import('hast').Properties} Properties
- * @typedef {import('mdast').Content} Content
  * @typedef {import('mdast').ListItem} ListItem
- * @typedef {import('mdast').Parent} Parent
- * @typedef {import('mdast').Root} Root
+ * @typedef {import('mdast').Parents} Parents
  * @typedef {import('../state.js').State} State
  */
 
-/**
- * @typedef {Root | Content} Nodes
- * @typedef {Extract<Nodes, Parent>} Parents
- */
+// Make VS Code show references to the above types.
+''
 
 /**
  * Turn an mdast `listItem` node into hast.
@@ -123,7 +119,7 @@ function listLoose(node) {
 function listItemLoose(node) {
   const spread = node.spread
 
-  return spread === undefined || spread === null
+  return spread === null || spread === undefined
     ? node.children.length > 1
     : spread
 }

lib/handlers/list.js

@@ -5,6 +5,9 @@
  * @typedef {import('../state.js').State} State
  */
 
+// Make VS Code show references to the above types.
+''
+
 /**
  * Turn an mdast `list` node into hast.
  *

lib/handlers/paragraph.js

@@ -4,6 +4,9 @@
  * @typedef {import('../state.js').State} State
  */
 
+// Make VS Code show references to the above types.
+''
+
 /**
  * Turn an mdast `paragraph` node into hast.
  *

lib/handlers/root.js

@@ -1,18 +1,21 @@
 /**
+ * @typedef {import('hast').Parents} HastParents
  * @typedef {import('hast').Root} HastRoot
- * @typedef {import('hast').Element} HastElement
  * @typedef {import('mdast').Root} MdastRoot
  * @typedef {import('../state.js').State} State
  */
 
+// Make VS Code show references to the above types.
+''
+
 /**
  * Turn an mdast `root` node into hast.
  *
  * @param {State} state
  *   Info passed around.
  * @param {MdastRoot} node
  *   mdast node.
- * @returns {HastRoot | HastElement}
+ * @returns {HastParents}
  *   hast node.
  */
 export function root(state, node) {

lib/handlers/strong.js

@@ -4,6 +4,9 @@
  * @typedef {import('../state.js').State} State
  */
 
+// Make VS Code show references to the above types.
+''
+
 /**
  * Turn an mdast `strong` node into hast.
  *

lib/handlers/table-cell.js

@@ -4,6 +4,9 @@
  * @typedef {import('../state.js').State} State
  */
 
+// Make VS Code show references to the above types.
+''
+
 /**
  * Turn an mdast `tableCell` node into hast.
  *

lib/handlers/table-row.js

@@ -1,18 +1,14 @@
 /**
- * @typedef {import('hast').Properties} Properties
  * @typedef {import('hast').Element} Element
  * @typedef {import('hast').ElementContent} ElementContent
- * @typedef {import('mdast').Content} Content
- * @typedef {import('mdast').Parent} Parent
- * @typedef {import('mdast').Root} Root
+ * @typedef {import('hast').Properties} Properties
+ * @typedef {import('mdast').Parents} Parents
  * @typedef {import('mdast').TableRow} TableRow
  * @typedef {import('../state.js').State} State
  */
 
-/**
- * @typedef {Root | Content} Nodes
- * @typedef {Extract<Nodes, Parent>} Parents
- */
+// Make VS Code show references to the above types.
+''
 
 /**
  * Turn an mdast `tableRow` node into hast.

lib/handlers/table.js

@@ -4,7 +4,7 @@
  * @typedef {import('../state.js').State} State
  */
 
-import {pointStart, pointEnd} from 'unist-util-position'
+import {pointEnd, pointStart} from 'unist-util-position'
 
 /**
  * Turn an mdast `table` node into hast.

lib/handlers/text.js

@@ -14,7 +14,7 @@ import {trimLines} from 'trim-lines'
  *   Info passed around.
  * @param {MdastText} node
  *   mdast node.
- * @returns {HastText | HastElement}
+ * @returns {HastElement | HastText}
  *   hast node.
  */
 export function text(state, node) {

lib/handlers/thematic-break.js

@@ -4,6 +4,9 @@
  * @typedef {import('../state.js').State} State
  */
 
+// Make VS Code show references to the above types.
+''
+
 /**
  * Turn an mdast `thematicBreak` node into hast.
  *