Add JSDoc based types

Author: wooorm

Diff for: .gitignore

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

Diff for: index.js

@@ -1,10 +1,20 @@
+/**
+ * @typedef {import('unist').Node} Node
+ * @typedef {import('mdast').Definition} Definition
+ * @typedef {import('unist-util-visit').Visitor<Definition>} DefinitionVisitor
+ */
+
 import {visit} from 'unist-util-visit'
 
 var own = {}.hasOwnProperty
 
-// Get a definition in `node` by `identifier`.
+/**
+ *
+ * @param {Node} node
+ */
 export function definitions(node) {
-  var cache = {}
+  /** @type {Object.<string, Definition>} */
+  var cache = Object.create(null)
 
   if (!node || !node.type) {
     throw new Error('mdast-util-definitions expected node')
@@ -14,20 +24,30 @@ export function definitions(node) {
 
   return getDefinition
 
+  /** @type {DefinitionVisitor} */
   function ondefinition(definition) {
     var id = clean(definition.identifier)
     if (id && !own.call(cache, id)) {
       cache[id] = definition
     }
   }
 
-  // Get a node from the bound definition-cache.
+  /**
+   * Get a node from the bound definition-cache.
+   *
+   * @param {string} identifier
+   * @returns {Definition|null}
+   */
   function getDefinition(identifier) {
     var id = clean(identifier)
     return id && own.call(cache, id) ? cache[id] : null
   }
 }
 
+/**
+ * @param {string} [value]
+ * @returns {string}
+ */
 function clean(value) {
   return String(value || '').toUpperCase()
 }

Diff for: package.json

@@ -29,29 +29,36 @@
   "sideEffects": false,
   "type": "module",
   "main": "index.js",
-  "types": "types/index.d.ts",
+  "types": "index.d.ts",
   "files": [
-    "types",
+    "index.d.ts",
     "index.js"
   ],
   "dependencies": {
+    "@types/mdast": "^3.0.0",
+    "@types/unist": "^2.0.0",
     "unist-util-visit": "^3.0.0"
   },
   "devDependencies": {
-    "@types/mdast": "^3.0.0",
+    "@types/tape": "^4.0.0",
     "c8": "^7.0.0",
     "prettier": "^2.0.0",
     "remark": "^13.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,
@@ -64,16 +71,19 @@
   "xo": {
     "prettier": true,
     "rules": {
+      "capitalized-comments": "off",
       "no-var": "off",
       "prefer-arrow-callback": "off"
-    },
-    "ignore": [
-      "types/"
-    ]
+    }
   },
   "remarkConfig": {
     "plugins": [
       "preset-wooorm"
     ]
+  },
+  "typeCoverage": {
+    "atLeast": 100,
+    "detail": true,
+    "strict": true
   }
 }

Diff for: test.js

@@ -1,12 +1,18 @@
+/**
+ * @typedef {import('unist').Node} Node
+ */
+
 import test from 'tape'
 import remark from 'remark'
 import {definitions} from './index.js'
 
 test('mdast-util-definitions', function (t) {
+  /** @type {Node} */
   var tree
 
   t.throws(
     function () {
+      // @ts-ignore runtime
       definitions()
     },
     /mdast-util-definitions expected node/,
@@ -52,7 +58,7 @@ test('mdast-util-definitions', function (t) {
   )
 
   /* eslint-disable-next-line no-use-extend-native/no-use-extend-native */
-  t.equal({}.type, undefined, 'should not polute the prototype')
+  t.equal({}.type, undefined, 'should not polute the prototype') // type-coverage:ignore-line
 
   t.deepEqual(
     definitions(tree)('toString'),

Diff for: 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
+  }
+}