Add JSDoc based types

Author: wooorm

.gitignore

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

index.js

@@ -1,3 +1,7 @@
+/**
+ * @typedef {import('unist').Node} Node
+ */
+
 import {hasProperty} from 'hast-util-has-property'
 
 // Always interactive nodes.
@@ -12,13 +16,19 @@ var alwaysInteractive = new Set([
   'textarea'
 ])
 
+/**
+ * @param {Node} node
+ * @returns {boolean}
+ */
 export function interactive(node) {
+  /** @type {string} */
   var name
 
   if (!node || typeof node !== 'object' || node.type !== 'element') {
     return false
   }
 
+  // @ts-ignore looks like an element.
   name = node.tagName
 
   return (
@@ -27,6 +37,7 @@ export function interactive(node) {
     (name === 'video' && hasProperty(node, 'controls')) ||
     (name === 'object' && hasProperty(node, 'useMap')) ||
     (name === 'img' && hasProperty(node, 'useMap')) ||
+    // @ts-ignore looks like an element.
     (name === 'input' && (node.properties || {}).type !== 'hidden') ||
     hasProperty(node, 'tabIndex') ||
     alwaysInteractive.has(name)

package.json

@@ -27,25 +27,34 @@
   "sideEffects": false,
   "type": "module",
   "main": "index.js",
+  "types": "index.d.ts",
   "files": [
+    "index.d.ts",
     "index.js"
   ],
   "dependencies": {
+    "@types/unist": "^2.0.0",
     "hast-util-has-property": "^2.0.0"
   },
   "devDependencies": {
+    "@types/tape": "^4.0.0",
     "c8": "^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",
     "xo": "^0.39.0"
   },
   "scripts": {
+    "prepack": "npm run build && npm run format",
+    "build": "rimraf \"*.d.ts\" && tsc && type-coverage",
     "format": "remark . -qfo && prettier . --write --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 +75,10 @@
     "plugins": [
       "preset-wooorm"
     ]
+  },
+  "typeCoverage": {
+    "atLeast": 100,
+    "detail": true,
+    "strict": true
   }
 }

test.js

@@ -2,6 +2,7 @@ import test from 'tape'
 import {interactive} from './index.js'
 
 test('interactive', function (t) {
+  // @ts-ignore runtime.
   t.equal(interactive(), false, 'should return `false` without node')
   t.equal(interactive(null), false, 'should return `false` with `null`')
 

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
+  }
+}