added $, $readFile and $readJSON functions for quick executions

Author: mkloubert

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Change Log (vs-script-commands)
 
+## 4.8.0 (May 2nd, 2017; quick execution functions)
+
+* added `$` and `$readJSON()` and `$readString()` functions for [quick executions](https://github.com/mkloubert/vs-script-commands#quick-execution-)
+
 ## 4.7.0 (May 2nd, 2017; hashes and UUIDs)
 
 * added `$guid()`, `$hash()`, `$md5()`, `$sha1()`, `$sha256()` and `$uuid()` functions for [quick executions](https://github.com/mkloubert/vs-script-commands#quick-execution-)

README.md

@@ -55,7 +55,9 @@ Add a `script.commands` section:
 | Name | Description |
 | ---- | --------- |
 | `commands` | One or more [commands](#commands-) to register. |
+| `disableNewVersionPopups` | Disables the display of popups that reports for a new version of that extension. Default `(false)` |
 | `globals` | Global data available for ALL commands defined by that extension. |
+| `quick` | Settings for [quick execution](#quick-execution-) feature. |
 | `showOutput` | Open output on startup or not. Default `(true)` |
 | `showInternalVSCommands` | Show internal Visual Studio Code commands in GUI or not. Default `(false)` |
 
@@ -284,6 +286,7 @@ You can define custom settings for the feature:
 | Name | Description |
 | ---- | --------- |
 | `cwd` | The initial current directory for the executions. |
+| `disableHexView` | Do not show binary data in 'hex view'. Default: `(false)` |
 | `noResultInfo` | Do not show results of executions. Default: `(false)` |
 | `showResultInTab` | Show results in tab instead of a popup or not. Default: `(false)` |
 | `state` | The initial state value. |

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": "4.7.0",
+  "version": "4.8.0",
   "publisher": "mkloubert",
   "engines": {
     "vscode": "^1.6.0"
@@ -456,6 +456,7 @@
     "html-entities": "^1.2.1",
     "marked": "^0.3.6",
     "moment": "^2.17.1",
+    "node-workflows": "^1.3.1",
     "tmp": "0.0.31",
     "uuid": "^3.0.1"
   }

src/quick.ts

@@ -36,6 +36,7 @@ import * as sc_controller from './controller';
 import * as sc_helpers from './helpers';
 import * as UUID from 'uuid';
 import * as vscode from 'vscode';
+import * as Workflows from 'node-workflows';
 
 
 /**
@@ -205,6 +206,7 @@ function _generateHelpHTML(): string {
     markdown += "## Functions\n";
     markdown += "| Name | Description |\n";
     markdown += "| ---- | --------- |\n";
+    markdown += "| `$(...results: any[]): Promise<any[]>` | Executes a list of actions and returns its results. |\n";
     markdown += "| `$asString(val: any): string` | Returns a value as string. |\n";
     markdown += "| `$cwd(newPath?: string, permanent?: boolean = false): string` | Gets or sets the current working directory for the execution. |\n";
     markdown += "| `$disableHexView(flag?: boolean, permanent?: boolean = false): boolean` | Gets or sets if 'hex view' for binary results should be disabled or not. |\n";
@@ -228,6 +230,8 @@ function _generateHelpHTML(): string {
     markdown += "| `$now(): Moment.Moment` | Returns the current [time](https://momentjs.com/docs/). |\n";
     markdown += "| `$openHtml(html: string, tabTitle?: string): vscode.Thenable<any>` | Opens a HTML document in a new tab. |\n";
     markdown += "| `$readFile(path: string): Buffer` | Reads the data of a file. |\n";
+    markdown += "| `$readJSON(file: string, encoding?: string = 'utf8'): any` | Reads a JSON file and returns the its object / value. |\n";
+    markdown += "| `$readString(file: string, encoding?: string = 'utf8'): any` | Reads a file as string. |\n";
     markdown += "| `$require(id: string): any` | Loads a module from execution / extension context. |\n";
     markdown += "| `$setState(newValue: any): any` | Sets the value of `$state` variable and returns the new value. |\n";
     markdown += "| `$sha1(data: any, asBuffer: boolean = false): string` | Hashes data by SHA-1. |\n";
@@ -404,6 +408,49 @@ export function quickExecution() {
             });
 
             let $args: any[];
+            const $ = function(...args: any[]): Promise<any[]> {
+                return new Promise<any>((resolve, reject) => {
+                    let wf = Workflows.create();
+
+                    wf.next((ctx) => {
+                        ctx.result = [];
+                    });
+
+                    if (args) {
+                        args.forEach(a => {
+                            wf.next((ctx) => {
+                                let result: any[] = ctx.result;
+
+                                return new Promise<any>((res, rej) => {
+                                    try {
+                                        Promise.resolve(a).then((r) => {
+                                            try {
+                                                result.push(r);
+
+                                                res();
+                                            }
+                                            catch (e) {
+                                                rej(e);
+                                            }
+                                        }).catch((err) => {
+                                            rej(err);
+                                        });
+                                    }
+                                    catch (e) {
+                                        rej(e);
+                                    }
+                                });
+                            });
+                        });
+                    }
+
+                    return wf.start().then((result: any[]) => {
+                        resolve(result);
+                    }).catch((err) => {
+                        reject(err);
+                    });
+                });
+            };
             const $asString = function(val: any, enc?: string): string {
                 if (sc_helpers.isNullOrUndefined(val)) {
                     return val;
@@ -589,14 +636,40 @@ export function quickExecution() {
                 return $me.openHtml(html, title);
             };
             const $output = $me.outputChannel;
-            const $readFile = function(file: string) {
+            const $readFile = function(file: string): Buffer {
                 file = sc_helpers.toStringSafe(file);
                 if (!Path.isAbsolute(file)) {
                     file = Path.join(_currentDir, file);
                 }
 
                 return FS.readFileSync(file);
             };
+            const $readJSON = function(file: string, enc = 'utf8'): any {
+                file = sc_helpers.toStringSafe(file);
+                if (!Path.isAbsolute(file)) {
+                    file = Path.join(_currentDir, file);
+                }
+
+                enc = sc_helpers.normalizeString(enc);
+                if ('' === enc) {
+                    enc = 'utf8';
+                }
+
+                return JSON.parse( FS.readFileSync(file).toString(enc) );
+            };
+            const $readString = function(file: string, enc = 'utf8'): string {
+                file = sc_helpers.toStringSafe(file);
+                if (!Path.isAbsolute(file)) {
+                    file = Path.join(_currentDir, file);
+                }
+
+                enc = sc_helpers.normalizeString(enc);
+                if ('' === enc) {
+                    enc = 'utf8';
+                }
+
+                return FS.readFileSync(file).toString(enc);
+            };
             const $require = function(id: string): any {
                 return require(sc_helpers.toStringSafe(id));
             };