Add JSDoc based types

.gitignore

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

package.json

@@ -10,25 +10,32 @@
   },
   "type": "module",
   "devDependencies": {
+    "@types/tape": "^4.0.0",
     "c8": "^7.0.0",
     "chalk": "^4.0.0",
     "lerna": "^4.0.0",
     "nlcst-test": "^3.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",
     "unist-builder": "^3.0.0",
     "unist-util-remove-position": "^4.0.0",
     "xo": "^0.39.0"
   },
   "scripts": {
     "postinstall": "lerna bootstrap --no-ci",
+    "build-workspace": "lerna run build",
+    "build-monorepo": "rimraf \"*.d.ts\" && tsc && type-coverage",
+    "build": "npm run build-workspace && npm run build-monorepo",
     "todo": "remark -qfo && ",
     "format": "prettier . -w --loglevel warn && xo --fix",
     "test-api": "node --conditions development test.js",
     "test-coverage": "c8 --check-coverage --branches 100 --functions 100 --lines 100 --statements 100 --reporter lcov node --conditions development test.js",
-    "test": "npm run format && npm run test-coverage"
+    "test": "npm run build && npm run format && npm run test-coverage"
   },
   "prettier": {
     "tabWidth": 2,
@@ -45,5 +52,11 @@
     "plugins": [
       "preset-wooorm"
     ]
+  },
+  "typeCoverage": {
+    "atLeast": 100,
+    "detail": true,
+    "strict": true,
+    "ignoreCatch": true
   }
 }

packages/retext-dutch/index.js

@@ -1,8 +1,16 @@
+/**
+ * @typedef {import('unified').Plugin<[]>} Plugin
+ */
+
 import {unherit} from 'unherit'
-import {ParseDutch} from 'parse-dutch'
+// @ts-expect-error: untyped.
+import {ParseDutch as Parser} from 'parse-dutch'
 
-export {ParseDutch as Parser}
+// Untyped.
+// type-coverage:ignore-next-line
+export {Parser}
 
+/** @type {Plugin} */
 export default function retextDutch() {
-  this.Parser = unherit(ParseDutch)
+  Object.assign(this, {Parser: unherit(Parser)})
 }

packages/retext-dutch/package.json

@@ -31,11 +31,24 @@
   "sideEffects": false,
   "type": "module",
   "main": "index.js",
+  "types": "index.d.ts",
   "files": [
+    "index.d.ts",
     "index.js"
   ],
   "dependencies": {
     "parse-dutch": "^5.0.0",
-    "unherit": "^3.0.0"
+    "unherit": "^3.0.0",
+    "unified": "^10.0.0"
+  },
+  "scripts": {
+    "build": "rimraf \"*.d.ts\" && tsc && type-coverage"
+  },
+  "xo": false,
+  "typeCoverage": {
+    "atLeast": 100,
+    "detail": true,
+    "strict": true,
+    "ignoreCatch": true
   }
 }

packages/retext-dutch/tsconfig.json

@@ -0,0 +1,4 @@
+{
+  "extends": "../../tsconfig.json",
+  "include": ["*.js"]
+}

packages/retext-english/index.js

@@ -1,8 +1,16 @@
+/**
+ * @typedef {import('unified').Plugin<[]>} Plugin
+ */
+
 import {unherit} from 'unherit'
-import {ParseEnglish} from 'parse-english'
+// @ts-expect-error: untyped.
+import {ParseEnglish as Parser} from 'parse-english'
 
-export {ParseEnglish as Parser}
+// Untyped.
+// type-coverage:ignore-next-line
+export {Parser}
 
+/** @type {Plugin} */
 export default function retextEnglish() {
-  this.Parser = unherit(ParseEnglish)
+  Object.assign(this, {Parser: unherit(Parser)})
 }

packages/retext-english/package.json

@@ -31,11 +31,24 @@
   "sideEffects": false,
   "type": "module",
   "main": "index.js",
+  "types": "index.d.ts",
   "files": [
+    "index.d.ts",
     "index.js"
   ],
   "dependencies": {
     "parse-english": "^5.0.0",
-    "unherit": "^3.0.0"
+    "unherit": "^3.0.0",
+    "unified": "^10.0.0"
+  },
+  "scripts": {
+    "build": "rimraf \"*.d.ts\" && tsc && type-coverage"
+  },
+  "xo": false,
+  "typeCoverage": {
+    "atLeast": 100,
+    "detail": true,
+    "strict": true,
+    "ignoreCatch": true
   }
 }

packages/retext-english/tsconfig.json

@@ -0,0 +1,4 @@
+{
+  "extends": "../../tsconfig.json",
+  "include": ["*.js"]
+}

packages/retext-latin/index.js

@@ -1,8 +1,16 @@
+/**
+ * @typedef {import('unified').Plugin<[]>} Plugin
+ */
+
 import {unherit} from 'unherit'
-import {ParseLatin} from 'parse-latin'
+// @ts-expect-error: untyped.
+import {ParseLatin as Parser} from 'parse-latin'
 
