added findFiles() functions and methods

Author: mkloubert

CHANGELOG.md

@@ -1,8 +1,13 @@
 # Change Log (vs-script-commands)
 
+## 4.5.0 (May 1st, 2017; find files)
+
+* added `$findFiles()` function for [quick executions](https://github.com/mkloubert/vs-script-commands#quick-execution-)
+* added `findFiles()` method for [ScriptCommandExecutorArguments](https://mkloubert.github.io/vs-script-commands/interfaces/_contracts_.scriptcommandexecutorarguments.html) interface
+
 ## 4.4.0 (May 1st, 2017; added support for Markdown and HTML parsing)
 
-* added `$fromMarkdown()`, `$htmlEncode()` and `$log()` for [quick executions](https://github.com/mkloubert/vs-script-commands#quick-execution-)
+* added `$fromMarkdown()`, `$htmlEncode()` and `$log()` functions for [quick executions](https://github.com/mkloubert/vs-script-commands#quick-execution-)
 * added `fromMarkdown()` and `htmlEncode()` methods for [ScriptCommandExecutorArguments](https://mkloubert.github.io/vs-script-commands/interfaces/_contracts_.scriptcommandexecutorarguments.html) interface
 
 ## 4.3.0 (May 1st, 2017; quick JavaScript execution - $output)

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.4.1",
+  "version": "4.5.0",
   "publisher": "mkloubert",
   "engines": {
     "vscode": "^1.6.0"

src/contracts.ts

@@ -398,6 +398,15 @@ export interface ScriptCommandExecutorArguments {
      * Gets the context of that extension.
      */
     readonly extension: vscode.ExtensionContext;
+    /**
+     * Finds files inside current workspace using glob patterns.
+     * 
+     * @param {string} pattern The pattern.
+     * @param {string|string[]} [ignore] The pattern(s) of files to ignore.
+     * 
+     * @return {Promise<string[]>} The promise.
+     */
+    readonly findFiles: (pattern: string, ignore?: string | string[]) => Promise<string[]>;
     /**
      * Converts Markdown to HTML.
      * 

src/controller.ts

@@ -24,6 +24,7 @@
 // DEALINGS IN THE SOFTWARE.
 
 import * as Events from 'events';
+import * as Glob from 'glob';
 import * as HtmlEntities from 'html-entities';
 import * as Marked from 'marked';
 import * as Moment from 'moment';
@@ -760,6 +761,42 @@ export class ScriptCommandController extends Events.EventEmitter implements vsco
                                         },
                                         events: undefined,
                                         extension: undefined,
+                                        findFiles: (pattern, ignore?) => {
+                                            return new Promise<string[]>((resolve, reject) => {
+                                                try {
+                                                    pattern = sc_helpers.toStringSafe(pattern);
+                                                    if ('' === pattern.trim()) {
+                                                        pattern = '**';
+                                                    }
+
+                                                    ignore = sc_helpers.asArray(ignore)
+                                                                       .map(x => sc_helpers.toStringSafe(x))
+                                                                       .filter(x => '' !== x.trim());
+
+                                                    Glob(pattern, <any>{
+                                                        cwd: vscode.workspace.rootPath,
+                                                        root: vscode.workspace.rootPath,
+                                                        dot: true,
+                                                        nocase: true,
+                                                        nodir: true,
+                                                        nosort: false,
+                                                        realpath: false,
+                                                        ignore: ignore,
+                                                        absolute: true,
+                                                    }, (err, files) => {
+                                                        if (err) {
+                                                            reject(err);
+                                                        }
+                                                        else {
+                                                            resolve(files);
+                                                        }
+                                                    });
+                                                }
+                                                catch (e) {
+                                                    reject(e);
+                                                }
+                                            });
+                                        },
                                         fromMarkdown: (markdown) => {
                                             markdown = sc_helpers.toStringSafe(markdown);
 

src/quick.ts

@@ -26,6 +26,7 @@
 import * as FS from 'fs';
 import * as FSExtra from 'fs-extra';
 import * as HtmlEntities from 'html-entities';
+import * as Glob from 'glob';
 import * as Marked from 'marked';
 import * as Moment from 'moment';
 import * as Path from 'path';
@@ -208,6 +209,7 @@ function _generateHelpHTML(): string {
     markdown += "| `$execute(scriptPath: string, ...args: any[]): any` | Executes a script ([module](https://mkloubert.github.io/vs-script-commands/interfaces/_quick_.scriptmodule.html)). |\n";
     markdown += "| `$executeCommand(command: string, ...args: any[]): vscode.Thenable<any>` | Executes a command. |\n";
     markdown += "| `$exists(path: string): boolean` | Checks if a path exists. |\n";
+    markdown += "| `$findFiles(globPattern: string, ignore?: string | 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 += "| `$help(): vscode.Thenable<any>` | Shows this help document. |\n";
     markdown += "| `$htmlEncode(str: string): string` | Encodes the HTML entities in a string. |\n";
@@ -307,6 +309,7 @@ function _generateHTMLForResult(expr: string, result: any): string {
     return html;
 }
 
+
 /**
  * Does a "quick execution".
  */
@@ -326,7 +329,7 @@ export function quickExecution() {
     }).then((_expr) => {
         let _noResultInfo = _permanentNoResultInfo;
         let _showResultInTab = _permanentShowResultInTab;
-        let _completed = (err: any, result?: any) => {
+        const _completed = (err: any, result?: any) => {
             _state = $state;
 
             if (err) {
@@ -394,6 +397,7 @@ export function quickExecution() {
             };
 
             let _currentDir = _permanentCurrentDirectory;
+
             const $cwd = function(newPath?: string, permanent = false) {
                 if (arguments.length > 0) {
                     newPath = sc_helpers.toStringSafe(arguments[0]);
@@ -461,6 +465,28 @@ export function quickExecution() {
                 return FS.existsSync(path);
             };
             const $extension = $me.context;
+            const $findFiles = function(pattern: string, ignore?: string[]): string[] {
+                pattern = sc_helpers.toStringSafe(pattern);
+                if ('' === pattern.trim()) {
+                    pattern = '**';
+                }
+
+                ignore = sc_helpers.asArray(ignore)
+                                   .map(x => sc_helpers.toStringSafe(x))
+                                   .filter(x => '' !== x.trim());
+
+                return Glob.sync(pattern, <any>{
+                    cwd: _currentDir,
+                    root: _currentDir,
+                    dot: true,
+                    nocase: true,
+                    nodir: true,
+                    nosort: false,
+                    realpath: false,
+                    ignore: ignore,
+                    absolute: true,
+                });
+            };
             const $fromMarkdown = function(markdown: string): string {
                 return _fromMarkdown(markdown);
             };