(#69) add format on save configuration

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## All notable changes to the "markdowntable" extension will be documented in this file
 
+### 0.12.0
+
+- [Add] Configuration to format on save
+
 ### 0.11.0
 
 - [Change] VSCode engine to 1.80.0

README.md

@@ -106,6 +106,7 @@ Key binding to `Shift`+`Tab`.
 | markdowntable.showMenu.alignRight  | Show command in context menu, "Align to Right"             | boolean | true    |
 | markdowntable.showMenu.moveLeft    | Show command in context menu, "Move to Left"               | boolean | true    |
 | markdowntable.showMenu.moveRight   | Show command in context menu, "Move to Right"              | boolean | true    |
+| markdowntable.formatOnSave         | Format all tables on save                                  | boolean | false   |
 
 ## 4. Tips
 

package.json

@@ -213,6 +213,11 @@
                     "type": "boolean",
                     "default": true,
                     "description": "Show command in context menu: \"Move to Right\"."
+                },
+                "markdowntable.formatOnSave": {
+                    "type": "boolean",
+                    "default": false,
+                    "description": "Format all tables on save."
                 }
             }
         }

src/contextServices/textEditorContextServiceIsSupportedLanguage.ts

@@ -1,5 +1,6 @@
 import { ExtensionContext, Selection, TextDocument, window, StatusBarItem, StatusBarAlignment, TextEditor, TextEditorSelectionChangeEvent } from 'vscode';
 import { ContextService } from "./contextService";
+import { SupportLanguage } from '../definitions/supportLanguage';
 
 export class TextEditorContextServiceIsSupportedLanguage extends ContextService {
     private statusBarItem: StatusBarItem | undefined;
@@ -39,7 +40,7 @@ export class TextEditorContextServiceIsSupportedLanguage extends ContextService
 
     private updateContextState(editor: TextEditor | undefined) {
         const document = editor?.document;
-        var isSupported = this.isSupportedLanguage(document);
+        var isSupported = SupportLanguage.isSupportedLanguage(document);
 
         if (isSupported) {
             this.setState(true);
@@ -64,11 +65,4 @@ export class TextEditorContextServiceIsSupportedLanguage extends ContextService
             }
         }
     }
-
-    private isSupportedLanguage(document: TextDocument | undefined): boolean {
-        if(!document || document.languageId === null) {
-            return false;
-        }
-        return (document.languageId === 'markdown' || document.languageId === 'mdx' || document.languageId === 'quarto');
-    }
 }

src/definitions/supportLanguage.ts

@@ -0,0 +1,10 @@
+import { TextDocument } from 'vscode';
+
+export class SupportLanguage {
+    public static isSupportedLanguage(document: TextDocument | undefined): boolean {
+        if (!document || document.languageId === null) {
+            return false;
+        }
+        return (document.languageId === 'markdown' || document.languageId === 'mdx' || document.languageId === 'quarto');
+    }
+}

src/doOnSaveServices/formatOnSaveService.ts

@@ -0,0 +1,29 @@
+import { ExtensionContext, window, Disposable, TextDocumentWillSaveEvent, commands, workspace } from 'vscode';
+import { SupportLanguage } from '../definitions/supportLanguage';
+
+export class FormatOnSaveService implements Disposable {
+
+    public constructor() { }
+
+    public activate(context: ExtensionContext) {
+        context.subscriptions.push(
+            workspace.onWillSaveTextDocument((event) => this.onWillSaveTextDocument(event))
+        );
+    }
+
+    public dispose(): void { }
+
+    private onWillSaveTextDocument(event: TextDocumentWillSaveEvent): void {
+        let isSupportedLanguage = SupportLanguage.isSupportedLanguage(event.document);
+        if (!isSupportedLanguage) {
+            return;
+        }
+
+        let formatOnSave = <boolean>workspace.getConfiguration("markdowntable").get("formatOnSave");
+        if (!formatOnSave) {
+            return;
+        }
+
+        commands.executeCommand("markdowntable.format");
+    }
+}

src/extension.ts

@@ -3,6 +3,7 @@
 import * as vscode from 'vscode';
 import * as commands from './commands';
 import { ContextServiceManager } from "./contextServices/contextServiceManager";
+import { FormatOnSaveService } from './doOnSaveServices/formatOnSaveService';
 
 
 // this method is called when your extension is activated
@@ -25,6 +26,13 @@ export function activate(context: vscode.ExtensionContext) {
     );
     // start custom context key services
     contextServiceManager.activate(context);
+
+    // subscribe and activate formatOnSaveService
+    const formatOnSaveService = new FormatOnSaveService();
+    context.subscriptions.push(
+        formatOnSaveService
+    );
+    formatOnSaveService.activate(context);
 
     // subscribe command handlers
     context.subscriptions.push(

src/test/sample/demo.txt

@@ -0,0 +1,7 @@
+# title
+
+| column A | column B | column C |
+| :------- | :------- | :------- |
+| data     | data    | data     |
+| data     |       |          |
+|          |       |          |