added 'quick execution' feature

mkloubert · mkloubert · commit d208936ed17b · 2017-04-29T19:42:31.000+02:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,9 @@
 # Change Log (vs-script-commands)
 
+# 4.0.0 (April 29th, 2017; quick JavaScript execution)
+
+* added `Script commands: Quick execution` command that can [execute JavaScript code quickly](https://github.com/mkloubert/vs-script-commands#quick-execution-) ... enter `$help` as first action to get information about available functions and variables
+
 # 3.0.0 (April 21st, 2017; execute command before save document)
 
 * added `onWillSave` setting for commands, which indicates to invoke commands if a file is going to be saved
diff --git a/README.md b/README.md
@@ -18,6 +18,7 @@ Adds additional commands to [Visual Studio Code](https://code.visualstudio.com/)
    * [Key bindinds](#key-bindinds-)
    * [Invoke manually](#invoke-manually-)
    * [Status bar buttons](#status-bar-buttons-)
+   * [Quick execution](#quick-execution-)
 3. [Documentation](#documentation-)
 
 ## Install [[&uarr;](#table-of-contents)]
@@ -221,6 +222,7 @@ Press `F1` to open the list of commands and enter one of the following commands:
 | ---- | ---- | --------- |
 | `Script commands: Execute command` | Executes a command defined by that extension. | `extension.scriptCommands.execute` |
 | `Script commands: Execute VSCode command` | Executes another command that is available in VSCode. | `extension.scriptCommands.executeVSCode` |
+| `Script commands: Quick execution` | Executes a JavaScript expression quickly. | `extension.scriptCommands.quickExecution` |
 
 ### Status bar buttons [[&uarr;](#how-to-use-)]
 
@@ -255,6 +257,12 @@ You can activate buttons for your commands in the status bar, by defining the `b
 | `text` | The caption for the button. |
 | `tooltip` | The tooltip for the button. |
 
+### Quick execution [[&uarr;](#how-to-use-)]
+
+Press `F1` to open the list of commands and select `Script commands: Quick execution` to execute any JavaScript expression (execute `$help` to open a help tab which lists all available features, like functions and variables):
+
+![Demo Quick execution](https://raw.githubusercontent.com/mkloubert/vs-script-commands/master/img/demo4.gif)
+
 ## Documentation [[&uarr;](#table-of-contents)]
 
 The full API documentation can be found [here](https://mkloubert.github.io/vs-script-commands/).
diff --git a/img/demo4.gif b/img/demo4.gif
diff --git a/package.json b/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": "3.0.0",
+  "version": "4.0.0",
   "publisher": "mkloubert",
   "engines": {
     "vscode": "^1.6.0"
@@ -33,6 +33,11 @@
         "command": "extension.scriptCommands.executeVSCode",
         "title": "Execute VSCode command",
         "category": "Script commands"
+      },
+      {
+        "command": "extension.scriptCommands.quickExecution",
+        "title": "Quick execution",
+        "category": "Script commands"
       }
     ],
     "configuration": {
@@ -142,10 +147,10 @@
                       "default": false
                     },
                     "onFileClosed": {
-                        "type": "boolean",
-                        "description": "Is invoked when a file has been closed.",
-                        "default": false
-                      },
+                      "type": "boolean",
+                      "description": "Is invoked when a file has been closed.",
+                      "default": false
+                    },
                     "onFileDeleted": {
                       "type": "boolean",
                       "description": "Is invoked when a file has been deleted.",
@@ -195,8 +200,9 @@
                       "default": false
                     }
                   },
-                  "required":[
-                    "id", "script"
+                  "required": [
+                    "id",
+                    "script"
                   ]
                 },
                 {
@@ -353,8 +359,9 @@
                         "default": false
                       }
                     },
-                    "required":[
-                      "id", "script"
+                    "required": [
+                      "id",
+                      "script"
                     ]
                   }
                 }
@@ -363,6 +370,29 @@
             "globals": {
               "description": "Global data available for ALL commands defined by that extension."
             },
+            "quick": {
+              "description": "Settings for 'quick execution'.",
+              "type": "object",
+              "properties": {
+                "cwd": {
+                  "description": "The initial current directory for the executions.",
+                  "type": "string"
+                },
+                "noResultInfo": {
+                  "description": "Show result of execution or not.",
+                  "type": "boolean",
+                  "default": false
+                },
+                "showResultInTab": {
+                  "description": "Show results in tab instead of a popup or not.",
+                  "type": "boolean",
+                  "default": false
+                },
+                "state": {
+                  "description": "The initial state value."
+                }
+              }
+            },
             "showOutput": {
               "type": "boolean",
               "description": "Show output on startup or not.",
@@ -385,11 +415,16 @@
     "test": "node ./node_modules/vscode/bin/test"
   },
   "devDependencies": {
-    "typescript": "^2.0.3",
-    "vscode": "^1.0.0",
-    "mocha": "^2.3.3",
+    "@types/fs-extra": "^2.1.0",
+    "@types/glob": "^5.0.30",
+    "@types/html-entities": "^1.2.15",
+    "@types/marked": "0.0.28",
+    "@types/mocha": "^2.2.32",
     "@types/node": "^6.0.40",
-    "@types/mocha": "^2.2.32"
+    "@types/tmp": "0.0.32",
+    "mocha": "^2.3.3",
+    "typescript": "^2.0.3",
+    "vscode": "^1.0.0"
   },
   "icon": "icon.png",
   "author": {
@@ -404,6 +439,11 @@
   },
   "readmeFilename": "README.md",
   "dependencies": {
-    "moment": "^2.17.1"
+    "fs-extra": "^3.0.0",
+    "glob": "^7.1.1",
+    "html-entities": "^1.2.1",
+    "marked": "^0.3.6",
+    "moment": "^2.17.1",
+    "tmp": "0.0.31"
   }
 }
diff --git a/src/content.ts b/src/content.ts
@@ -78,7 +78,7 @@ export class HtmlTextDocumentContentProvider implements vscode.TextDocumentConte
                     for (let i = 0; i < htmlDocs.length; i++) {
                         let d = htmlDocs[i];
 
-                        if (sc_helpers.toStringSafe(d.id).trim() == id) {
+                        if (sc_helpers.toStringSafe(d.id).trim() === id) {
                             doc = d;
                             break;
                         }
@@ -90,7 +90,7 @@ export class HtmlTextDocumentContentProvider implements vscode.TextDocumentConte
                 if (doc) {
                     if (doc.body) {
                         let enc = sc_helpers.normalizeString(doc.encoding);
-                        if (!enc) {
+                        if ('' === enc) {
                             enc = 'utf8';
                         }
 
diff --git a/src/contracts.ts b/src/contracts.ts
@@ -39,6 +39,27 @@ export interface Configuration {
      * Global data available for ALL commands defined by that extension.
      */
     globals?: GlobalVariables;
+    /**
+     * Settings for "quick execution".
+     */
+    quick?: {
+        /**
+         * The initial current directory for the executions.
+         */
+        cwd?: string;
+        /**
+         * Show result of execution or not.
+         */
+        noResultInfo?: boolean;
+        /**
+         * Show results in tab instead of a popup or not.
+         */
+        showResultInTab?: boolean;
+        /**
+         * The initial state value.
+         */
+        state?: any;
+    };
     /**
      * Open output on startup or not.
      */
diff --git a/src/controller.ts b/src/controller.ts
@@ -28,6 +28,7 @@ import * as Moment from 'moment';
 import * as Path from 'path';
 import * as sc_contracts from './contracts';
 import * as sc_helpers from './helpers';
+import * as sc_quick from './quick';
 import * as vscode from 'vscode';
 
 
@@ -154,6 +155,13 @@ export class ScriptCommandController extends Events.EventEmitter implements vsco
         return this._config || {};
     }
 
+    /**
+     * Gets the underlying extension context.
+     */
+    public get context(): vscode.ExtensionContext {
+        return this._CONTEXT;
+    }
+
     /** @inheritdoc */
     public dispose() {
         try {
@@ -589,7 +597,7 @@ export class ScriptCommandController extends Events.EventEmitter implements vsco
     }
 
     /**
-     * Is invoked when a document is being to be saved.
+     * Is invoked when a document is going to be saved.
      * 
      * @param {vscode.TextDocumentWillSaveEvent} e The event data.
      */
@@ -598,6 +606,20 @@ export class ScriptCommandController extends Events.EventEmitter implements vsco
                           () => [ e ]);
     }
 
+    /**
+     * Opens a HTML document in a new tab.
+     * 
+     * @param {string} html The HTML document (source code).
+     * @param {string} [title] The custom title for the tab.
+     * @param {any} [id] The custom ID for the document in the storage.
+     * 
+     * @returns {Promise<any>} The promise.
+     */
+    public openHtml(html: string, title?: string, id?: any): Promise<any> {
+        return sc_helpers.openHtmlDocument(this.htmlDocuments,
+                                           html, title, id);
+    }
+
     /**
      * Gets the global output channel.
      */
@@ -612,6 +634,14 @@ export class ScriptCommandController extends Events.EventEmitter implements vsco
         return this._PACKAGE_FILE;
     }
 
+    /**
+     * Does a "quick execution".
+     */
+    public quickExecution() {
+        return sc_quick.quickExecution
+                       .apply(this, arguments);
+    }
+
     /**
      * Reloads the commands.
      */
@@ -983,6 +1013,10 @@ export class ScriptCommandController extends Events.EventEmitter implements vsco
 
             me.reloadCommands();
 
+            // reset all "quick" stuff
+            sc_quick.reset
+                    .apply(me, []);
+
             // startup commands
             let commandsToExecute = me.getCommands().filter(x => {
                 return sc_helpers.toBooleanSafe(x.onStartup);
diff --git a/src/extension.ts b/src/extension.ts
@@ -86,6 +86,16 @@ export function activate(context: vscode.ExtensionContext) {
         }
     });
 
+    // quick JavaScript execution
+    let quickExecution = vscode.commands.registerCommand('extension.scriptCommands.quickExecution', () => {
+        try {
+            controller.quickExecution();
+        }
+        catch (e) {
+            vscode.window.showErrorMessage(`[QUICK EXECUTION ERROR]: ${sc_helpers.toStringSafe(e)}`);
+        }
+    });
+
     // open HTML document
     let openHtmlDoc = vscode.commands.registerCommand('extension.scriptCommands.openHtmlDoc', (doc: sc_contracts.Document) => {
         try {
@@ -137,7 +147,7 @@ export function activate(context: vscode.ExtensionContext) {
                                                                         controller));
 
     context.subscriptions.push(controller,
-                               executeCmd, executeVSCmd, openHtmlDoc,
+                               executeCmd, executeVSCmd, quickExecution, openHtmlDoc,
                                htmlViewer);
 
     controller.onActivated();
diff --git a/src/helpers.ts b/src/helpers.ts
@@ -148,7 +148,7 @@ export function getUrlParam(params: Object, name: string): string {
         name = normalizeString(name);
 
         for (let p in params) {
-            if (normalizeString(p) == name) {
+            if (normalizeString(p) === name) {
                 return toStringSafe(params[p]);
             }
         }
@@ -164,7 +164,7 @@ export function getUrlParam(params: Object, name: string): string {
  * @return {boolean} Is empty or not.
  */
 export function isEmptyString(val: any): boolean {
-    return '' == toStringSafe(val).trim();
+    return '' === toStringSafe(val).trim();
 }
 
 /**
@@ -317,6 +317,24 @@ export function removeDocuments(docs: sc_contracts.Document | sc_contracts.Docum
     return removed;
 }
 
+/**
+ * Replaces all occurrences of a string.
+ * 
+ * @param {any} str The input string.
+ * @param {any} searchValue The value to search for.
+ * @param {any} replaceValue The value to replace 'searchValue' with.
+ * 
+ * @return {string} The output string.
+ */
+export function replaceAllStrings(str: any, searchValue: any, replaceValue: any) {
+    str = toStringSafe(str);
+    searchValue = toStringSafe(searchValue);
+    replaceValue = toStringSafe(replaceValue);
+
+    return str.split(searchValue)
+              .join(replaceValue);
+}
+
 /**
  * Sorts a list of commands.
  * 
@@ -372,6 +390,31 @@ export function sortCommands(pkgs: sc_contracts.ScriptCommand[],
                .map(x => x.value);
 }
 
+/**
+ * Returns an array like object as new array.
+ * 
+ * @param {ArrayLike<T>} arr The input object. 
+ * @param {boolean} [normalize] Returns an empty array, if input object is (null) / undefined.
+ * 
+ * @return {T[]} The input object as array. 
+ */
+export function toArray<T>(arr: ArrayLike<T>, normalize = true): T[] {
+    if (isNullOrUndefined(arr)) {
+        if (toBooleanSafe(normalize)) {
+            return [];
+        }
+        
+        return <any>arr;
+    }
+
+    let newArray: T[] = [];
+    for (let i = 0; i < arr.length; i++) {
+        newArray.push(arr[i]);
+    }
+
+    return newArray;
+}
+
 /**
  * Converts a value to a boolean.
  * 
diff --git a/src/quick.ts b/src/quick.ts
