Add types

Closes GH-5.
Closes GH-6.

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

Author: SalahAdDin

package.json

@@ -24,16 +24,20 @@
     "John Otander <[email protected]> (https://johno.com)",
     "Titus Wormer <[email protected]> (https://wooorm.com)",
     "Brent Jackson <[email protected]>",
-    "Michele Bertoli <[email protected]>"
+    "Michele Bertoli <[email protected]>",
+    "José Luis Sandoval Alaguna <[email protected]> (https://uzmani.tech/)"
   ],
+  "types": "types/index.d.ts",
   "files": [
+    "types/index.d.ts",
     "index.js"
   ],
   "dependencies": {
     "hast-util-whitespace": "^1.0.0",
     "unist-util-visit": "^2.0.0"
   },
   "devDependencies": {
+    "dtslint": "^4.1.0",
     "nyc": "^15.0.0",
     "prettier": "^2.0.0",
     "remark": "^13.0.0",
@@ -44,10 +48,11 @@
     "xo": "^0.37.0"
   },
   "scripts": {
-    "format": "remark . -qfo && prettier . -w --loglevel warn && xo --fix",
+    "format": "remark . -qfo && prettier . -w --loglevel warn && xo --fix --ignore types",
     "test-api": "node test",
     "test-coverage": "nyc --reporter lcov tape test.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,10 @@
+// TypeScript Version: 3.8
+
+import type {Plugin} from 'unified'
+
+/**
+ * Remark to remove the wrapping paragraph for images.
+ */
+declare const remarkUnwrapImages: Plugin<[]>
+
+export = remarkUnwrapImages

types/remark-unwrap-images-tests.ts

@@ -0,0 +1,4 @@
+import unified = require('unified')
+import unwrap = require('remark-unwrap-images')
+
+unified().use(unwrap)

types/tsconfig.json

@@ -0,0 +1,14 @@
+{
+  "compilerOptions": {
+    "lib": [
+      "es2015"
+    ],
+    "strict": true,
+    "baseUrl": ".",
+    "paths": {
+      "remark-unwrap-images": [
+        "."
+      ]
+    }
+  }
+}

types/tslint.json

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