Refactor code-style

Author: wooorm

lib/index.js

@@ -1,10 +1,12 @@
 /**
  * @typedef {import('unist').Node} Node
- *
+ */
+
+/**
  * @typedef Options
  *   Configuration.
  * @property {boolean | null | undefined} [showPositions=true]
- *   Whether to include positional information.
+ *   Whether to include positional information (default: `true`).
  *
  * @typedef State
  *   Info passed around.
@@ -20,7 +22,7 @@ import {color} from './color.js'
  * @param tree
  *   Tree to inspect.
  * @param options
- *   Configuration.
+ *   Configuration (optional).
  * @returns
  *   Pretty printed `tree`.
  */
@@ -60,7 +62,7 @@ export function inspectNoColor(tree, options) {
  * @param {unknown} tree
  *   Tree to inspect.
  * @param {Options | null | undefined} [options]
- *   Configuration.
+ *   Configuration (optional).
  * @returns {string}
  *   Pretty printed `tree`.
  */
@@ -284,7 +286,7 @@ function formatNode(node, state) {
  * @param {string} indentation
  *   Indent to use.
  * @param {boolean | undefined} [ignoreFirst=false]
- *   Whether to ignore indenting the first line.
+ *   Whether to ignore indenting the first line (default: `false`).
  * @returns {string}
  *   Indented `value`.
  */
@@ -304,7 +306,7 @@ function indent(value, indentation, ignoreFirst) {
 /**
  * Serialize a position.
  *
- * @param {unknown | null | undefined} [value]
+ * @param {unknown} [value]
  *   Position to serialize.
  * @returns {string}
  *   Serialized position.

package.json

@@ -42,6 +42,7 @@
     "@types/unist": "^2.0.0"
   },
   "devDependencies": {
+    "@types/nlcst": "^1.0.0",
     "@types/node": "^20.0.0",
     "c8": "^8.0.0",
     "chalk": "^5.0.0",