executeOnStartup and bug fixes

CHANGELOG.md

@@ -1,5 +1,10 @@
 # Change Log (vscode-deploy-reloaded)
 
+## 0.10.0 (December 30th, 2017; shell commands)
+
+* added `executeOnStartup` [setting](https://github.com/mkloubert/vscode-deploy-reloaded/wiki#settings--), which runs [shell commands on startup](https://github.com/mkloubert/vscode-deploy-reloaded/wiki/execute_on_startup)
+* fixed use of [if](https://github.com/mkloubert/vscode-deploy-reloaded/wiki/if) property in setting objects
+
 ## 0.9.0 (December 30th, 2017; [Composer](https://getcomposer.org/))
 
 * added tools for handling [Composer](https://getcomposer.org/) packages:

package.json

@@ -2,7 +2,7 @@
  "name": "vscode-deploy-reloaded",
  "displayName": "Deploy (Reloaded)",
  "description": "Deploys files of a workspace to a destination.",
- "version": "0.9.0",
+ "version": "0.10.0",
  "publisher": "mkloubert",
  "engines": {
   "vscode": "^1.19.0"
@@ -238,6 +238,51 @@
         }
        }
       },
+      "executeOnStartup": {
+       "description": "One or more shell commands to execute.",
+       "type": "array",
+       "items": {
+        "oneOf": [
+         {
+          "description": "The shell command to execute.",
+          "type": "string",
+          "pattern": "\\S+"
+         },
+         {
+          "description": "Settings for a shell command to execute.",
+          "type": "object",
+          "properties": {
+           "command": {
+            "description": "The shell command to execute.",
+            "type": "string",
+            "pattern": "\\S+"
+           },
+           "cwd": {
+            "description": "The custom working directory.",
+            "type": "string"
+           },
+           "ignoreIfFail": {
+            "description": "Ignore if command fails or not.",
+            "type": "boolean",
+            "default": false
+           },
+           "name": {
+            "description": "The custom name to display.",
+            "type": "string"
+           },
+           "noPlaceHolders": {
+            "description": "Do not use placeholders in 'command' property.",
+            "type": "boolean",
+            "default": false
+           }
+          },
+          "required": [
+           "command"
+          ]
+         }
+        ]
+       }
+      },
       "globals": {
        "description": "Global data to define, which can be access by scripts, e.g."
       },

src/code.ts

@@ -56,7 +56,13 @@ export function exec<TResult = any, TContext = any>(context: CodeExecutionContex
     };
     const $v = deploy_values.toValueStorage(context.values);
 
-    return eval(
-        $h.toStringSafe(context.code)
+    const $e = (code: any) => {
+        return eval(
+            $h.toStringSafe(code)
+        );
+    };
+
+    return $e(
+        context.code
     );
 }

src/contracts.ts

@@ -148,6 +148,10 @@ export interface Configuration extends deploy_values.WithValueItems {
          */
         readonly vars?: KeyValuePairs;
     };
+    /**
+     * One or more shell commands that should be run on startup.
+     */
+    readonly executeOnStartup?: ShellCommand | ShellCommand[];
     /**
      * Global data to define.
      */
@@ -429,6 +433,33 @@ export interface ScriptArguments {
     state: any;
 }
 
+/**
+ * A shell command value.
+ */
+export type ShellCommand = string | ShellCommandSettings;
+
+/**
+ * Settings of a shell command.
+ */
+export interface ShellCommandSettings extends ConditionalItem, WithOptionalName {
+    /**
+     * The command to execute.
+     */
+    readonly command: string;
+    /**
+     * The custom working directory to use.
+     */
+    readonly cwd?: string;
+    /**
+     * Ignore if execution fails or not.
+     */
+    readonly ignoreIfFail?: boolean;
+    /**
+     * Do not use placeholders in 'command' property.
+     */
+    readonly noPlaceHolders?: boolean;
+}
+
 /**
  * A startup command.
  */

src/helpers.ts

@@ -767,56 +767,6 @@ export function exists(path: string | Buffer) {
     });
 }
 
