Refactor code-style

Author: wooorm

lib/contents.js

@@ -7,17 +7,23 @@
  * @typedef {import('./search.js').SearchEntry} SearchEntry
  *
  * @typedef ContentsOptions
- * @property {boolean} [tight=false] Whether to compile list-items tightly.
- * @property {boolean} [ordered=false] Whether to compile list-items as an ordered list, otherwise they are unordered.
- * @property {string|null} [prefix=null] Add a prefix to links to headings in the table of contents. Useful for example when later going from mdast to hast and sanitizing with `hast-util-sanitize`.
+ * @property {boolean} [tight=false]
+ *   Whether to compile list-items tightly.
+ * @property {boolean} [ordered=false]
+ *   Whether to compile list-items as an ordered list, otherwise they are
+ *   unordered.
+ * @property {string|null} [prefix=null]
+ *   Add a prefix to links to headings in the table of contents.
+ *   Useful for example when later going from mdast to hast and sanitizing with
+ *   `hast-util-sanitize`.
  */
 
 import extend from 'extend'
 
 /**
  * Transform a list of heading objects to a markdown list.
  *
- * @param {Array.<SearchEntry>} map
+ * @param {Array<SearchEntry>} map
  * @param {ContentsOptions} settings
  */
 export function contents(map, settings) {
@@ -129,11 +135,11 @@ function insert(entry, parent, settings) {
 }
 
 /**
- * @param {Array.<PhrasingContent>} [nodes]
- * @returns {Array.<StaticPhrasingContent>}
+ * @param {Array<PhrasingContent>} [nodes]
+ * @returns {Array<StaticPhrasingContent>}
  */
 function all(nodes) {
-  /** @type {Array.<StaticPhrasingContent>} */
+  /** @type {Array<StaticPhrasingContent>} */
   let result = []
   let index = -1
 
@@ -148,7 +154,7 @@ function all(nodes) {
 
 /**
  * @param {PhrasingContent} node
- * @returns {StaticPhrasingContent|Array.<StaticPhrasingContent>}
+ * @returns {StaticPhrasingContent|Array<StaticPhrasingContent>}
  */
 function one(node) {
   if (

lib/index.js

@@ -6,7 +6,8 @@
  * @typedef {SearchOptions & ContentsOptions & ExtraOptions} Options
  *
  * @typedef ExtraOptions
- * @property {string} [heading] Heading to look for, wrapped in `new RegExp('^(' + value + ')$', 'i')`.
+ * @property {string} [heading]
+ *   Heading to look for, wrapped in `new RegExp('^(' + value + ')$', 'i')`.
  *
  * @typedef Result
  * @property {number|null} index

lib/search.js

@@ -7,19 +7,29 @@
  * @typedef {import('unist-util-is').TestFunctionAnything} IsTestFunctionAnything
  *
  * @typedef SearchOptions
- * @property {string} [skip] Headings to skip, wrapped in `new RegExp('^(' + value + ')$', 'i')`. Any heading matching this expression will not be present in the table of contents.
- * @property {IsType|IsProps|IsTestFunctionAnything|Array.<IsType|IsProps|IsTestFunctionAnything>} [parents]
- * @property {Heading['depth']} [maxDepth=6] Maximum heading depth to include in the table of contents. This is inclusive: when set to `3`, level three headings are included (those with three hashes, `###`).
+ * @property {string} [skip]
+ *   Headings to skip, wrapped in `new RegExp('^(' + value + ')$', 'i')`.
+ *   Any heading matching this expression will not be present in the table of
+ *   contents.
+ * @property {IsType|IsProps|IsTestFunctionAnything|Array<IsType|IsProps|IsTestFunctionAnything>} [parents]
+ *   Allow headings to be children of certain node types (default: the to `toc`
+ *   given `tree`, to only allow top-level headings).
+ *   Internally, uses `unist-util-is` to check, so `parents` can be any
+ *   `is`-compatible test.
+ * @property {Heading['depth']} [maxDepth=6]
+ *   Maximum heading depth to include in the table of contents.
+ *   This is inclusive: when set to `3`, level three headings are included
+ *   (those with three hashes, `###`).
  *
  * @typedef SearchEntry
  * @property {Heading['depth']} depth
- * @property {Array.<PhrasingContent>} children
+ * @property {Array<PhrasingContent>} children
  * @property {string} id
  *
  * @typedef SearchResult
  * @property {number} index
  * @property {number} endIndex
- * @property {Array.<SearchEntry>} map
+ * @property {Array<SearchEntry>} map
  */
 
 import Slugger from 'github-slugger'
@@ -41,7 +51,7 @@ const slugs = new Slugger()
 export function search(root, expression, settings) {
   const skip = settings.skip && toExpression(settings.skip)
   const parents = convert(settings.parents || ((d) => d === root))
-  /** @type {Array.<SearchEntry>} */
+  /** @type {Array<SearchEntry>} */
   const map = []
   /** @type {number|undefined} */
   let index

package.json

@@ -68,7 +68,7 @@
     "format": "remark . -qfo && prettier . -w --loglevel warn && xo --fix",
     "test-api": "node test/index.js",
     "test-coverage": "c8 --check-coverage --branches 100 --functions 100 --lines 100 --statements 100 --reporter lcov node test/index.js",
-    "test": "npm run format && npm run test-coverage"
+    "test": "npm run build && npm run format && npm run test-coverage"
   },
   "prettier": {
     "tabWidth": 2,