Support multiple tables in Format Selection

Author: darkriszty

CHANGELOG.md

@@ -6,9 +6,10 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/) and this p
 
 ## [Unreleased]
 
-## 3.0.1 - 2020-11-04
+## 3.1.0 - 2020-11-04
 ### Fixed
 - Issue #42: Don't alter selection for invalid range formatting attempt (does not impact CLI).
+- Issue #43: Handle `Format Selection` with multiple tables (does not impact CLI).
 
 ## 3.0.0 - 2020-10-06
 ### Added

README.md

@@ -48,8 +48,8 @@ Available features from docker:
 
 ## Extension Settings
 
-The extension is available for markdown language mode. It can either prettify a selected table (`Format Selection`) or the entire document (`Format Document`).
-A VSCode command called `Prettify markdown tables` is also available to format format the currently opened document. 
+The extension is available for markdown language mode. It can either prettify a selection (`Format Selection`) or the entire document (`Format Document`).
+A VSCode command called `Prettify markdown tables` is also available to format the currently opened document. 
 
 Configurable settings:
 - The maximum texth length of a selection/entire document to consider for formatting. Defaults to 1M chars. There is no limit when running from the command line.

package-lock.json

@@ -2,7 +2,7 @@
   "name": "markdown-table-prettify",
   "displayName": "Markdown Table Prettifier",
   "description": "Transforms markdown tables to be more readable.",