-/**
- * Filters items with 'if' code.
- * 
- * @param {TItem | TItem[]} items The items to filter.
- * @param {boolean} [throwOnError] Throw on error or not. 
- * @param {any} [errorResult] The custom result when an error occurred.
- * 
- * @return {TItem[]} The filtered items.
- */
-export function filterConditionalItems<TItem extends deploy_contracts.ConditionalItem = deploy_contracts.ConditionalItem>(
-    items: TItem | TItem[],
-    throwOnError = false,
-    errorResult: any = false,
-): TItem[] {
-    if (isNullOrUndefined(items)) {
-        return <any>items;
-    }
-
-    items = asArray(items, false);
-    throwOnError = toBooleanSafe(throwOnError);
-
-    return items.filter(i => {
-        try {
-            if (!isNullOrUndefined(i)) {
-                const CONDITION = toStringSafe(i.if);
-                if ('' !== CONDITION.trim()) {
-                    const CTX: deploy_code.CodeExecutionContext = {
-                        code: CONDITION,
-                        values: [],
-                    };
-
-                    return deploy_code.exec( CTX );
-                }
-            }
-
-            return true;
-        }
-        catch (e) {
-            deploy_log.CONSOLE
-                      .trace(e, 'helpers.filterConditionalItems()');
-
-            if (throwOnError) {
-                throw e;
-            }
-
-            return errorResult;
-        }
-    });
-}
-
 /**
  * Filters platform specific objects.
  * 

src/i18.ts

@@ -304,6 +304,9 @@ export interface Translation {
     sftp?: {
         privateKeyNotFound?: string;
     };
+    shell?: {
+        executing?: string;
+    };
     sql?: {
         notSupported?: string;
     };

src/lang/de.ts

@@ -298,6 +298,9 @@ export const translation: Translation = {
     sftp: {
         privateKeyNotFound: "Der private Schlüssel{0:trim,surround,leading_space} wurde nicht gefunden!",
     },
+    shell: {
+        executing: "Führe{0:trim,surround,leading_space} aus ...",
+    },
     sql: {
         notSupported: "Der SQL-Typ{0:trim,surround,leading_space} wird nicht unterstützt!",
     },

src/lang/en.ts

@@ -299,6 +299,9 @@ export const translation: Translation = {
     sftp: {
         privateKeyNotFound: "Private key file{0:trim,surround,leading_space} not found!",
     },
+    shell: {
+        executing: "Executing{0:trim,surround,leading_space} ...",
+    },
     sql: {
         notSupported: "SQL type{0:trim,surround,leading_space} is not supported!",
     },

src/values.ts

@@ -19,6 +19,7 @@ import * as deploy_code from './code';
 import * as deploy_contracts from './contracts';
 import * as deploy_helpers from './helpers';
 import * as deploy_log from './log';
+import * as Enumerable from 'node-enumerable';
 import * as OS from 'os';
 
 
@@ -375,18 +376,24 @@ export function loadFromItems(items: WithValueItems,
             let doesMatch: any;
 
             try {
-                const IF_CODE = deploy_helpers.toStringSafe(i.if);
-                if (!deploy_helpers.isEmptyString(IF_CODE)) {
-                    doesMatch = deploy_code.exec({
-                        code: IF_CODE,
-                        context: {
-                            i: i,
-                        },
-                        values: [].concat( getPredefinedValues() )
-                                  .concat( getEnvVars() )
-                                  .concat( o ),
-                    });
-                }
+                doesMatch = Enumerable.from( deploy_helpers.asArray(i.if) ).all((c) => {
+                    let res: any;
+
+                    const IF_CODE = deploy_helpers.toStringSafe(c);
+                    if (!deploy_helpers.isEmptyString(IF_CODE)) {
+                        res = deploy_code.exec({
+                            code: IF_CODE,
+                            context: {
+                                i: i,
+                            },
+                            values: [].concat( getPredefinedValues() )
+                                      .concat( getEnvVars() )
+                                      .concat( o ),
+                        });
+                    }
+
+                    return deploy_helpers.toBooleanSafe(res, true);
+                });
             }
             catch (e) {
                 deploy_log.CONSOLE