Ensure that document formatting also works for tables with alignments

Author: darkriszty

src/modelFactory/selectionInterpreter.ts

@@ -14,7 +14,7 @@ export class SelectionInterpreter {
         return this.allRows(selection).filter((v, i) => i == 1)[0];
     }
 
-    private splitLine(line: string): string[] {
+    public splitLine(line: string): string[] {
         if (line == null || line.length == 0) return [];
 
         let result:string[] = [],

src/modelFactory/tableValidator.ts

@@ -17,7 +17,13 @@ export class TableValidator {
         return sizeValid && this.hasValidSeparators(this._selectionInterpreter.separator(selection));
     }
 
-    private hasValidSeparators(separator: string[]): boolean {
+    public lineIsValidSeparator(separatorLine: string): boolean {
+        return this.hasValidSeparators(
+            this._selectionInterpreter.splitLine(separatorLine)
+        );
+    }
+
+    public hasValidSeparators(separator: string[]): boolean {
         if (!separator || separator.length < 1 || !separator[1])
             return false;
 

src/tableFinding/tableFinder.ts

@@ -3,7 +3,6 @@ import { EOL } from "os";
 import { TableValidator } from "../modelFactory/tableValidator";
 
 export class TableFinder {
-    private readonly _separatorMarker = "-|-";
     constructor(
         private readonly _tableValidator: TableValidator
     ) { }
@@ -28,7 +27,7 @@ export class TableFinder {
         // look for the separator row, assume table starts 1 row before & ends when invalid
         let rowIndex = startAtRow;
         while (rowIndex < rows.length) {
-            let table = rows[rowIndex].indexOf(this._separatorMarker) >= 0
+            let table = this._tableValidator.lineIsValidSeparator(rows[rowIndex])
                 ? this.getTableFromSeparatorIndex(rows, rowIndex)
                 : null;
             if (table != null) return table;

test/systemTests/resources/formatMultipleDocuments-expected.md

@@ -0,0 +1,33 @@
+hello world
+|   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                                                       | 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                           | 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

test/systemTests/resources/formatMultipleDocuments-input.md

@@ -0,0 +1,33 @@
+hello world
+|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|	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|	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

test/unitTests/tableFinding/tableFinder.test.ts

@@ -99,6 +99,21 @@ suite("TableFinder tests", () => {
         assert.deepStrictEqual(tableRanges[1], new vscode.Range(9, 0, 12, 27));
     });
 
+    test("getTables() for table with alignments the expected range is returned", () => {
+        let sut = getSut();
+        let document = makeDocument(`no table on first line
+            |Primitive Type|Size(bit)|Wrapper
+            |-:|-|-
+            |short|16|Short
+            |int|32|Integer
+            no table on last line`);
+
+        let tableRanges = sut.getTables(document);
+
+        assert.equal(tableRanges.length, 1);
+        assert.deepStrictEqual(tableRanges[0], new vscode.Range(1, 0, 4, 27));
+    });
+
     function getSut() {
         return new TableFinder(new TableValidator(new SelectionInterpreter(true)));
     }