Add types

pd4d10 · web-flow · commit ff79c93b4b0f · 2020-07-30T14:16:10.000+02:00
Closes GH-1. Reviewed-by: Junyoung Choi <fluke8259@gmail.com> Reviewed-by: Christian Murphy <christian.murphy.42@gmail.com> Reviewed-by: Merlijn Vos <merlijn@soverin.net> Reviewed-by: Titus Wormer <tituswormer@gmail.com>
diff --git a/package.json b/package.json
@@ -24,12 +24,15 @@
   "contributors": [
     "Titus Wormer <tituswormer@gmail.com> (https://wooorm.com)"
   ],
+  "types": "types/index.d.ts",
   "files": [
-    "index.js"
+    "index.js",
+    "types/index.d.ts"
   ],
   "dependencies": {},
   "devDependencies": {
     "browserify": "^16.0.0",
+    "dtslint": "^3.6.12",
     "nyc": "^15.0.0",
     "prettier": "^2.0.0",
     "rehype-stringify": "^8.0.0",
@@ -49,7 +52,8 @@
     "build": "npm run build-bundle && npm run build-mangle",
     "test-api": "node test",
     "test-coverage": "nyc --reporter lcov tape test.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,
diff --git a/types/index.d.ts b/types/index.d.ts
@@ -0,0 +1,7 @@
+// TypeScript Version: 3.4
+
+import {Plugin} from 'unified'
+
+declare const remarkBreaks: Plugin<[]>
+
+export = remarkBreaks
diff --git a/types/remark-breaks-tests.ts b/types/remark-breaks-tests.ts
@@ -0,0 +1,4 @@
+import unified = require('unified')
+import breaks = require('remark-breaks')
+
+unified().use(breaks)
diff --git a/types/tsconfig.json b/types/tsconfig.json
@@ -0,0 +1,10 @@
+{
+  "compilerOptions": {
+    "lib": ["es2015"],
+    "strict": true,
+    "baseUrl": ".",
+    "paths": {
+      "remark-breaks": ["index.d.ts"]
+    }
+  }
+}
diff --git a/types/tslint.json b/types/tslint.json
@@ -0,0 +1,7 @@
+{
+  "extends": "dtslint/dtslint.json",
+  "rules": {
+    "semicolon": false,
+    "whitespace": false
+  }
+}
