added deploy() method to ScriptCommandExecutorArguments

Author: mkloubert

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Change Log (vs-script-commands)
 
+## 1.10.0 (February 20th, 2017; deploy files)
+
+* added [deploy](https://mkloubert.github.io/vs-script-commands/interfaces/_contracts_.scriptcommandexecutorarguments.html#deploy) method to [ScriptCommandExecutorArguments](https://mkloubert.github.io/vs-script-commands/interfaces/_contracts_.scriptcommandexecutorarguments.html) which make use of `extension.deploy.filesTo` command, provided by [vs-deploy](https://github.com/mkloubert/vs-deploy) extension
+
 ## 1.9.0 (February 20th, 2017; output channel)
 
 * added [outputChannel](https://mkloubert.github.io/vs-script-commands/interfaces/_contracts_.scriptcommandexecutorarguments.html#outputChannel) property to [ScriptCommandExecutorArguments](https://mkloubert.github.io/vs-script-commands/interfaces/_contracts_.scriptcommandexecutorarguments.html) that gets the [OutputChannel](https://code.visualstudio.com/Docs/extensionAPI/vscode-api#OutputChannel) instance of that extension

README.md

@@ -139,6 +139,14 @@ exports.execute = function (args) {
         // opening HTML document failed
     });
 
+    // deploys 'index.html' to 'My SFTP server'
+    // s. https://github.com/mkloubert/vs-deploy
+    args.deploy(['./index.html'], ['My SFTP server']).then(function() {
+        // file deployed
+    }, function(err) {
+        // deployment failed
+    });
+
     vscode.window.showInformationMessage('Hello from my extension: ' + scriptFile);
 }
 ```

package.json

@@ -2,7 +2,7 @@
   "name": "vs-script-commands",
   "displayName": "Script Commands",
   "description": "Adds additional commands to Visual Studio Code that uses scripts (JavaScript) for execution.",
-  "version": "1.9.0",
+  "version": "1.10.0",
   "publisher": "mkloubert",
   "engines": {
     "vscode": "^1.5.0"

src/contracts.ts

@@ -298,6 +298,19 @@ export interface ScriptCommandExecutorArguments {
      * and is available for ONLY for current command.
      */
     commandState: any;
+    /**
+     * Deploys one or more file to a list of targets.
+     * 
+     * This requires 'extension.deploy.filesTo' command as available in extensions like 'vs-deploy'
+     * s. https://github.com/mkloubert/vs-deploy
+     * 
+     * @param {string|string[]} files One or more file to deploy.
+     * @param {string|string[]} targets One or more target (name) to deploy to.
+     * 
+     * @returns {Promise<any>} The promise.
+     */
+    readonly deploy: (files: string | string[],
+                      targets: string | string[]) => Promise<any>;
     /**
      * Gets the event emitter that can be used by ALL commands.
      */

src/controller.ts

@@ -683,6 +683,34 @@ export class ScriptCommandController extends Events.EventEmitter implements vsco
                                 button: undefined,
                                 command: cmdId,
                                 commandState: commandState,
+                                deploy: (files, targets) => {
+                                    // files
+                                    files = sc_helpers.asArray(files)
+                                                      .map(x => sc_helpers.toStringSafe(x))
+                                                      .filter(x => !sc_helpers.isEmptyString(x));
+                                    files = sc_helpers.distinctArray(files);
+
+                                    // targets
+                                    targets = sc_helpers.asArray(targets)
+                                                        .map(x => sc_helpers.normalizeString(x))
+                                                        .filter(x => x);
+                                    targets = sc_helpers.distinctArray(targets);
+
+                                    return new Promise<any>((resolve, reject) => {
+                                        let completed = sc_helpers.createSimplePromiseCompletedAction(resolve, reject);
+
+                                        try {
+                                            vscode.commands.executeCommand('extension.deploy.filesTo', files, targets).then((result) => {
+                                                completed(null, result);
+                                            }, (err) => {
+                                                completed(err);
+                                            });
+                                        }
+                                        catch (e) {
+                                            completed(e);
+                                        }
+                                    });
+                                },
                                 events: undefined,
                                 extension: undefined,
                                 globals: me.getGlobals(),

src/helpers.ts

@@ -118,6 +118,23 @@ export function createSimplePromiseCompletedAction<TResult>(resolve: (value?: TR
     };
 }
 
+/**
+ * Removes duplicate entries from an array.
+ * 
+ * @param {T[]} arr The input array.
+ * 
+ * @return {T[]} The filtered array.
+ */
+export function distinctArray<T>(arr: T[]): T[] {
+    if (!arr) {
+        return arr;
+    }
+
+    return arr.filter((x, i) => {
+        return arr.indexOf(x) === i;
+    });
+}
+
 /**
  * Returns the value from a "parameter" object.
  *