Refactor code-style

Author: wooorm

lib/contents.js

@@ -9,12 +9,13 @@
  * @typedef ContentsOptions
  *   Build configuration.
  * @property {boolean | null | undefined} [tight=false]
- *   Whether to compile list items tightly.
+ *   Whether to compile list items tightly (default: `false`).
  * @property {boolean | null | undefined} [ordered=false]
  *   Whether to compile list items as an ordered list, otherwise they are
- *   unordered.
+ *   unordered (default: `false`).
  * @property {string | null | undefined} [prefix=undefined]
- *   Add a prefix to links to headings in the table of contents.
+ *   Add a prefix to links to headings in the table of contents (default:
+ *   `undefined`).
  *
  *   Useful for example when later going from mdast to hast and sanitizing with
  *   `hast-util-sanitize`.
@@ -99,7 +100,7 @@ function insert(entry, parent, settings) {
       insert(entry, item, settings)
     }
   }
-  // List item
+  // List item.
   else if (tail && tail.type === 'list') {
     entry.depth--
     insert(entry, tail, settings)
@@ -131,26 +132,30 @@ function insert(entry, parent, settings) {
 }
 
 /**
- * @param {Array<PhrasingContent>} [nodes]
+ * @param {Array<PhrasingContent>} nodes
  * @returns {Array<PhrasingContent>}
  */
 function all(nodes) {
   /** @type {Array<PhrasingContent>} */
-  let result = []
+  const results = []
   let index = -1
 
-  if (nodes) {
-    while (++index < nodes.length) {
-      result = result.concat(one(nodes[index]))
+  while (++index < nodes.length) {
+    const result = one(nodes[index])
+
+    if (Array.isArray(result)) {
+      results.push(...result)
+    } else {
+      results.push(result)
     }
   }
 
-  return result
+  return results
 }
 
 /**
  * @param {PhrasingContent} node
- * @returns {PhrasingContent | Array<PhrasingContent>}
+ * @returns {Array<PhrasingContent> | PhrasingContent}
  */
 function one(node) {
   if (node.type === 'footnoteReference') {

lib/index.js

@@ -1,17 +1,18 @@
 /**
- * @typedef {import('mdast').Nodes} Nodes
  * @typedef {import('mdast').List} List
+ * @typedef {import('mdast').Nodes} Nodes
  * @typedef {import('./search.js').SearchOptions} SearchOptions
  * @typedef {import('./contents.js').ContentsOptions} ContentsOptions
  */
 
 /**
- * @typedef {SearchOptions & ContentsOptions & ExtraOptions} Options
+ * @typedef {ContentsOptions & ExtraOptions & SearchOptions} Options
  *
  * @typedef ExtraOptions
  *   Extra configuration fields.
  * @property {string | null | undefined} [heading]
- *   Heading to look for, wrapped in `new RegExp('^(' + value + ')$', 'i')`.
+ *   Heading to look for, wrapped in `new RegExp('^(' + value + ')$', 'i')`
+ *   (default: `undefined`).
  *
  * @typedef Result
  *   Results.
@@ -49,7 +50,7 @@ import {toExpression} from './to-expression.js'
  * @param {Nodes} tree
  *   Tree to search and generate from.
  * @param {Options | null | undefined} [options]
- *   Configuration.
+ *   Configuration (optional).
  * @returns {Result}
  *   Results.
  */

lib/search.js

@@ -1,6 +1,6 @@
 /**
- * @typedef {import('mdast').Nodes} Nodes
  * @typedef {import('mdast').Heading} Heading
+ * @typedef {import('mdast').Nodes} Nodes
  * @typedef {import('mdast').PhrasingContent} PhrasingContent
  * @typedef {import('unist-util-is').Test} Test
  */
@@ -14,18 +14,20 @@
  * @typedef SearchOptions
  *   Search configuration.
  * @property {Rank | null | undefined} [maxDepth=6]
- *   Maximum heading depth to include in the table of contents.
+ *   Maximum heading depth to include in the table of contents (default: `6`).
  *
  *   This is inclusive: when set to `3`, level three headings are included
  *   (those with three hashes, `###`).
  * @property {string | null | undefined} [skip]
- *   Headings to skip, wrapped in `new RegExp('^(' + value + ')$', 'i')`.
+ *   Headings to skip, wrapped in `new RegExp('^(' + value + ')$', 'i')`
+ *   (default: `undefined`).
  *
  *   Any heading matching this expression will not be present in the table of
  *   contents.
  * @property {Test} [parents]
  *   Allow headings to be children of certain node types (default: the to `toc`
- *   given `tree`, to only allow top-level headings).
+ *   given `tree`, to only allow top-level headings) (default:
+ *   `d => d === tree`).
  *
  *   Internally, uses `unist-util-is` to check, so `parents` can be any
  *   `is`-compatible test.
@@ -51,8 +53,8 @@
 
 import Slugger from 'github-slugger'
 import {toString} from 'mdast-util-to-string'
-import {visit} from 'unist-util-visit'
 import {convert} from 'unist-util-is'
+import {visit} from 'unist-util-visit'
 import {toExpression} from './to-expression.js'
 
 const slugs = new Slugger()
@@ -66,8 +68,14 @@ const slugs = new Slugger()
  * @returns {SearchResult}
  */
 export function search(root, expression, settings) {
+  const max = 'children' in root ? root.children.length : 0
   const skip = settings.skip ? toExpression(settings.skip) : undefined
-  const parents = convert(settings.parents || ((d) => d === root))
+  const parents = convert(
+    settings.parents ||
+      function (d) {
+        return d === root
+      }
+  )
   /** @type {Array<SearchEntry>} */
   const map = []
   /** @type {number | undefined} */
@@ -81,7 +89,7 @@ export function search(root, expression, settings) {
 
   // Visit all headings in `root`.  We `slug` all headings (to account for
   // duplicates), but only create a TOC from top-level headings (by default).
-  visit(root, 'heading', (node, position, parent) => {
+  visit(root, 'heading', function (node, position, parent) {
     const value = toString(node, {includeImageAlt: false})
     /** @type {string} */
     // @ts-expect-error `hProperties` from <https://github.com/syntax-tree/mdast-util-to-hast>
@@ -126,9 +134,7 @@ export function search(root, expression, settings) {
 
   return {
     index: index === undefined ? -1 : index,
-    // <sindresorhus/eslint-plugin-unicorn#980>
-    // @ts-expect-error Looks like a parent.
-    endIndex: index === undefined ? -1 : endIndex || root.children.length, // eslint-disable-line unicorn/explicit-length-check
+    endIndex: index === undefined ? -1 : endIndex || max,
     map
   }
 }