-  "version": "3.0.1",
+  "version": "3.1.0",
   "publisher": "darkriszty",
   "repository": {
     "type": "git",

package.json

@@ -22,36 +22,26 @@ import { AlignmentMarkerStrategy } from '../viewModelFactories/alignmentMarking'
 import { MultiTablePrettyfier } from '../prettyfiers/multiTablePrettyfier';
 import { SingleTablePrettyfier } from '../prettyfiers/singleTablePrettyfier';
 
-export function getDocumentRangePrettyfier(strict: boolean = false, sizeLimitCheker: ConfigSizeLimitChecker = null, loggers: ILogger[] = null) {
-    loggers = loggers || getLoggers();
-    sizeLimitCheker = sizeLimitCheker || getSizeLimitChecker(loggers);
-
-    return new TableDocumentRangePrettyfier(getSingleTablePrettyfier(loggers, sizeLimitCheker));
+export function getDocumentRangePrettyfier() {
+    return new TableDocumentRangePrettyfier(getMultiTablePrettyfier());
 }
 
-export function getDocumentPrettyfier(strict: boolean = true): vscode.DocumentFormattingEditProvider {
-    const loggers = getLoggers();
-    const sizeLimitCheker = getSizeLimitChecker(loggers);
-
-    return new TableDocumentPrettyfier(
-        new MultiTablePrettyfier(
-            new TableFinder(new TableValidator(new SelectionInterpreter(strict))),
-            getSingleTablePrettyfier(loggers, sizeLimitCheker),
-            sizeLimitCheker
-        )
-    );
+export function getDocumentPrettyfier(): vscode.DocumentFormattingEditProvider {
+    return new TableDocumentPrettyfier(getMultiTablePrettyfier());
 }
 
 export function getDocumentPrettyfierCommand(): TableDocumentPrettyfierCommand {
+    return new TableDocumentPrettyfierCommand(getMultiTablePrettyfier());
+}
+
+function getMultiTablePrettyfier(): MultiTablePrettyfier {
     const loggers = getLoggers();
     const sizeLimitCheker = getSizeLimitChecker(loggers);
 
-    return new TableDocumentPrettyfierCommand(
-        new MultiTablePrettyfier(
-            new TableFinder(new TableValidator(new SelectionInterpreter(true))),
-            getSingleTablePrettyfier(loggers, sizeLimitCheker),
-            sizeLimitCheker
-        )
+    return new MultiTablePrettyfier(
+        new TableFinder(new TableValidator(new SelectionInterpreter(true))),
+        getSingleTablePrettyfier(loggers, sizeLimitCheker),
+        sizeLimitCheker
     );
 }
 

src/extension/prettyfierFactory.ts

@@ -1,23 +1,20 @@
 import * as vscode from "vscode";
-import { Document } from "../models/doc/document";
-import { Range } from "../models/doc/range";
-import { SingleTablePrettyfier } from "../prettyfiers/singleTablePrettyfier";
+import { MultiTablePrettyfier } from "../prettyfiers/multiTablePrettyfier";
 
 export class TableDocumentRangePrettyfier implements vscode.DocumentRangeFormattingEditProvider {
 
     constructor(
-        private readonly _singleTablePrettyfier: SingleTablePrettyfier
+        private readonly _multiTablePrettyfier: MultiTablePrettyfier
     ) { }
 
     public provideDocumentRangeFormattingEdits(
         document: vscode.TextDocument, range: vscode.Range,
         options: vscode.FormattingOptions, token: vscode.CancellationToken) : vscode.TextEdit[]
     {
-        const formattedTable: string = this._singleTablePrettyfier.prettifyTable(
-            new Document(document.getText()), new Range(range.start.line, range.end.line)
-        );
-        return formattedTable != null
-            ? [ new vscode.TextEdit(range, formattedTable) ]
+        const formattedSelection: string = this._multiTablePrettyfier.formatTables(document.getText(range));
+
+        return formattedSelection != null
+            ? [new vscode.TextEdit(range, formattedSelection) ]
             : [ ];
     }
 }

src/extension/tableDocumentRangePrettyfier.ts

@@ -23,7 +23,7 @@ export class SingleTablePrettyfier {
     public prettifyTable(document: Document, range: Range) : string
     {
         let result: string = null;
-        let message: string = null;
+        let message: string = "";
         const selection: string = document.getText(range);
 
         try {
@@ -35,6 +35,7 @@ export class SingleTablePrettyfier {
                 result = this._writer.writeTable(tableVm);
             } else {
                 message = "Can't parse table from invalid text.";
+                result = selection;
             }
         } catch (ex) {
             this._loggers.forEach(_ => _.logError(ex));

src/prettyfiers/singleTablePrettyfier.ts

@@ -11,17 +11,17 @@ hello world
 |   long | -9,223,372,036,854,775,808 to 9,223,372,036,854,775,807 |    Signed 64-bit integer |
 |  ulong |                         0 to 18,446,744,073,709,551,615 |  Unsigned 64-bit integer |
 
-Type   | Range                                                       | Size
--------|-------------------------------------------------------------|-------------------------
-sbyte  | -128 `|to|` 127                                             | Signed 8-bit integer
-byte   | 0 `|to|` 255                                                | Unsigned 8-bit integer
-char   | U+0000 `|to|` U+ffff                                        | Unicode 16-bit character
-short  | -32,768 `|to|` 32,767                                       | Signed 16-bit integer
-ushort | 0 `|to|` 65,535                                             | Unsigned 16-bit integer
-int    | -2,147,483,648 `|to|` 2,147,483,647                         | Signed 32-bit integer
-uint   | 0 `|to|` 4,294,967,295                                      | Unsigned 32-bit integer
-long   | -9,223,372,036,854,775,808 `|to|` 9,223,372,036,854,775,807 | Signed 64-bit integer
-ulong  | 0 `|to|` 18,446,744,073,709,551,615                         | Unsigned 64-bit integer
+Type   | Range
+-------|------------------------------------------------------------
+sbyte  | -128 `|to|` 127
+byte   | 0 `|to|` 255
+char   | U+0000 `|to|` U+ffff
+short  | -32,768 `|to|` 32,767
+ushort | 0 `|to|` 65,535
+int    | -2,147,483,648 `|to|` 2,147,483,647
+uint   | 0 `|to|` 4,294,967,295
+long   | -9,223,372,036,854,775,808 `|to|` 9,223,372,036,854,775,807
+ulong  | 0 `|to|` 18,446,744,073,709,551,615
 Type   |   | Range                           | Size
 -------|---|---------------------------------|-------------------------
 sbyte  |   | -128 to 127                     | Signed 8-bit integer

test/systemTests/resources/formatMultipleDocuments-expected.md

@@ -11,17 +11,17 @@ hello world
 |long|-9,223,372,036,854,775,808 to 9,223,372,036,854,775,807|Signed 64-bit integer|
 |ulong|0 to 18,446,744,073,709,551,615|Unsigned 64-bit integer|
 
-Type | Range|	Size
--|-|-
-sbyte |	-128 `|to|` 127|	Signed 8-bit integer
-byte|	0 `|to|` 255|	Unsigned 8-bit integer
-char|	U+0000 `|to|` U+ffff|	Unicode 16-bit character
-short|	-32,768 `|to|` 32,767|	Signed 16-bit integer
-ushort|	0 `|to|` 65,535|	Unsigned 16-bit integer
-int|	-2,147,483,648 `|to|` 2,147,483,647|	Signed 32-bit integer
-uint|	0 `|to|` 4,294,967,295|	Unsigned 32-bit integer
-long|	-9,223,372,036,854,775,808 `|to|` 9,223,372,036,854,775,807|	Signed 64-bit integer
-ulong|	0 `|to|` 18,446,744,073,709,551,615|	Unsigned 64-bit integer
+Type | Range|
+-|-|
+sbyte |	-128 `|to|` 127|
+byte|	0 `|to|` 255|
+char|	U+0000 `|to|` U+ffff|
+short|	-32,768 `|to|` 32,767|
+ushort|	0 `|to|` 65,535|
+int|	-2,147,483,648 `|to|` 2,147,483,647|
+uint|	0 `|to|` 4,294,967,295|
+long|	-9,223,372,036,854,775,808 `|to|` 9,223,372,036,854,775,807|
+ulong|	0 `|to|` 18,446,744,073,709,551,615|
 Type || Range|	Size
 -|-|-|-
 sbyte ||	-128 to 127|	Signed 8-bit integer

test/systemTests/resources/formatMultipleDocuments-input.md

@@ -2,29 +2,29 @@ import * as assert from "assert";
 import { IMock, Mock, It, Times } from "typemoq";
 import { TableDocumentRangePrettyfier } from "../../../src/extension/tableDocumentRangePrettyfier";
 import { MarkdownTextDocumentStub } from "../../stubs/markdownTextDocumentStub";
-import { SingleTablePrettyfier } from "../../../src/prettyfiers/singleTablePrettyfier";
+import { MultiTablePrettyfier } from "../../../src/prettyfiers/multiTablePrettyfier";
 
 suite("TableDocumentRangePrettyfier tests", () => {
 
-    let _singleTablePrettyfier: IMock<SingleTablePrettyfier>;
+    let _multiTablePrettyfier: IMock<MultiTablePrettyfier>;
 
     setup(() => {
-        _singleTablePrettyfier = Mock.ofType<SingleTablePrettyfier>();
+        _multiTablePrettyfier = Mock.ofType<MultiTablePrettyfier>();
     });
 
-    test("provideDocumentRangeFormattingEdits() calls table validator", () => {
+    test("provideDocumentRangeFormattingEdits() uses MultiTablePrettyfier", () => {
         const sut = createSut();
         const input = Array(5).fill("hello world").join("\n");
         const expectedResult = Array(5).fill("expected result").join("\n");
         const document = new MarkdownTextDocumentStub(input);
         const range = document.getFullRange();
-        _singleTablePrettyfier.setup(_ => _.prettifyTable(It.isAny(), It.isAny())).returns(() => expectedResult);
+        _multiTablePrettyfier.setup(_ => _.formatTables(It.isAny())).returns(() => expectedResult);
 
         const result = sut.provideDocumentRangeFormattingEdits(document, range, null, null);
 
         assert.strictEqual(result.length, 1);
         assert.strictEqual(result[0].range, range);
-        _singleTablePrettyfier.verify(_ => _.prettifyTable(It.isAny(), It.isAny()), Times.once());
+        _multiTablePrettyfier.verify(_ => _.formatTables(It.isAny()), Times.once());
     });
 
     test("provideDocumentRangeFormattingEdits() invalid table selection doesn't alter the selected text", () => {
@@ -33,14 +33,14 @@ suite("TableDocumentRangePrettyfier tests", () => {
         const expectedResult = null;
         const document = new MarkdownTextDocumentStub(input);
         const range = document.getFullRange();
-        _singleTablePrettyfier.setup(_ => _.prettifyTable(It.isAny(), It.isAny())).returns(() => expectedResult);
+        _multiTablePrettyfier.setup(_ => _.formatTables(It.isAny())).returns(() => expectedResult);
 
         const result = sut.provideDocumentRangeFormattingEdits(document, range, null, null);
 
         assert.strictEqual(result.length, 0);
     });
 
     function createSut(): TableDocumentRangePrettyfier {
-        return new TableDocumentRangePrettyfier(_singleTablePrettyfier.object);
+        return new TableDocumentRangePrettyfier(_multiTablePrettyfier.object);
     }
 });