Add JSDoc based types

Author: wooorm

.gitignore

@@ -1,4 +1,5 @@
 .DS_Store
+*.d.ts
 *.log
 coverage/
 node_modules/

index.d.ts

@@ -1,36 +1,63 @@
+/**
+ * @typedef {import('unist').Node} Node
+ * @typedef {import('unist').Parent} Parent
+ *
+ * @typedef {import('unist-util-is').Type} Type
+ * @typedef {import('unist-util-is').Props} Props
+ * @typedef {import('unist-util-is').TestFunctionAnything} TestFunctionAnything
+ */
+
 import {convert} from 'unist-util-is'
 
-export function findAllBefore(parent, index, test) {
-  var is = convert(test)
-  var results = []
-  var offset = -1
+export const findAllBefore =
+  /**
+   * @type {(
+   *  (<T extends Node>(node: Parent, index: Node|number, test: T['type']|Partial<T>|import('unist-util-is').TestFunctionPredicate<T>|Array.<T['type']|Partial<T>|import('unist-util-is').TestFunctionPredicate<T>>) => Array.<T>) &
+   *  ((node: Parent, index: Node|number, test?: null|undefined|Type|Props|TestFunctionAnything|Array<Type|Props|TestFunctionAnything>) => Array.<Node>)
+   * )}
+   */
+  (
+    /**
+     * Utility to get all children of a parent after a node or index
+     *
+     * @param {Parent} parent Parent node
+     * @param {Node|number} index Child of `parent`, or it’s index
+     * @param {null|undefined|Type|Props|TestFunctionAnything|Array<Type|Props|TestFunctionAnything>} [test] is-compatible test (such as a type)
+     * @returns {Array.<Node>}
+     */
+    function (parent, index, test) {
+      var is = convert(test)
+      /** @type {Array.<Node>} */
+      var results = []
+      var offset = -1
 
-  if (!parent || !parent.type || !parent.children) {
-    throw new Error('Expected parent node')
-  }
+      if (!parent || !parent.type || !parent.children) {
+        throw new Error('Expected parent node')
+      }
 
-  if (typeof index === 'number') {
-    if (index < 0 || index === Number.POSITIVE_INFINITY) {
-      throw new Error('Expected positive finite number as index')
-    }
-  } else {
-    index = parent.children.indexOf(index)
+      if (typeof index === 'number') {
+        if (index < 0 || index === Number.POSITIVE_INFINITY) {
+          throw new Error('Expected positive finite number as index')
+        }
+      } else {
+        index = parent.children.indexOf(index)
 
-    if (index < 0) {
-      throw new Error('Expected child node or index')
-    }
-  }
+        if (index < 0) {
+          throw new Error('Expected child node or index')
+        }
+      }
 
-  // Performance.
-  if (index > parent.children.length) {
-    index = parent.children.length
-  }
+      // Performance.
+      if (index > parent.children.length) {
+        index = parent.children.length
+      }
 
-  while (++offset < index) {
-    if (is(parent.children[offset], offset, parent)) {
-      results.push(parent.children[offset])
-    }
-  }
+      while (++offset < index) {
+        if (is(parent.children[offset], offset, parent)) {
+          results.push(parent.children[offset])
+        }
+      }
 
-  return results
-}
+      return results
+    }
+  )

index.js

@@ -31,22 +31,29 @@
     "index.js"
   ],
   "dependencies": {
+    "@types/unist": "^2.0.0",
     "unist-util-is": "^5.0.0"
   },
   "devDependencies": {
+    "@types/tape": "^4.0.0",
     "c8": "^7.0.0",
     "prettier": "^2.0.0",
     "remark": "^13.0.0",
     "remark-cli": "^9.0.0",
     "remark-preset-wooorm": "^8.0.0",
+    "rimraf": "^3.0.0",
     "tape": "^5.0.0",
+    "type-coverage": "^2.0.0",
+    "typescript": "^4.0.0",
     "xo": "^0.38.0"
   },
   "scripts": {
+    "prepack": "npm run build && npm run format",
+    "build": "rimraf \"*.d.ts\" && tsc && type-coverage",
     "format": "remark . -qfo && prettier . -w --loglevel warn && xo --fix",
     "test-api": "node test.js",
     "test-coverage": "c8 --check-coverage --branches 100 --functions 100 --lines 100 --statements 100 --reporter lcov node test.js",
-    "test": "npm run format && npm run test-coverage"
+    "test": "npm run build && npm run format && npm run test-coverage"
   },
   "prettier": {
     "tabWidth": 2,
@@ -67,5 +74,10 @@
     "plugins": [
       "preset-wooorm"
     ]
+  },
+  "typeCoverage": {
+    "atLeast": 100,
+    "detail": true,
+    "strict": true
   }
 }

package.json

@@ -9,6 +9,7 @@ var children = paragraph.children
 test('unist-util-find-all-before', function (t) {
   t.throws(
     function () {
+      // @ts-ignore runtime.
       findAllBefore()
     },
     /Expected parent node/,
@@ -17,6 +18,7 @@ test('unist-util-find-all-before', function (t) {
 
   t.throws(
     function () {
+      // @ts-ignore runtime.
       findAllBefore({type: 'foo'})
     },
     /Expected parent node/,
@@ -25,6 +27,7 @@ test('unist-util-find-all-before', function (t) {
 
   t.throws(
     function () {
+      // @ts-ignore runtime.
       findAllBefore({type: 'foo', children: []})
     },
     /Expected child node or index/,
@@ -49,6 +52,7 @@ test('unist-util-find-all-before', function (t) {
 
   t.throws(
     function () {
+      // @ts-ignore runtime.
       findAllBefore({type: 'foo', children: [{type: 'bar'}]}, 1, false)
     },
     /Expected function, string, or object as test/,
@@ -57,6 +61,7 @@ test('unist-util-find-all-before', function (t) {
 
   t.throws(
     function () {
+      // @ts-ignore runtime.
       findAllBefore({type: 'foo', children: [{type: 'bar'}]}, 1, true)
     },
     /Expected function, string, or object as test/,
@@ -154,7 +159,11 @@ test('unist-util-find-all-before', function (t) {
     'should return children when given a `test` and existing (#4)'
   )
 
-  function test(node, n) {
+  /**
+   * @param {unknown} _
+   * @param {number} n
+   */
+  function test(_, n) {
     return n > 3
   }
 

test.js

@@ -1,10 +1,15 @@
 {
+  "include": ["*.js"],
   "compilerOptions": {
-    "lib": ["es2015"],
-    "strict": true,
-    "baseUrl": ".",
-    "paths": {
-      "unist-util-find-all-before": ["index.d.ts"]
-    }
+    "target": "ES2020",
+    "lib": ["ES2020"],
+    "module": "ES2020",
+    "moduleResolution": "node",
+    "allowJs": true,
+    "checkJs": true,
+    "declaration": true,
+    "emitDeclarationOnly": true,
+    "allowSyntheticDefaultImports": true,
+    "skipLibCheck": true
   }
 }