Add types (#5)

Co-authored-by: Christian Murphy <christian.murphy.42@gmail.com>
Reviewed-by: Titus Wormer <tituswormer@gmail.com>
Reviewed-by: Christian Murphy <christian.murphy.42@gmail.com>

Author: Murderlon

package.json

@@ -22,16 +22,20 @@
   },
   "author": "Titus Wormer <tituswormer@gmail.com> (https://wooorm.com)",
   "contributors": [
-    "Titus Wormer <tituswormer@gmail.com> (https://wooorm.com)"
+    "Titus Wormer <tituswormer@gmail.com> (https://wooorm.com)",
+    "Merlijn Vos <merlijn@soverin.net>"
   ],
   "files": [
-    "index.js"
+    "index.js",
+    "types/index.d.ts"
   ],
+  "types": "types/index.d.ts",
   "dependencies": {
     "unist-util-visit": "^2.0.0"
   },
   "devDependencies": {
     "browserify": "^16.0.0",
+    "dtslint": "^3.0.0",
     "nyc": "^15.0.0",
     "prettier": "^2.0.0",
     "remark": "^12.0.0",
@@ -47,9 +51,10 @@
     "build-bundle": "browserify . -s unistUtilRemovePosition > unist-util-remove-position.js",
     "build-mangle": "browserify . -s unistUtilRemovePosition -p tinyify > unist-util-remove-position.min.js",
     "build": "npm run build-bundle && npm run build-mangle",
+    "test-types": "dtslint types",
     "test-api": "node test",
     "test-coverage": "nyc --reporter lcov tape test.js",
-    "test": "npm run format && npm run build && npm run test-coverage"
+    "test": "npm run format && npm run build && npm run test-coverage && npm run test-types"
   },
   "prettier": {
     "tabWidth": 2,
@@ -63,7 +68,7 @@
     "prettier": true,
     "esnext": false,
     "ignores": [
-      "unist-util-remove-position.js"
+      "types/"
     ]
   },
   "nyc": {

types/index.d.ts

@@ -0,0 +1,28 @@
+// TypeScript Version: 3.5
+
+import {Node} from 'unist'
+
+declare namespace unistUtilRemovePosition {
+  interface NodeWithUndefinedPosition extends Node {
+    position: undefined
+  }
+
+  interface NodeWithoutPosition extends Omit<Node, 'position'> {}
+}
+
+/**
+ * Utility to remove positions from a tree
+ *
+ * @param node the unist tree
+ * @param force if `force` is given, uses `delete`, otherwise, sets positions to `undefined`.
+ */
+declare function unistUtilRemovePosition(
+  tree: Node,
+  force?: false
+): unistUtilRemovePosition.NodeWithUndefinedPosition
+declare function unistUtilRemovePosition(
+  tree: Node,
+  force: true
+): unistUtilRemovePosition.NodeWithoutPosition
+
+export = unistUtilRemovePosition

types/tsconfig.json

@@ -0,0 +1,10 @@
+{
+  "compilerOptions": {
+    "lib": ["es2015"],
+    "strict": true,
+    "baseUrl": ".",
+    "paths": {
+      "unist-util-remove-position": ["index.d.ts"]
+    }
+  }
+}

types/tslint.json

@@ -0,0 +1,8 @@
+{
+  "extends": "dtslint/dtslint.json",
+  "rules": {
+    "whitespace": false,
+    "semicolon": false,
+    "no-unnecessary-callback-wrapper": false
+  }
+}

types/unist-util-remove-position-test.ts

@@ -0,0 +1,23 @@
+import {Node} from 'unist'
+
+import remark = require('remark')
+
+import removePosition = require('unist-util-remove-position')
+
+const tree: Node = remark().parse(
+  'Some _emphasis_, **importance**, and `code`.'
+)
+
+// $ExpectType NodeWithUndefinedPosition
+removePosition(tree)
+
+// $ExpectType NodeWithUndefinedPosition
+removePosition(tree, false)
+
+// $ExpectType NodeWithoutPosition
+removePosition(tree, true)
+
+// Used as a plugin
+void remark()
+  .use(() => (tree) => removePosition(tree))
+  .process('Some _emphasis_, **importance**, and `code`.')