Add JSDoc based types

Author: wooorm

.gitignore

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

build.js

@@ -4,7 +4,9 @@ import {bail} from 'bail'
 import concat from 'concat-stream'
 import unified from 'unified'
 import parse from 'rehype-parse'
+// @ts-ignore
 import select from 'hast-util-select'
+// @ts-ignore
 import toString from 'hast-util-to-string'
 import {svgTagNames} from './index.js'
 
@@ -22,13 +24,20 @@ while (++index < urls.length) {
   https.get(urls[index], onconnection)
 }
 
+/**
+ * @param {import('http').IncomingMessage} response
+ */
 function onconnection(response) {
   response.pipe(concat(onconcat)).on('error', bail)
 }
 
+/**
+ * @param {Buffer} buf
+ */
 function onconcat(buf) {
   var nodes = select.selectAll('.element-name', proc.parse(buf))
   var index = -1
+  /** @type {string} */
   var value
 
   while (++index < nodes.length) {

package.json

@@ -24,10 +24,15 @@
   "sideEffects": false,
   "type": "module",
   "main": "index.js",
+  "types": "index.d.ts",
   "files": [
+    "index.d.ts",
     "index.js"
   ],
   "devDependencies": {
+    "@types/concat-stream": "^1.0.0",
+    "@types/node": "^14.0.0",
+    "@types/tape": "^4.0.0",
     "bail": "^2.0.0",
     "c8": "^7.0.0",
     "concat-stream": "^2.0.0",
@@ -37,16 +42,21 @@
     "rehype-parse": "^7.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",
     "unified": "^9.0.0",
     "xo": "^0.38.0"
   },
   "scripts": {
+    "prepack": "npm run build && npm run format",
+    "build": "rimraf \"*.d.ts\" && tsc && type-coverage",
     "generate": "node build",
     "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,
@@ -68,5 +78,10 @@
     "plugins": [
       "preset-wooorm"
     ]
+  },
+  "typeCoverage": {
+    "atLeast": 100,
+    "detail": true,
+    "strict": true
   }
 }

tsconfig.json

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