-export {ParseLatin as Parser}
+// Untyped.
+// type-coverage:ignore-next-line
+export {Parser}
 
+/** @type {Plugin} */
 export default function retextLatin() {
-  this.Parser = unherit(ParseLatin)
+  Object.assign(this, {Parser: unherit(Parser)})
 }

packages/retext-latin/package.json

@@ -31,11 +31,24 @@
   "sideEffects": false,
   "type": "module",
   "main": "index.js",
+  "types": "index.d.ts",
   "files": [
+    "index.d.ts",
     "index.js"
   ],
   "dependencies": {
     "parse-latin": "^5.0.0",
-    "unherit": "^3.0.0"
+    "unherit": "^3.0.0",
+    "unified": "^10.0.0"
+  },
+  "scripts": {
+    "build": "rimraf \"*.d.ts\" && tsc && type-coverage"
+  },
+  "xo": false,
+  "typeCoverage": {
+    "atLeast": 100,
+    "detail": true,
+    "strict": true,
+    "ignoreCatch": true
   }
 }

packages/retext-latin/tsconfig.json

@@ -0,0 +1,4 @@
+{
+  "extends": "../../tsconfig.json",
+  "include": ["*.js"]
+}

packages/retext-stringify/index.js

@@ -1,9 +1,19 @@
+/**
+ * @typedef {import('unified').Plugin<[]>} Plugin
+ * @typedef {import('unist').Node} Node
+ */
+
 import {toString} from 'nlcst-to-string'
 
+/** @type {Plugin} */
 export default function retextStringify() {
-  this.Compiler = compiler
+  Object.assign(this, {Compiler})
 }
 
-function compiler(tree) {
+/**
+ * @param {Node} tree
+ * @returns {string}
+ */
+function Compiler(tree) {
   return toString(tree)
 }

packages/retext-stringify/package.json

@@ -33,10 +33,24 @@
   "sideEffects": false,
   "type": "module",
   "main": "index.js",
+  "types": "index.d.ts",
   "files": [
+    "index.d.ts",
     "index.js"
   ],
   "dependencies": {
-    "nlcst-to-string": "^3.0.0"
+    "@types/unist": "^2.0.0",
+    "nlcst-to-string": "^3.0.0",
+    "unified": "^10.0.0"
+  },
+  "scripts": {
+    "build": "rimraf \"*.d.ts\" && tsc && type-coverage"
+  },
+  "xo": false,
+  "typeCoverage": {
+    "atLeast": 100,
+    "detail": true,
+    "strict": true,
+    "ignoreCatch": true
   }
 }

packages/retext-stringify/tsconfig.json

@@ -0,0 +1,4 @@
+{
+  "extends": "../../tsconfig.json",
+  "include": ["*.js"]
+}

packages/retext/package.json

@@ -30,12 +30,24 @@
   "sideEffects": false,
   "type": "module",
   "main": "index.js",
+  "types": "index.d.ts",
   "files": [
+    "index.d.ts",
     "index.js"
   ],
   "dependencies": {
     "retext-latin": "^2.0.0",
     "retext-stringify": "^2.0.0",
     "unified": "^10.0.0"
+  },
+  "scripts": {
+    "build": "rimraf \"*.d.ts\" && tsc && type-coverage"
+  },
+  "xo": false,
+  "typeCoverage": {
+    "atLeast": 100,
+    "detail": true,
+    "strict": true,
+    "ignoreCatch": true
   }
 }

packages/retext/tsconfig.json

@@ -0,0 +1,4 @@
+{
+  "extends": "../../tsconfig.json",
+  "include": ["*.js"]
+}

test.js

@@ -32,12 +32,16 @@ while (++index < parsers.length) {
   eachParser(parsers[index])
 }
 
+/** @param {string} name */
 function eachParser(name) {
   test('retext-' + name, async (t) => {
     t.plan(2)
 
-    const plugin = (await import('./packages/retext-' + name + '/index.js'))
-      .default
+    const fp = './packages/retext-' + name + '/index.js'
+
+    /** @type {import('./packages/retext/node_modules/unified').Plugin<[]>} */
+    // type-coverage:ignore-next-line
+    const plugin = (await import(fp)).default
 
     const tree = unified().use(plugin).parse('Alfred')
 
@@ -60,6 +64,7 @@ function eachParser(name) {
 test('.stringify', (t) => {
   t.throws(
     () => {
+      // @ts-expect-error: runtime.
       retext().stringify(false)
     },
     /false/,
@@ -68,6 +73,7 @@ test('.stringify', (t) => {
 
   t.throws(
     () => {
+      // @ts-expect-error: runtime.
       retext().stringify({})
     },
     /Expected node, got `\[object Object]`/,
@@ -76,6 +82,7 @@ test('.stringify', (t) => {
 
   t.throws(
     () => {
+      // @ts-expect-error: runtime.
       retext().stringify()
     },
     /Expected node, got `undefined`/,

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