Refactor code-style

Author: wooorm

index.js

@@ -1,9 +1,9 @@
 /**
  * @typedef {import('./lib/index.js').Handler} Handler
+ * @typedef {import('./lib/index.js').Info} Info
  * @typedef {import('./lib/index.js').Options} Options
- * @typedef {import('./lib/index.js').TestFunction} TestFunction
  * @typedef {import('./lib/index.js').Test} Test
- * @typedef {import('./lib/index.js').Info} Info
+ * @typedef {import('./lib/index.js').TestFunction} TestFunction
  */
 
 export {headingRange} from './lib/index.js'

lib/index.js

@@ -1,4 +1,5 @@
 /**
+ * @typedef {import('mdast').Content} Content
  * @typedef {import('mdast').Heading} Heading
  * @typedef {import('mdast').Root} Root
  * @typedef {import('unist').Node} UnistNode
@@ -89,27 +90,18 @@
  *   Node to search for.
  */
 
-/**
- * @typedef {Child<Root, Parent<Root, Heading>>} Sibling
- *   Collect nodes in `Tree` that can be parents of `Child`.
- * @template {UnistNode} Tree
- *   All node types in a tree.
- * @template {UnistNode} Node
- *   Node to search for.
- */
-
 /**
  * @callback Handler
  *   Callback called when a section is found.
  * @param {Heading} start
  *   Start of section (a heading node matching `test`).
- * @param {Array<Sibling<Root, Heading>>} between
+ * @param {Array<Content>} between
  *   Nodes between `start` and `end`.
- * @param {Sibling<Root, Heading> | undefined} end
+ * @param {Content | undefined} end
  *   End of section, if any.
  * @param {Info} scope
  *   Extra info.
- * @returns {Array<Sibling<Root, Heading> | null | undefined> | null | undefined | void}
+ * @returns {Array<Content | null | undefined> | null | undefined | void}
  *   Results.
  *
  *   If nothing is returned, nothing will be changed.
@@ -176,8 +168,6 @@ import {toString} from 'mdast-util-to-string'
 // eslint-disable-next-line complexity
 export function headingRange(tree, options, handler) {
   let test = options
-  // To do: smarter types to allow siblings of headings.
-  /** @type {Array<Sibling<Root, Heading>>} */
   const children = 'children' in tree ? tree.children : []
   let ignoreFinalDefinitions = false
 
@@ -260,7 +250,7 @@ export function headingRange(tree, options, handler) {
     if (nodes) {
       // Ensure no empty nodes are inserted.
       // This could be the case if `end` is in `nodes` but no `end` node exists.
-      /** @type {Array<Sibling<Root, Heading>>} */
+      /** @type {Array<Content>} */
       const result = []
       let index = -1
 

test.js

@@ -338,7 +338,7 @@ function checkAndRemove(value, options) {
 
   headingRange(tree, options, function (start, _, end, scope) {
     assert.equal(typeof scope.start, 'number')
-    assert.ok(typeof scope.end === 'number' || scope.end === null)
+    assert.ok(typeof scope.end === 'number' || scope.end === undefined)
     assert.equal(scope.parent && scope.parent.type, 'root')
     return [start, end]
   })