Add types

Closes GH-4.

Reviewed-by: Christian Murphy <christian.murphy.42@gmail.com>
Reviewed-by: Jonathan Haines <jonno.haines@gmail.com>
Reviewed-by: Titus Wormer <tituswormer@gmail.com>

package.json

@@ -25,11 +25,14 @@
   "contributors": [
     "Titus Wormer <tituswormer@gmail.com> (https://wooorm.com)"
   ],
+  "types": "types/index.d.ts",
   "files": [
+    "types/index.d.ts",
     "index.js"
   ],
   "dependencies": {},
   "devDependencies": {
+    "dtslint": "^3.0.0",
     "nyc": "^15.0.0",
     "prettier": "^2.0.0",
     "rehype-format": "^3.0.0",
@@ -49,7 +52,8 @@
     "format": "remark . -qfo && prettier . --write && xo --fix",
     "test-api": "node test",
     "test-coverage": "nyc --reporter lcov tape test/index.js",
-    "test": "npm run format && npm run test-coverage"
+    "test-types": "dtslint types",
+    "test": "npm run format && npm run test-coverage && npm run test-types"
   },
   "nyc": {
     "check-coverage": true,

types/index.d.ts

@@ -0,0 +1,20 @@
+// TypeScript Version: 3.4
+
+import {Plugin} from 'unified'
+
+declare namespace remarkFootnotes {
+  type Footnotes = Plugin<[RemarkFootnotesOptions?]>
+
+  interface RemarkFootnotesOptions {
+    /**
+     * Whether to support `^[inline notes]`
+     *
+     * @defaultValue false
+     */
+    inlineNotes?: boolean
+  }
+}
+
+declare const remarkFootnotes: remarkFootnotes.Footnotes
+
+export = remarkFootnotes

types/remark-footnotes-tests.ts

@@ -0,0 +1,6 @@
+import unified = require('unified')
+import footnotes = require('remark-footnotes')
+
+unified().use(footnotes)
+unified().use(footnotes, {})
+unified().use(footnotes, {inlineNotes: true})

types/tsconfig.json

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

types/tslint.json

@@ -0,0 +1,7 @@
+{
+  "extends": "dtslint/dtslint.json",
+  "rules": {
+    "semicolon": false,
+    "whitespace": false
+  }
+}