Add JSDoc based types

Author: wooorm

.gitignore

@@ -1,5 +1,6 @@
 coverage/
 node_modules/
 .DS_Store
+*.d.ts
 *.log
 yarn.lock

index.js

@@ -1,21 +1,38 @@
-import gfmAutolinkLiteralFromMarkdown from 'mdast-util-gfm-autolink-literal/from-markdown.js'
-import gfmAutolinkLiteralToMarkdown from 'mdast-util-gfm-autolink-literal/to-markdown.js'
-import gfmStrikethroughFromMarkdown from 'mdast-util-gfm-strikethrough/from-markdown.js'
-import gfmStrikethroughToMarkdown from 'mdast-util-gfm-strikethrough/to-markdown.js'
-import gfmTableFromMarkdown from 'mdast-util-gfm-table/from-markdown.js'
-import gfmTableToMarkdown from 'mdast-util-gfm-table/to-markdown.js'
-import gfmTaskListItemFromMarkdown from 'mdast-util-gfm-task-list-item/from-markdown.js'
-import gfmTaskListItemToMarkdown from 'mdast-util-gfm-task-list-item/to-markdown.js'
-
-const own = {}.hasOwnProperty
-
-export const gfmFromMarkdown = configure([
+/**
+ * @typedef {import('mdast-util-from-markdown').Extension} FromMarkdownExtension
+ * @typedef {import('mdast-util-to-markdown').Options} ToMarkdownExtension
+ *
+ * @typedef {import('mdast-util-gfm-table').Options} Options
+ */
+
+import {
+  gfmAutolinkLiteralFromMarkdown,
+  gfmAutolinkLiteralToMarkdown
+} from 'mdast-util-gfm-autolink-literal'
+import {
+  gfmStrikethroughFromMarkdown,
+  gfmStrikethroughToMarkdown
+} from 'mdast-util-gfm-strikethrough'
+import {gfmTableFromMarkdown, gfmTableToMarkdown} from 'mdast-util-gfm-table'
+import {
+  gfmTaskListItemFromMarkdown,
+  gfmTaskListItemToMarkdown
+} from 'mdast-util-gfm-task-list-item'
+
+/**
+ * @type {Array.<FromMarkdownExtension>}
+ */
+export const gfmFromMarkdown = [
   gfmAutolinkLiteralFromMarkdown,
   gfmStrikethroughFromMarkdown,
   gfmTableFromMarkdown,
   gfmTaskListItemFromMarkdown
-])
+]
 
+/**
+ * @param {Options} [options]
+ * @returns {ToMarkdownExtension}
+ */
 export function gfmToMarkdown(options) {
   return {
     extensions: [
@@ -26,34 +43,3 @@ export function gfmToMarkdown(options) {
     ]
   }
 }
-
-function configure(extensions) {
-  const config = {transforms: [], canContainEols: []}
-  const length = extensions.length
-  let index = -1
-
-  while (++index < length) {
-    extension(config, extensions[index])
-  }
-
-  return config
-}
-
-function extension(config, extension) {
-  let key
-  let left
-  let right
-
-  for (key in extension) {
-    if (own.call(extension, key)) {
-      left = own.call(config, key) ? config[key] : (config[key] = {})
-      right = extension[key]
-
-      if (key === 'canContainEols' || key === 'transforms') {
-        config[key] = [].concat(left, right)
-      } else {
-        Object.assign(left, right)
-      }
-    }
-  }
-}

package.json

@@ -33,36 +33,43 @@
   "sideEffects": false,
   "type": "module",
   "main": "index.js",
+  "types": "index.d.ts",
   "files": [
+    "index.d.ts",
     "index.js"
   ],
   "dependencies": {
-    "mdast-util-gfm-autolink-literal": "^0.1.0",
-    "mdast-util-gfm-strikethrough": "^0.2.0",
-    "mdast-util-gfm-table": "^0.1.0",
-    "mdast-util-gfm-task-list-item": "^0.1.0",
-    "mdast-util-to-markdown": "^0.6.1"
+    "mdast-util-gfm-autolink-literal": "^1.0.0",
+    "mdast-util-gfm-strikethrough": "^1.0.0",
+    "mdast-util-gfm-table": "^1.0.0",
+    "mdast-util-gfm-task-list-item": "^1.0.0"
   },
   "devDependencies": {
+    "@types/tape": "^4.0.0",
     "c8": "^7.0.0",
     "github-slugger": "^1.0.0",
     "hast-util-to-html": "^8.0.0",
-    "mdast-util-from-markdown": "^0.8.0",
+    "mdast-util-from-markdown": "^1.0.0",
     "mdast-util-to-hast": "^11.0.0",
-    "micromark-extension-gfm": "^0.3.0",
+    "mdast-util-to-markdown": "^1.0.0",
+    "micromark-extension-gfm": "^1.0.0",
     "node-fetch": "^2.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": {
+    "build": "rimraf \"*.d.ts\" && tsc && type-coverage",
     "format": "remark . -qfo && prettier . -w --loglevel warn && xo --fix",
     "crawl": "node script/crawl-tests",
     "test-api": "node --conditions development test/index.js",
     "test-coverage": "c8 --check-coverage --branches 100 --functions 100 --lines 100 --statements 100 --reporter lcov node --conditions development test/index.js",
-    "test": "npm run format && npm run test-coverage"
+    "test": "npm run build && npm run format && npm run test-coverage"
   },
   "prettier": {
     "tabWidth": 2,
@@ -79,5 +86,11 @@
     "plugins": [
       "preset-wooorm"
     ]
+  },
+  "typeCoverage": {
+    "atLeast": 100,
+    "detail": true,
+    "strict": true,
+    "ignoreCatch": true
   }
 }

test/index.js

@@ -4,9 +4,9 @@ import test from 'tape'
 import Slugger from 'github-slugger'
 import {toHast} from 'mdast-util-to-hast'
 import {toHtml} from 'hast-util-to-html'
-import fromMarkdown from 'mdast-util-from-markdown'
-import toMarkdown from 'mdast-util-to-markdown'
-import gfm from 'micromark-extension-gfm'
+import {fromMarkdown} from 'mdast-util-from-markdown'
+import {toMarkdown} from 'mdast-util-to-markdown'
+import {gfm} from 'micromark-extension-gfm'
 import {gfmFromMarkdown, gfmToMarkdown} from '../index.js'
 
 const spec = JSON.parse(fs.readFileSync(path.join('test', 'spec.json')))

tsconfig.json

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