Merge pull request #363 from mdezem/commanderjs

Add CommanderJs definitions
2026-09-09 11:13:57 +08:00 · 2013-03-02 13:56:34 -08:00
parent 468eb47213 fce7051232
commit 051d75e75f
3 changed files with 280 additions and 1 deletions
@@ -41,9 +41,10 @@ List of Definitions
 * [Chosen](http://harvesthq.github.com/chosen/) (by [Boris Yankov](https://github.com/borisyankov))
 * [Chrome](http://developer.chrome.com/extensions/) (by [Matthew Kimber](https://github.com/matthewkimber))
 * [CodeMirror](http://codemirror.net) (by [Fran�ois de Campredon](https://github.com/fdecampredon))
+* [Commander](http://github.com/visionmedia/commander.js) (by [Marcelo Dezem](https://github.com/mdezem))
 * [d3.js](http://d3js.org/) (from TypeScript samples)
 * [domo](http://domo-js.com/) (by [Steve Fenton](https://github.com/Steve-Fenton))
-* [dust](http://linkedin.github.com/dustjs) (by [Marcelo Dezem](https://github.com/mdezem)
+* [dust](http://linkedin.github.com/dustjs) (by [Marcelo Dezem](https://github.com/mdezem))
 * [EaselJS](http://www.createjs.com/#!/EaselJS) (by [Pedro Ferreira](https://bitbucket.org/drk4))
 * [ember.js](http://emberjs.com/) (by [Boris Yankov](https://github.com/borisyankov))
 * [EpicEditor](http://epiceditor.com/) (by [Boris Yankov](https://github.com/borisyankov))
@@ -0,0 +1,50 @@
+///<reference path="commander.d.ts"/>
+
+//
+// TODO: improve tests
+// [the code below was extracted from the documentation and examples, but does not seem to cover all cases]
+// 
+
+import program = module("commander");
+
+program
+  .version('0.0.1')
+  .option('-C, --chdir <path>', 'change the working directory')
+  .option('-c, --config <path>', 'set config path [./deploy.conf]')
+  .option('-T, --no-tests', 'ignore test hook')
+
+// $ deploy setup stage
+// $ deploy setup
+program
+  .command('setup [env]')
+  .description('run setup commands for all envs')
+  .action(function (env) {
+      env = env || 'all';
+      console.log('setup for %s env(s)', env);
+  });
+
+// $ deploy stage
+// $ deploy production
+program
+  .command('*')
+  .action(function (env) {
+      console.log('deploying "%s"', env);
+  });
+
+program.option('-p, --pepper', 'add pepper');
+
+program.option('-C, --chdir <path>', 'change the working directory');
+
+program.prompt('Username: ', function (name) {
+    console.log('hi %s', name);
+});
+
+program.prompt('Description:', function (desc) {
+    console.log('description was "%s"', desc.trim());
+});
+
+program.promptForNumber("Enter a number:", (n) => { });
+
+program.confirm("Confirm? ", (f) => { });
+
+program.choose(["a", "b", "c"], (i) => { });
@@ -0,0 +1,228 @@
+// Type definitions for commanderjs 1.1.1
+// Project: https://github.com/visionmedia/commander.js
+// Definitions by: Marcelo Dezem <http://github.com/mdezem>
+// Definitions: https://github.com/borisyankov/DefinitelyTyped
+
+declare module "commander" {
+    export interface Command {
+        /**
+        * The command name.
+        */
+        name: string;
+
+        //
+        //
+        // NOTE: the methods below are COPIED to the module
+        // as functions exports. If changes need to be made here,
+        // remember to re-paste the definitions in the module.
+        // Read below to know why such ugly thing is required.
+        //  
+        //
+
+        /**
+        * Register callback fn for the command.
+        */
+        action(fn: (...args: any[]) => any): Command;
+
+        /**
+        * Define option with flags, description and optional coercion function and default value.
+        * The flags string should contain both the short and long flags 
+        * separated by comma, a pipe or space. The following are all valid
+        * all will output this way when --help is used.
+        *
+        * "-p, --pepper"
+        * "-p|--pepper"
+        * "-p --pepper"
+        *
+        * @param flags the option flags.
+        * @param description the option description. The description is printed when "--help" is used.
+        * @param coerceFn (optional) specifies a callback function to coerce the option arg.
+        * @param defaultValue (optional) specifies a default value.
+        */
+        option(flags: string, description: string, coerceFn?: (value: string) => any, defaultValue?: any): Command;
+
+
+        /**
+        * Sets the command version
+        */
+        version(version: string): Command;
+
+        /**
+        * Parse the arguments array and invokes the commands passing the parsed options.
+        * @param argv the arguments array.
+        */
+        parse(argv: string[]): Command;
+
+        /**
+        * Gets or sets the command description. 
+        * @param description the new description for the command. When ommited this returns the current description, otherwise returns the current Command.
+        */
+        description(description: string): Command;
+        description(): string;
+
+        /**
+        * Gets or sets the usage help string.
+        */
+        usage(usage: string): Command;
+        usage(): string;
+
+        /*
+        * Prompt the user for a value, calling the callback function.
+        *
+        * Supports single-line and multi-line prompts.
+        * To issue a single-line prompt simply add a whitespace
+        * to the end of label, something like "name: ", whereas
+        * for a multi-line prompt omit this "description:".
+        * @param label the label string to be printed in console.
+        * @param callback a callback function to handle the inputed string.
+        */
+        prompt(label: string, callback: (value: string) => any): void;
+
+        promptForNumber(label: string, callback: (value: number) => any): void;
+        promptForDate(label: string, callback: (value: Date) => any): void;
+        promptSingleLine(label: string, callback: (value: string) => any): void;
+        promptMultiLine(label: string, callback: (value: string) => any): void;
+
+        /**
+        * Prompt for password with a label, a optional mask char and callback function.
+        * The mask string defaults to '', aka no output is written while typing, you may want to use "*" etc.
+        */
+        password(label: string, mask: string, callback: (value: string) => any): void;
+        password(label: string, callback: (value: string) => any): void;
+
+        /**
+        * Prompts the user for a confirmation.
+        */
+        confirm(label: string, callback: (flag: bool) => any): void;
+
+        /**
+        * Prompt for password with str, mask char and callback fn(val).
+        * The mask string defaults to '', aka no output is written while typing, you may want to use "*" etc.
+        */
+        choose(options: string[], callback: (idx: number) => any): void;
+        choose(options: any[], callback: (idx: number) => any): void;
+
+        /**
+        * Add command with the specified name. Returns a new instance of Command.
+        *
+        * The .action() callback is invoked when the
+        * command name is specified via ARGV,
+        * and the remaining arguments are applied to the
+        * function for access.
+    
+        * When the name is "*" an un-matched command
+        * will be passed as the first arg, followed by
+        * the rest of ARGV remaining.
+        *
+        * @param name the name of the command. Pass "*" to trap un-matched commands.
+        */
+        command(name: string): Command;
+    }
+
+    //
+    //
+    // since TypeScript (and ECMA6) does not supports module.exports,
+    // there is no way to set the default Command instance as the module itself.
+    // It's ugly but the only way is to copy all the methods from Command 
+    // and paste it in the module as functions exports.
+    //
+    //
+
+    /**
+    * Register callback fn for the command.
+    */
+    export function action(fn: (...args: any[]) => any): Command;
+
+    /**
+    * Define option with flags, description and optional coercion function and default value.
+    * The flags string should contain both the short and long flags 
+    * separated by comma, a pipe or space. The following are all valid
+    * all will output this way when --help is used.
+    *
+    * "-p, --pepper"
+    * "-p|--pepper"
+    * "-p --pepper"
+    *
+    * @param flags the option flags.
+    * @param description the option description. The description is printed when "--help" is used.
+    * @param coerceFn (optional) specifies a callback function to coerce the option arg.
+    * @param defaultValue (optional) specifies a default value.
+    */
+    export function option(flags: string, description: string, coerceFn?: (value: string) => any, defaultValue?: any): Command;
+
+
+    /**
+    * Sets the command version
+    */
+    export function version(version: string): Command;
+
+    /**
+    * Parse the arguments array and invokes the commands passing the parsed options.
+    * @param argv the arguments array.
+    */
+    export function parse(argv: string[]): Command;
+
+    /**
+    * Gets or sets the command description. 
+    * @param description the new description for the command. When ommited this returns the current description, otherwise returns the current Command.
+    */
+    export function description(description: string): Command;
+    export function description(): string;
+
+    /**
+    * Gets or sets the usage help string.
+    */
+    export function usage(usage: string): Command;
+    export function usage(): string;
+
+    /*
+    * Prompt the user for a value, calling the callback function.
+    *
+    * Supports single-line and multi-line prompts.
+    * To issue a single-line prompt simply add a whitespace
+    * to the end of label, something like "name: ", whereas
+    * for a multi-line prompt omit this "description:".
+    * @param label the label string to be printed in console.
+    * @param callback a callback function to handle the inputed string.
+    */
+    export function prompt(label: string, callback: (value: string) => any): void;
+
+    export function promptForNumber(label: string, callback: (value: number) => any): void;
+    export function promptForDate(label: string, callback: (value: Date) => any): void;
+    export function promptSingleLine(label: string, callback: (value: string) => any): void;
+    export function promptMultiLine(label: string, callback: (value: string) => any): void;
+    /**
+    * Prompt for password with a label, a optional mask char and callback function.
+    * The mask string defaults to '', aka no output is written while typing, you may want to use "*" etc.
+    */
+    export function password(label: string, mask: string, callback: (value: string) => any): void;
+    export function password(label: string, callback: (value: string) => any): void;
+
+    /**
+    * Prompts the user for a confirmation.
+    */
+    export function confirm(label: string, callback: (flag: bool) => any): void;
+
+    /**
+    * Prompt for password with str, mask char and callback fn(val).
+    * The mask string defaults to '', aka no output is written while typing, you may want to use "*" etc.
+    */
+    export function choose(options: string[], callback: (idx: number) => any): void;
+    export function choose(options: any[], callback: (idx: number) => any): void;
+
+    /**
+    * Add command with the specified name. Returns a new instance of Command.
+    *
+    * The .action() callback is invoked when the
+    * command name is specified via ARGV,
+    * and the remaining arguments are applied to the
+    * function for access.
+
+    * When the name is "*" an un-matched command
+    * will be passed as the first arg, followed by
+    * the rest of ARGV remaining.
+    *
+    * @param name the name of the command. Pass "*" to trap un-matched commands.
+    */
+    export function command(name: string): Command;
+}