Add types

Reviewed-by: Christian Murphy <[email protected]>
Reviewed-by: Remco Haszing <[email protected]>
Reviewed-by: Titus Wormer <[email protected]>

Closes GH-29.

Author: viceice

package.json

@@ -32,7 +32,9 @@
     "Titus Wormer <[email protected]> (https://wooorm.com)",
     "Anthony Maki <[email protected]>"
   ],
+  "types": "types/index.d.ts",
   "files": [
+    "types/index.d.ts",
     "index.js"
   ],
   "dependencies": {
@@ -42,6 +44,7 @@
   },
   "devDependencies": {
     "browserify": "^17.0.0",
+    "dtslint": "^3.0.0",
     "nyc": "^15.0.0",
     "prettier": "^2.0.0",
     "remark": "^13.0.0",
@@ -50,6 +53,7 @@
     "remark-preset-wooorm": "^8.0.0",
     "tape": "^5.0.0",
     "tinyify": "^3.0.0",
+    "unified": "^9.0.0",
     "xo": "^0.37.0"
   },
   "scripts": {
@@ -59,7 +63,8 @@
     "build": "npm run build-bundle && npm run build-mangle",
     "test-api": "node test",
     "test-coverage": "nyc --reporter lcov tape test/index.js",
-    "test": "npm run format && npm run build && npm run test-coverage"
+    "test-types": "dtslint types",
+    "test": "npm run format && npm run build && npm run test-coverage && npm run test-types"
   },
   "nyc": {
     "check-coverage": true,

types/index.d.ts

@@ -0,0 +1,24 @@
+// TypeScript Version: 3.4
+
+import {Plugin} from 'unified'
+
+declare namespace remarkGithub {
+  type Github = Plugin<[RemarkGithubOptions?]>
+
+  interface RemarkGithubOptions {
+    /**
+     * Wrap mentions in `<strong>`, true by default.
+     * @defaultValue true
+     */
+    mentionStrong?: boolean
+
+    /**
+     * Repository to link against.
+     */
+    repository?: string
+  }
+}
+
+declare const remarkGithub: remarkGithub.Github
+
+export = remarkGithub

types/remark-github-tests.ts

@@ -0,0 +1,6 @@
+import unified = require('unified')
+import github = require('remark-github')
+
+unified().use(github)
+unified().use(github, {})
+unified().use(github, {mentionStrong: false, repository: 'some/repo'})

types/tsconfig.json

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

types/tslint.json

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