Refactor types

Author: wooorm

.gitignore

@@ -4,3 +4,4 @@
 coverage/
 node_modules/
 yarn.lock
+!/index.d.ts

index.d.ts

@@ -0,0 +1,17 @@
+export {inspectColor, inspectNoColor, inspect} from './lib/index.js'
+
+// To do: next major: remove.
+/**
+ * Deprecated, use `Options`.
+ */
+export type InspectOptions = Options
+
+/**
+ * Configuration.
+ */
+export interface Options {
+  /**
+   * Whether to include positional information (default: `true`).
+   */
+  showPositions?: boolean | null | undefined
+}

index.js

@@ -1,8 +1,2 @@
-/**
- * @typedef {import('./lib/index.js').Options} Options
- *
- * @typedef {Options} InspectOptions
- *   Deprecated, use `Options`.
- */
-
-export {inspect, inspectColor, inspectNoColor} from './lib/index.js'
+// Note: types exposed from `index.d.ts`.
+export {inspectColor, inspectNoColor, inspect} from './lib/index.js'

lib/index.js

@@ -1,13 +1,9 @@
 /**
- * @typedef {import('unist').Node} Node
+ * @import {Options} from 'unist-util-inspect'
+ * @import {Node} from 'unist'
  */
 
 /**
- * @typedef Options
- *   Configuration.
- * @property {boolean | null | undefined} [showPositions=true]
- *   Whether to include positional information (default: `true`).
- *
  * @typedef State
  *   Info passed around.
  * @property {boolean} showPositions
@@ -29,6 +25,7 @@ import {color} from '#conditional-color'
 /* c8 ignore next */
 export const inspect = color ? inspectColor : inspectNoColor
 
+// To do: next major (?): use `Object.hasOwn`.
 const own = {}.hasOwnProperty
 
 const bold = ansiColor(1, 22)

package.json

@@ -86,6 +86,31 @@
     "strict": true
   },
   "xo": {
+    "overrides": [
+      {
+        "files": [
+          "**/*.d.ts"
+        ],
+        "rules": {
+          "@typescript-eslint/array-type": [
+            "error",
+            {
+              "default": "generic"
+            }
+          ],
+          "@typescript-eslint/ban-types": [
+            "error",
+            {
+              "extendDefaults": true
+            }
+          ],
+          "@typescript-eslint/consistent-type-definitions": [
+            "error",
+            "interface"
+          ]
+        }
+      }
+    ],
     "prettier": true,
     "rules": {
       "unicorn/prefer-string-replace-all": "off"

test.js

@@ -1,5 +1,5 @@
 /**
- * @typedef {import('nlcst').Root} NlcstRoot
+ * @import {Root as NlcstRoot} from 'nlcst'
  */
 
 import assert from 'node:assert/strict'

tsconfig.json

@@ -7,11 +7,9 @@
     "exactOptionalPropertyTypes": true,
     "lib": ["es2022"],
     "module": "node16",
-    // Remove after `retext` update.
-    "skipLibCheck": true,
     "strict": true,
     "target": "es2022"
   },
   "exclude": ["coverage/", "node_modules/"],
-  "include": ["**/*.js"]
+  "include": ["**/*.js", "index.d.ts"]
 }