added hashing and UUID functions for quick execution

Author: mkloubert

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Change Log (vs-script-commands)
 
+## 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-)
+
 ## 4.6.0 (May 1st, 2017; hex view of binary files)
 
 * [Buffer](https://nodejs.org/api/buffer.html) results are displayed in "hex view" now, when displaying in tab

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.6.0",
+  "version": "4.7.0",
   "publisher": "mkloubert",
   "engines": {
     "vscode": "^1.6.0"
@@ -432,6 +432,7 @@
     "@types/mocha": "^2.2.32",
     "@types/node": "^6.0.40",
     "@types/tmp": "0.0.32",
+    "@types/uuid": "^2.0.29",
     "mocha": "^2.3.3",
     "typescript": "^2.0.3",
     "vscode": "^1.0.0"
@@ -455,6 +456,7 @@
     "html-entities": "^1.2.1",
     "marked": "^0.3.6",
     "moment": "^2.17.1",
-    "tmp": "0.0.31"
+    "tmp": "0.0.31",
+    "uuid": "^3.0.1"
   }
 }

src/helpers.ts

@@ -24,6 +24,7 @@
 // DEALINGS IN THE SOFTWARE.
 
 import * as ChildProcess from 'child_process';
+import * as Crypto from 'crypto';
 import * as FS from 'fs';
 import * as Path from 'path';
 import * as Moment from 'moment';
@@ -174,6 +175,32 @@ export function getUrlParam(params: Object, name: string): string {
     }
 }
 
+/**
+ * Hashes data.
+ * 
+ * @param {string} algo The algorithm to use.
+ * @param {string|Buffer} data 
+ * @param {boolean} [raw] Return hash in binary format or as (hext) string.
+ */
+export function hash(algo: string, data: string | Buffer, asBuffer = false): string | Buffer {
+    if (isNullOrUndefined(data)) {
+        return data;
+    }
+    
+    algo = normalizeString(algo);
+    if ('' === algo) {
+        algo = 'sha256';
+    }
+
+    asBuffer = toBooleanSafe(asBuffer);
+
+    let hash = Crypto.createHash(algo)
+                     .update(data)
+                     .digest();
+
+    return asBuffer ? hash : hash.toString('hex');
+}
+
 /**
  * Checks if the string representation of a value is empty
  * or contains whitespaces only.

src/quick.ts

@@ -34,6 +34,7 @@ import * as Path from 'path';
 import * as sc_contracts from './contracts';
 import * as sc_controller from './controller';
 import * as sc_helpers from './helpers';
+import * as UUID from 'uuid';
 import * as vscode from 'vscode';
 
 
@@ -214,21 +215,27 @@ function _generateHelpHTML(): string {
     markdown += "| `$exists(path: string): boolean` | Checks if a path exists. |\n";
     markdown += "| `$findFiles(globPattern: string, ignore?: string[]): string[]` | Finds files using [glob patterns](https://github.com/isaacs/node-glob). |\n";
     markdown += "| `$fromMarkdown(markdown: string): string` | Converts [Markdown](https://guides.github.com/features/mastering-markdown/) to HTML. |\n";
+    markdown += "| `$guid(v4: boolean = true): string` | Alias for `$uuid`. |\n";
+    markdown += "| `$hash(algorithm: string, data: any, asBuffer: boolean = false): string` | Hashes data. |\n";
     markdown += "| `$help(): vscode.Thenable<any>` | Shows this help document. |\n";
     markdown += "| `$htmlEncode(str: string): string` | Encodes the HTML entities in a string. |\n";
     markdown += "| `$info(msg: string): vscode.Thenable<any>` | Shows an info popup. |\n";
     markdown += "| `$log(msg: any): void` | Logs a message. |\n";
     markdown += "| `$lstat(path: string): fs.Stats` | Gets information about a path. |\n";
+    markdown += "| `$md5(data: any, asBuffer: boolean = false): string` | Hashes data by MD5. |\n";
     markdown += "| `$mkdir(dir: string): void` | Creates a directory (with all its sub directories). |\n";
     markdown += "| `$noResultInfo(flag?: boolean, permanent?: boolean = false): boolean` | Gets or sets if result should be displayed or not. |\n";
     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 += "| `$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";
+    markdown += "| `$sha256(data: any, asBuffer: boolean = false): string` | Hashes data by SHA-256. |\n";
     markdown += "| `$showResultInTab(flag?: boolean, permanent?: boolean = false): boolean` | Gets or sets if result should be shown in a tab window or a popup. |\n";
     markdown += "| `$toHexView(val: any): string` | Converts a value, like a buffer or string, to 'hex view'. |\n";
     markdown += "| `$unlink(path: string): boolean` | Removes a file or folder. |\n";
+    markdown += "| `$uuid(v4: boolean = true): string` | Generates a new unique ID. |\n";
     markdown += "| `$warn(msg: string): vscode.Thenable<any>` | Shows a warning popup. |\n";
     markdown += "| `$writeFile(path: string, data: any): void` | Writes data to a file. |\n";
     markdown += "\n";
@@ -521,6 +528,12 @@ export function quickExecution() {
                 return _fromMarkdown(markdown);
             };
             const $globals = $me.getGlobals();
+            const $guid = function(v4 = true) {
+                return sc_helpers.toBooleanSafe(v4) ? UUID.v4() : UUID.v1();
+            };
+            const $hash = function(algo: string, data: string | Buffer, asBuffer = false): string | Buffer {
+                return sc_helpers.hash(algo, data, asBuffer);
+            };
             const $help = function() {
                 return $me.openHtml(_generateHelpHTML(),
                                     '[vs-script-commands] Quick execution');
@@ -555,6 +568,9 @@ export function quickExecution() {
                 FSExtra.mkdirsSync(dir);
             };
             let $maxDepth = 64;
+            const $md5 = function(data: string | Buffer, asBuffer = false): string | Buffer {
+                return sc_helpers.hash('md5', data, asBuffer);
+            };
             const $noResultInfo = function(flag?: boolean, permanent = false): boolean {
                 if (arguments.length > 0) {
                     _noResultInfo = sc_helpers.toBooleanSafe(flag);
@@ -587,6 +603,12 @@ export function quickExecution() {
             const $setState = function(val: any): any {
                 return $state = val;
             };
+            const $sha1 = function(data: string | Buffer, asBuffer = false): string | Buffer {
+                return sc_helpers.hash('sha1', data, asBuffer);
+            };
+            const $sha256 = function(data: string | Buffer, asBuffer = false): string | Buffer {
+                return sc_helpers.hash('sha256', data, asBuffer);
+            };
             const $showResultInTab = function(flag?: boolean, permanent = false): boolean {
                 if (arguments.length > 0) {
                     _showResultInTab = sc_helpers.toBooleanSafe(flag);
@@ -617,6 +639,9 @@ export function quickExecution() {
                     FS.unlinkSync(path);
                 }
             };
+            const $uuid = function(v4 = true) {
+                return sc_helpers.toBooleanSafe(v4) ? UUID.v4() : UUID.v1();
+            };
             const $warn = function(msg: string) {
                 return vscode.window
                              .showWarningMessage( sc_helpers.toStringSafe(msg) );