syntax-tree · wooorm · Apr 19, 2021 · Apr 14, 2021 · Apr 18, 2021 · Apr 18, 2021
diff --git a/.gitignore b/.gitignore
@@ -1,4 +1,5 @@
 .DS_Store
+*.d.ts
 *.log
 coverage/
 node_modules/

diff --git a/index.js b/index.js
@@ -1,20 +1,46 @@
-export function u(type, props, value) {
-  var node = {type: String(type)}
+/**
+ * @typedef {import('unist').Node} Node
+ * @typedef {import('unist').Parent} Parent
+ * @typedef {import('unist').Literal} Literal
+ * @typedef {Object.<string, unknown>} Props
+ * @typedef {Array.<Node>|string} ChildrenOrValue
+ *
+ * @typedef {(<T extends string, P extends Record<string, unknown>, C extends Node[]>(type: T, props: P, children: C) => {type: T, children: C} & P)} BuildParentWithProps
+ * @typedef {(<T extends string, P extends Record<string, unknown>>(type: T, props: P, value: string) => {type: T, value: string} & P)} BuildLiteralWithProps
+ * @typedef {(<T extends string, P extends Record<string, unknown>>(type: T, props: P) => {type: T} & P)} BuildVoidWithProps
+ * @typedef {(<T extends string, C extends Node[]>(type: T, children: C) => {type: T, children: C})} BuildParent
+ * @typedef {(<T extends string>(type: T, value: string) => {type: T, value: string})} BuildLiteral
+ * @typedef {(<T extends string>(type: T) => {type: T})} BuildVoid
+ */
 
-  if (
-    (value === undefined || value === null) &&
-    (typeof props !== 'object' || Array.isArray(props))
-  ) {
-    value = props
-  } else {
-    Object.assign(node, props)
-  }
+export var u = /**
+ * @type {BuildVoid & BuildVoidWithProps & BuildLiteral & BuildLiteralWithProps & BuildParent & BuildParentWithProps}
+ */ (
+  /**
+   * @param {string} type Type of node
+   * @param {Props|ChildrenOrValue} [props] Additional properties for node (or `children` or `value`)
+   * @param {ChildrenOrValue} [value] `children` or `value` of node
+   * @returns {Node}
+   */
+  function (type, props, value) {
+    /** @type {Node} */
+    var node = {type: String(type)}
 
-  if (Array.isArray(value)) {
-    node.children = value
-  } else if (value !== undefined && value !== null) {
-    node.value = String(value)
-  }
+    if (
+      (value === undefined || value === null) &&
+      (typeof props === 'string' || Array.isArray(props))
+    ) {
+      value = props
+    } else {
+      Object.assign(node, props)
+    }
 
-  return node
-}
+    if (Array.isArray(value)) {
+      node.children = value
+    } else if (value !== undefined && value !== null) {
+      node.value = String(value)
+    }
+
+    return node
+  }
+)
diff --git a/index.test-d.ts b/index.test-d.ts
@@ -0,0 +1,26 @@
+import {expectType, expectAssignable} from 'tsd'
+import {Text, List, ListItem, HTML} from 'mdast'
+import {u} from './index.js'
+
+expectType<{type: 'example'}>(u('example'))
+expectType<{type: 'example'} & {property: true}>(u('example', {property: true}))
+
+const node1 = u('text', 'text')
+
+expectType<{type: 'text'; value: string}>(node1)
+expectAssignable<Text>(node1)
+
+const node2 = u('list', [
+  u('listItem', [u('html', {checked: true}, '<strong>text</strong>')])
+])
+
+expectType<{
+  type: 'list'
+  children: Array<{
+    type: 'listItem'
+    children: Array<{type: 'html'; value: string} & {checked: boolean}>
+  }>
+}>(node2)
+expectAssignable<List>(node2)
+expectAssignable<ListItem>(node2.children[0])
+expectAssignable<HTML>(node2.children[0].children[0])
diff --git a/package.json b/package.json
@@ -33,27 +33,35 @@
   "sideEffects": false,
   "type": "module",
   "main": "index.js",
-  "types": "types/index.d.ts",
+  "types": "index.d.ts",
   "files": [
-    "index.js",
-    "types/index.d.ts"
+    "index.d.ts",
+    "index.js"
   ],
+  "dependencies": {
+    "@types/unist": "^2.0.0"
+  },
   "devDependencies": {
     "@types/mdast": "^3.0.0",
+    "@types/tape": "^4.0.0",
     "c8": "^7.0.0",
-    "dtslint": "^4.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",
+    "tsd": "^0.14.0",
+    "type-coverage": "^2.0.0",
+    "typescript": "^4.0.0",
     "xo": "^0.38.0"
   },
   "scripts": {
+    "prepack": "npm run build && npm run format",
+    "build": "rimraf \"*.d.ts\" && tsc && tsd && 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-types": "dtslint types",
-    "test": "npm run format && npm run test-coverage && npm run test-types"
+    "test": "npm run build && npm run format && npm run test-coverage"
   },
   "prettier": {
     "tabWidth": 2,
@@ -66,6 +74,8 @@
   "xo": {
     "prettier": true,
     "rules": {
+      "capitalized-comments": "off",
+      "import/no-mutable-exports": "off",
       "no-var": "off",
       "prefer-arrow-callback": "off"
     }
@@ -74,5 +84,10 @@
     "plugins": [
       "preset-wooorm"
     ]
+  },
+  "typeCoverage": {
+    "atLeast": 100,
+    "detail": true,
+    "strict": true
   }
 }
diff --git a/tsconfig.json b/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
+  }
+}
diff --git a/types/index.d.ts b/types/index.d.ts
diff --git a/types/tsconfig.json b/types/tsconfig.json
diff --git a/types/tslint.json b/types/tslint.json
diff --git a/types/unist-builder-tests.ts b/types/unist-builder-tests.ts