Add JSDoc based types

Author: wooorm

.gitignore

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

index.js

@@ -1,15 +1,31 @@
+/**
+ * @typedef {import('hast').Parent['children'][number]|import('hast').Root} HastNode
+ * @typedef {import('hast').Text} HastText
+ * @typedef {import('hast').Element & {tagName: 'br'}} HastBreakElement
+ */
+
 var search = /\r?\n|\r/g
 
-// Implementation of the `innerText` setter:
-// <https://html.spec.whatwg.org/#the-innertext-idl-attribute>
-// Note that `innerText` only exists on element.
-// In this utility, we accept all parent nodes and handle them as elements, and
-// for all literals we set the `value` of the given node the the given value.
+/**
+ * Implementation of the `innerText` setter:
+ * <https://html.spec.whatwg.org/#the-innertext-idl-attribute>
+ * Note that `innerText` only exists on element.
+ * In this utility, we accept all parent nodes and handle them as elements, and
+ * for all literals we set the `value` of the given node the the given value.
+ *
+ * @template {HastNode} T
+ * @param {T} node
+ * @param {string} [content]
+ * @returns {T}
+ */
 export function fromText(node, content) {
   var value = content === undefined || content === null ? '' : String(content)
+  /** @type {Array.<HastBreakElement|HastText>} */
   var nodes = []
   var start = 0
+  /** @type {RegExpMatchArray} */
   var match
+  /** @type {number} */
   var end
 
   if ('children' in node) {

package.json

@@ -28,24 +28,35 @@
   "sideEffects": false,
   "type": "module",
   "main": "index.js",
+  "types": "index.d.ts",
   "files": [
+    "index.d.ts",
     "index.js"
   ],
+  "dependencies": {
+    "@types/hast": "^2.0.0"
+  },
   "devDependencies": {
+    "@types/tape": "^4.0.0",
     "c8": "^7.0.0",
     "hastscript": "^7.0.0",
     "prettier": "^2.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",
     "unist-builder": "^3.0.0",
     "xo": "^0.39.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,
@@ -66,5 +77,10 @@
     "plugins": [
       "preset-wooorm"
     ]
+  },
+  "typeCoverage": {
+    "atLeast": 100,
+    "detail": true,
+    "strict": true
   }
 }

test.js

@@ -5,11 +5,13 @@ import {fromText} from './index.js'
 
 test('hast-util-from-text', function (t) {
   t.deepEqual(
+    // @ts-ignore runtime.
     fromText(u('text'), 'foo'),
     u('text', 'foo'),
     'should set text nodes'
   )
 
+  // @ts-ignore runtime.
   t.deepEqual(fromText(u('text')), u('text', ''), 'should reset text nodes (1)')
 
   t.deepEqual(

tsconfig.json

@@ -0,0 +1,15 @@
+{
+  "include": ["*.js"],
+  "compilerOptions": {
+    "target": "ES2020",
+    "lib": ["ES2020"],
+    "module": "ES2020",
+    "moduleResolution": "node",
+    "allowJs": true,
+    "checkJs": true,
+    "declaration": true,
+    "emitDeclarationOnly": true,
+    "allowSyntheticDefaultImports": true,
+    "skipLibCheck": true
+  }
+}