Add types

Related-to unifiedjs/unified-engine#46.
Closes GH-23.

Reviewed-by: Titus Wormer <tituswormer@gmail.com>

Author: ChristianMurphy

package.json

@@ -18,12 +18,15 @@
   },
   "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)",
+    "Christian Murphy <christian.murphy.42@gmail.com"
   ],
   "files": [
     "index.js",
+    "types/index.d.ts",
     "lib/"
   ],
+  "types": "types/index.d.ts",
   "dependencies": {
     "camelcase": "^5.0.0",
     "chalk": "^3.0.0",
@@ -36,10 +39,12 @@
   },
   "devDependencies": {
     "bail": "^1.0.0",
+    "dtslint": "^3.0.0",
     "execa": "^4.0.0",
     "figures": "^3.0.0",
     "nyc": "^15.0.0",
     "prettier": "^2.0.0",
+    "remark": "^11.0.0",
     "remark-cli": "^7.0.0",
     "remark-preset-wooorm": "^6.0.0",
     "strip-ansi": "^6.0.0",
@@ -50,10 +55,11 @@
     "xo": "^0.28.0"
   },
   "scripts": {
-    "format": "remark . -qfo && prettier --write \"**/*.js\" && xo --fix",
+    "format": "remark . -qfo && prettier --write \"**/*.{js,ts}\" && xo --fix --ignore types",
     "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"
   },
   "prettier": {
     "tabWidth": 2,

types/index.d.ts

@@ -0,0 +1,41 @@
+// TypeScript Version: 3.0
+
+import {Options as EngineOptions} from 'unified-engine'
+
+type RequiredEngineOptions = Required<
+  Pick<
+    EngineOptions,
+    | 'extensions'
+    | 'ignoreName'
+    | 'packageField'
+    | 'pluginPrefix'
+    | 'processor'
+    | 'rcName'
+  >
+>
+
+declare namespace unifiedArgs {
+  interface Options extends RequiredEngineOptions {
+    /**
+     * Name of executable
+     */
+    name: string
+
+    /**
+     * Description of executable
+     */
+    description: string
+
+    /**
+     * Version of executable
+     */
+    version: string
+  }
+}
+
+/**
+ * Create a CLI for a unified processor
+ */
+declare function unifiedArgs(options: unifiedArgs.Options): void
+
+export = unifiedArgs

types/tsconfig.json

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

types/tslint.json

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

types/unified-args-test.ts

@@ -0,0 +1,24 @@
+import * as start from 'unified-args'
+import * as remark from 'remark'
+
+start({
+  processor: remark(),
+  name: 'remark',
+  description: 'description',
+  version: '1.0.0',
+  pluginPrefix: 'remark',
+  extensions: ['md'],
+  packageField: 'remarkConfig',
+  rcName: '.remarkrc',
+  ignoreName: '.remarkignore'
+})
+
+// $ExpectError
+start({})
+
+// $ExpectError
+start({
+  name: 'remark',
+  description: 'description',
+  version: '1.0.0'
+})