Add JSDoc based types

Author: wooorm

.gitignore

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

index.js

@@ -1,9 +1,9 @@
-import {isElement} from 'hast-util-is-element'
+import {convertElement} from 'hast-util-is-element'
 import {hasProperty} from 'hast-util-has-property'
 import {embedded} from 'hast-util-embedded'
 import bodyOkLink from 'hast-util-is-body-ok-link'
 
-var list = [
+var basic = convertElement([
   'a',
   'abbr',
   // `area` is in fact only phrasing if it is inside a `map` element.
@@ -51,14 +51,21 @@ var list = [
   'u',
   'var',
   'wbr'
-]
+])
 
+var meta = convertElement('meta')
+
+/**
+ * @param {unknown} node
+ * @returns {boolean}
+ */
 export function phrasing(node) {
   return (
-    node.type === 'text' ||
-    isElement(node, list) ||
+    // @ts-ignore Looks like a text.
+    (node && node.type === 'text') ||
+    basic(node) ||
     embedded(node) ||
     bodyOkLink(node) ||
-    (isElement(node, 'meta') && hasProperty(node, 'itemProp'))
+    (meta(node) && hasProperty(node, 'itemProp'))
   )
 }

package.json

@@ -26,7 +26,9 @@
   "sideEffects": false,
   "type": "module",
   "main": "index.js",
+  "types": "index.d.ts",
   "files": [
+    "index.d.ts",
     "index.js"
   ],
   "dependencies": {
@@ -36,20 +38,26 @@
     "hast-util-is-element": "^2.0.0"
   },
   "devDependencies": {
+    "@types/tape": "^4.13.0",
     "c8": "^7.0.0",
     "hastscript": "^6.0.0",
     "prettier": "^2.0.0",
     "remark-cli": "^9.0.0",
     "remark-preset-wooorm": "^8.0.0",
+    "rimraf": "^3.0.2",
     "tape": "^5.0.0",
+    "type-coverage": "^2.17.3",
+    "typescript": "^4.2.4",
     "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,
@@ -70,5 +78,10 @@
     "plugins": [
       "preset-wooorm"
     ]
+  },
+  "typeCoverage": {
+    "atLeast": 100,
+    "detail": true,
+    "strict": true
   }
 }

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