Add JSDoc based types

Author: wooorm

.gitignore

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

index.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Check whether a `node` is labelable:
+ * See: <https://html.spec.whatwg.org/#category-label>.
+ *
+ * @param {unknown} node
+ * @returns {boolean}
+ */
+export function labelable(node: unknown): boolean;

index.js

@@ -1,7 +1,15 @@
-// Check whether a `node` is labelable:
-// See: <https://html.spec.whatwg.org/#category-label>.
+/**
+ * Check whether a `node` is labelable:
+ * See: <https://html.spec.whatwg.org/#category-label>.
+ *
+ * @param {unknown} node
+ * @returns {boolean}
+ */
 export function labelable(node) {
-  var name = node && node.type === 'element' && node.tagName
+  /** @type {string} */
+  var name =
+    // @ts-ignore Looks like an object.
+    node && typeof node === 'object' && node.type === 'element' && node.tagName
 
   return Boolean(
     name === 'button' ||
@@ -12,6 +20,7 @@ export function labelable(node) {
       name === 'select' ||
       name === 'textarea' ||
       (name === 'input' &&
+        // @ts-ignore Looks like an object.
         (node.properties && node.properties.type) !== 'hidden')
   )
 }

package.json

@@ -25,22 +25,30 @@
   "sideEffects": false,
   "type": "module",
   "main": "index.js",
+  "types": "index.d.ts",
   "files": [
+    "index.d.ts",
     "index.js"
   ],
   "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 . -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,
@@ -61,5 +69,10 @@
     "plugins": [
       "preset-wooorm"
     ]
+  },
+  "typeCoverage": {
+    "atLeast": 100,
+    "detail": true,
+    "strict": true
   }
 }

test.d.ts

@@ -0,0 +1 @@
+export {};

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