Don't show VS code popups for whole document formatting.

It is not possible to differentiate between format selection on the entire file and format document, therefore the same applies to the format selection when the entire file contents is selected.

Author: darkriszty

src/extension/tableRangePrettyfier.ts

@@ -20,6 +20,8 @@ export class TableRangePrettyfier implements vscode.DocumentRangeFormattingEditP
         let message: string = null;
         let table: ITable = null;
 
+        const silent = this._isWholeDocumentFormatting(document, range);
+
         try {
             table = this._tableFactory.create(selection);
             if (table == null) {
@@ -29,13 +31,26 @@ export class TableRangePrettyfier implements vscode.DocumentRangeFormattingEditP
                 result.push(new vscode.TextEdit(range, formattedTable));
             }
         } catch (ex) {
-            this._logger.logError(ex);
-            console.error("Error: \n\n" + ex);
+            if (!silent)
+                this._logger.logError(ex);
+            console.error(`Error: ${ex}`);
         }
 
-        if (!!message)
+        if (!!message && !silent)
             this._logger.logInfo(message);
 
         return result;
     }
+
+    private _isWholeDocumentFormatting(document: vscode.TextDocument, range: vscode.Range): boolean {
+        if (document.lineCount < 1)
+            return true;
+
+        const zeroPosition = new vscode.Position(0, 0);
+        const documentEndPosition = document.lineAt(document.lineCount - 1).range.end;
+        if (range.start.isEqual(zeroPosition) && range.end.isEqual(documentEndPosition))
+            return true;
+
+        return false;
+    }
 }

test/extension/tableRangePrettyfier.test.ts

@@ -21,16 +21,88 @@ suite("TableRangePrettyfier tests", () => {
         assert.equal(textEdits.length, 0);
     });
 
-    test("provideDocumentRangeFormattingEdits() table factory called with invalid table then logInfo() called", () => {
-        const tableText = `hello | world
-                            -|-
-                            new | line`;
+    test("provideDocumentRangeFormattingEdits() invalid table with whole document being formatted => logInfo() not called", () => {
+        const tableText = `row1
+                           row2
+                           row3`;
         const mockTableFactory: typeMock.IMock<ITableFactory> = typeMock.Mock.ofType<ITableFactory>();
         const mockLogger: typeMock.IMock<ILogger> = typeMock.Mock.ofType<ILogger>();
         const trp = new TableRangePrettyfier(mockTableFactory.object, mockLogger.object);
 
         const textDoc = new MockMarkdownTextDocument(tableText);
-        const range = textDoc.getRangeForLines(1, 3);
+        const range = textDoc.getRangeForLines(0, 3);
+        mockTableFactory
+            .setup(t => t.create(textDoc.getText(range)))
+            .returns(() => null)
+            .verifiable(Times.once());
+        mockLogger
+            .setup(t => t.logInfo(It.isAnyString()))
+            .verifiable(Times.never());
+
+        const textEdits = trp.provideDocumentRangeFormattingEdits(textDoc, range, null, null);
+
+        mockTableFactory.verifyAll();
+        mockLogger.verifyAll();
+    });
+
+    test("provideDocumentRangeFormattingEdits() error thrown with whole document being formatted => logError() not called", () => {
+        const tableText = `row1
+                           row2
+                           row3`;
+        const mockTableFactory: typeMock.IMock<ITableFactory> = typeMock.Mock.ofType<ITableFactory>();
+        const mockLogger: typeMock.IMock<ILogger> = typeMock.Mock.ofType<ILogger>();
+        const trp = new TableRangePrettyfier(mockTableFactory.object, mockLogger.object);
+
+        const textDoc = new MockMarkdownTextDocument(tableText);
+        const range = textDoc.getRangeForLines(0, 3);
+        mockTableFactory
+            .setup(t => t.create(textDoc.getText(range)))
+            .throws(new Error("expected error"))
+            .verifiable(Times.once());
+        mockLogger
+            .setup(t => t.logError(It.isAny()))
+            .verifiable(Times.never());
+
+        const textEdits = trp.provideDocumentRangeFormattingEdits(textDoc, range, null, null);
+
+        mockTableFactory.verifyAll();
+        mockLogger.verifyAll();
+    });
+
+    test("provideDocumentRangeFormattingEdits() error thrown without whole document being formatted => logError() called", () => {
+        const tableText = `row1
+                           row2
+                           row3`;
+        const mockTableFactory: typeMock.IMock<ITableFactory> = typeMock.Mock.ofType<ITableFactory>();
+        const mockLogger: typeMock.IMock<ILogger> = typeMock.Mock.ofType<ILogger>();
+        const trp = new TableRangePrettyfier(mockTableFactory.object, mockLogger.object);
+
+        const textDoc = new MockMarkdownTextDocument(tableText);
+        const range = textDoc.getRangeForLines(2, 3);
+        mockTableFactory
+            .setup(t => t.create(textDoc.getText(range)))
+            .throws(new Error("expected error"))
+            .verifiable(Times.once());
+        mockLogger
+            .setup(t => t.logError(It.isAny()))
+            .verifiable(Times.once());
+
+        const textEdits = trp.provideDocumentRangeFormattingEdits(textDoc, range, null, null);
+
+        mockTableFactory.verifyAll();
+        mockLogger.verifyAll();
+    });
+
+    test("provideDocumentRangeFormattingEdits() invalid table with not the whole document being formatted => logInfo() called", () => {
+        const tableText = `row1
+                           row2
+                           row3`;
+        const mockTableFactory: typeMock.IMock<ITableFactory> = typeMock.Mock.ofType<ITableFactory>();
+        const mockLogger: typeMock.IMock<ILogger> = typeMock.Mock.ofType<ILogger>();
+        const trp = new TableRangePrettyfier(mockTableFactory.object, mockLogger.object);
+
+        const textDoc = new MockMarkdownTextDocument(tableText);
+        const range = textDoc.getRangeForLines(2, 3);
         mockTableFactory
             .setup(t => t.create(textDoc.getText(range)))
             .returns(() => null)
@@ -46,9 +118,9 @@ suite("TableRangePrettyfier tests", () => {
     });
 
     test("provideDocumentRangeFormattingEdits() table prettyPrint() called and logInfo() not called", () => {
-        const tableText = `hello | world
-                            -|-
-                            new | line`;
+        const tableText = `row1
+                           row2
+                           row3`;
         const mockTableFactory: typeMock.IMock<ITableFactory> = typeMock.Mock.ofType<ITableFactory>();
         const mockLogger: typeMock.IMock<ILogger> = typeMock.Mock.ofType<ILogger>();
         const mockTable: typeMock.IMock<ITable> = typeMock.Mock.ofType<ITable>();
@@ -76,9 +148,9 @@ suite("TableRangePrettyfier tests", () => {
     });
 
     test("provideDocumentRangeFormattingEdits() the result of the prettyPrint() is returned", () => {
-        const tableText = `hello | world
-                            -|-
-                            new | line`;
+        const tableText = `row1
+                           row2
+                           row3`;
         const mockTableFactory: typeMock.IMock<ITableFactory> = typeMock.Mock.ofType<ITableFactory>();
         const mockLogger: typeMock.IMock<ILogger> = typeMock.Mock.ofType<ILogger>();
         const mockTable: typeMock.IMock<ITable> = typeMock.Mock.ofType<ITable>();