added onWillSave setting

Author: mkloubert

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Change Log (vs-script-commands)
 
+# 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
+
 ## 2.0.1 (April 11th, 2017; improved execution of scripts)
 
 * the behavior of executing scripts has been improved ... if you come from version 1.x, have a look at the [wiki](https://github.com/mkloubert/vs-script-commands/wiki#since-version-2x-) first

README.md

@@ -199,14 +199,15 @@ A command entry provides the following properties:
 | `onNewFile` | Is invoked when a file has been created. Default `(false)` |
 | `onSaved` | Is invoked when a file has been saved. Default `(false)` |
 | `onStartup` | Executes the command on startup or not. Default `(false)` |
+| `onWillSave` | Is invoked when a file is going to be saved. Default `(false)` |
 | `options` | Additional data for the execution. |
 | `script` | The path to the script to execute. IF YOU USE A RELATIVE PATH: The path is relative to your workspace. |
 | `sortOrder` | The sort order (for the GUI). Default `0` |
 | `suppressArguments` | Supress own arguments of the extension or not. Default `(false)` |
 
 ### Key bindinds [[↑](#how-to-use-)]
 
-After defining one or more commands, you can open your [keybindings.json](https://code.visualstudio.com/docs/customization/keybindings#_customizing-shortcuts) file and set shortcuts for them, by selecting `File > Preferences > Keyboard Shortcuts` (`Code > Preferences > Keyboard Shortcuts` on Mac) in your editor:
+After defining one or more commands, you can open your [keybindings.json](https://code.visualstudio.com/docs/getstarted/keybindings#_advanced-customization) file and set shortcuts for them, by selecting `File > Preferences > Keyboard Shortcuts` (`Code > Preferences > Keyboard Shortcuts` on Mac) in your editor:
 
 ![Demo Key bindinds](https://raw.githubusercontent.com/mkloubert/vs-script-commands/master/img/demo1.gif)
 

package.json

@@ -2,10 +2,10 @@
   "name": "vs-script-commands",
   "displayName": "Script Commands",
   "description": "Adds additional commands to Visual Studio Code that uses scripts (JavaScript) for execution.",
-  "version": "2.1.2",
+  "version": "3.0.0",
   "publisher": "mkloubert",
   "engines": {
-    "vscode": "^1.5.0"
+    "vscode": "^1.6.0"
   },
   "license": "MIT",
   "categories": [
@@ -171,6 +171,11 @@
                       "description": "Executes the command on startup or not.",
                       "default": false
                     },
+                    "onWillSave": {
+                      "type": "boolean",
+                      "description": "Is invoked when a file is going to be saved.",
+                      "default": false
+                    },
                     "options": {
                       "description": "Additional data for the execution."
                     },
@@ -324,6 +329,11 @@
                         "description": "Executes the command on startup or not.",
                         "default": false
                       },
+                      "onWillSave": {
+                        "type": "boolean",
+                        "description": "Is invoked when a file is going to be saved.",
+                        "default": false
+                      },
                       "options": {
                         "description": "Additional data for the execution."
                       },

src/contracts.ts

@@ -138,6 +138,10 @@ export enum FileChangeType {
      * File has been changed in text editor.
      */
     EditorChanged = 6,
+    /**
+     * File is going to be saved.
+     */
+    WillSave = 7,
 }
 
 /**
@@ -272,6 +276,10 @@ export interface ScriptCommand {
      * Executes the command on startup or not.
      */
     onStartup?: boolean;
+    /**
+     * Is invoked when a file is being to be saved.
+     */
+    onWillSave?: boolean;
     /**
      * Additional data for the execution.
      */

src/controller.ts

@@ -550,6 +550,10 @@ export class ScriptCommandController extends Events.EventEmitter implements vsco
                 case sc_contracts.FileChangeType.EditorChanged:
                     doesMatch = sc_helpers.toBooleanSafe(c.onEditorChanged);
                     break;
+
+                case sc_contracts.FileChangeType.WillSave:
+                    doesMatch = sc_helpers.toBooleanSafe(c.onWillSave);
+                    break;
             }
 
             return doesMatch;
@@ -584,6 +588,16 @@ export class ScriptCommandController extends Events.EventEmitter implements vsco
         });;           
     }
 
+    /**
+     * Is invoked when a document is being to be saved.
+     * 
+     * @param {vscode.TextDocumentWillSaveEvent} e The event data.
+     */
+    public onWillSaveTextDocument(e: vscode.TextDocumentWillSaveEvent) {
+        this.onFileChange(e.document.uri, sc_contracts.FileChangeType.WillSave,
+                          () => [ e ]);
+    }
+
     /**
      * Gets the global output channel.
      */

src/extension.ts

@@ -121,6 +121,11 @@ export function activate(context: vscode.ExtensionContext) {
     // notifiy on document has been saved
     context.subscriptions.push(vscode.workspace.onDidSaveTextDocument(controller.onDidSaveTextDocument,
                                                                       controller));
+
+    // notifiy on document is going to be saved
+    context.subscriptions.push(vscode.workspace.onWillSaveTextDocument(controller.onWillSaveTextDocument,
+                                                                       controller));
+                                                                      
     // notfiy open text editor
     context.subscriptions.push(vscode.workspace.onDidOpenTextDocument(controller.onDidOpenTextDocument,
                                                                       controller));