feat: Add Typescript support (#63)

Author: Szpadel

index.d.ts

@@ -0,0 +1,74 @@
+declare class Caporal {
+    INTEGER: number;
+    INT: number;
+    FLOAT: number;
+    BOOL: number;
+    BOOLEAN: number;
+    STRING: number;
+    LIST: number;
+    ARRAY: number;
+    REPEATABLE: number;
+    REQUIRED: number;
+
+    version(ver: string): Caporal;
+    version(): string;
+
+    name(name: string): Caporal;
+    name(): string;
+
+    description(name: string): Caporal;
+    description(): string;
+
+    logger(logger: Logger): Caporal;
+    logger(): Logger;
+
+    bin(name: string): Caporal;
+    bin(): string;
+
+    help(helpText: string): Caporal;
+
+    command(synospis: string, description: string): Command;
+
+    action(cb: ActionCallback): Caporal;
+
+    option(synopsis: string, description: string, validator?: ValidatorArg, defaultValue?: any, required?: boolean): Caporal;
+
+    argument(synopsis: string, description: string, validator?: ValidatorArg, defaultValue?: any): Command;
+
+    parse(argv: string[]): any;
+}
+
+type ActionCallback = (args: { [k: string]: any },
+                       options: { [k: string]: any },
+                       logger: Logger) => void;
+
+type ValidatorArg = string[]|string|RegExp|ValidatorFn|Number;
+type ValidatorFn = (str: string) => any;
+
+declare interface Logger {
+    debug(str: string): void;
+    info(str: string): void;
+    log(str: string): void;
+    warn(str: string): void;
+    error(str: string): void;
+}
+
+declare interface Command {
+    help(helpText: string): Command;
+
+    argument(synopsis: string, description: string, validator?: ValidatorArg, defaultValue?: any): Command;
+
+    command(synospis: string, description: string): Command;
+
+    option(synopsis: string, description: string, validator?: ValidatorArg, defaultValue?: any, required?: boolean): Command;
+
+    action(cb: ActionCallback): Command;
+
+    alias(alias: string): Command;
+
+    complete(cb: AutocompleteCallback): Command;
+}
+
+type AutocompleteCallback = () => string[] | Promise<string[]>;
+
+export = new Caporal();

package.json

@@ -3,6 +3,7 @@
   "version": "0.7.0",
   "description": "A full-featured framework for building command line applications (cli) with node.js",
   "main": "index.js",
+  "types": "index.d.ts",
   "scripts": {
     "lint": "./node_modules/.bin/eslint lib tests",
     "test": "./node_modules/mocha/bin/mocha --require ./tests/utils/bootstrap.js --full-trace --recursive -R mocha-unfunk-reporter tests/",