Merge pull request #15 from SimplrJS/dev

Version `1.0.5`.

Author: DeividasBakanas

__tests__/__snapshots__/markdown-generator.test.ts.snap

@@ -275,6 +275,53 @@ describe("Table", () => {
         expect(result).toMatchSnapshot();
     });
 
+    it("Table with a single column filled.", () => {
+        const headers = ["Name", "Constraint type", "Default type"];
+        const rows = [
+            ["TValue", "", ""]
+        ];
+
+        const result = MarkdownGenerator.Table(headers, rows, { removeColumnIfEmpty: true });
+        expect(result).toMatchSnapshot();
+    });
+
+    it("Table with an empty column in the middle.", () => {
+        const headers = ["Name", "Constraint type", "Default type"];
+        const rows = [
+            ["TValue", "", "string"],
+            ["T", "", "string"],
+            ["TKey ", "", "string"],
+        ];
+
+        const result = MarkdownGenerator.Table(headers, rows, { removeColumnIfEmpty: true });
+        expect(result).toMatchSnapshot();
+    });
+
+    it("Table with empty rows", () => {
+        const headers = ["Name", "Constraint type", "Default type", "InitialValue"];
+        const rows = [
+            ["TValue", "", "", "{}"],
+            ["", "", "", ""],
+            ["TKey", "", "", "{}"],
+            ["", "", "", ""]
+        ];
+
+        const result = MarkdownGenerator.Table(headers, rows, { removeColumnIfEmpty: true, removeRowIfEmpty: true });
+        expect(result).toMatchSnapshot();
+    });
+
+    it("Table with rows that has a single cell filled", () => {
+        const headers = ["Name", "Constraint type", "Default type", "InitialValue"];
+        const rows = [
+            ["TValue", "", "", ""],
+            ["", "Object", "", ""],
+            ["", "", "Object", ""],
+            ["", "", "", "{}"]
+        ];
+
+        const result = MarkdownGenerator.Table(headers, rows, { removeColumnIfEmpty: true });
+    });
+
     it("Simple example with mixed alignments", () => {
         const headers: Array<TableHeader | string> = [
             {

__tests__/markdown-generator.test.ts

@@ -1,6 +1,6 @@
 {
   "name": "@simplrjs/markdown",
-  "version": "1.0.4",
+  "version": "1.0.5",
   "description": "Markdown generator",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",

package.json

@@ -14,6 +14,7 @@ export type UnorderedListSymbols = "*" | "+" | "-";
 
 export interface TableOptions {
     removeColumnIfEmpty?: boolean;
+    removeRowIfEmpty?: boolean;
 }
 
 export interface TableHeader {

src/contracts.ts

@@ -11,6 +11,7 @@ export namespace TableGenerator {
     export function RenderTable(headers: Array<string | TableHeader>, content: string[][], options?: TableOptions): string[] {
         const columnsWidths: number[] = [];
         const removeColumnIfEmpty = options != null && options.removeColumnIfEmpty;
+        const removeRowIfEmpty = options != null && options.removeRowIfEmpty;
 
         let filledRows = content.map(row => {
             if (row.length < headers.length) {
@@ -20,28 +21,35 @@ export namespace TableGenerator {
             }
         });
 
-        const finalHeaders = headers
-            .map((header, headerIndex) => {
-                const rows = filledRows.map(x => x[headerIndex]);
-                columnsWidths[headerIndex] = GetMaxColumnWidth(GetHeaderText(header), rows, removeColumnIfEmpty);
+        // Removing empty rows if option `removeRowIfEmpty` enabled.
+        if (removeRowIfEmpty) {
+            filledRows = filledRows.filter(row => !row.every(cell => cell.length === 0));
+        }
 
-                if (removeColumnIfEmpty && columnsWidths[headerIndex] === 0) {
-                    filledRows = filledRows
-                        .filter(x => x[headerIndex] != null)
-                        .map(x => x.splice(0, headerIndex));
+        // Indexes of empty columns, that should be removed.
+        const columnsToRemove: number[] = [];
 
-                    return null;
-                }
+        // Filling columns widths.
+        headers.forEach((header, index) => {
+            // Getting rows of a single column
+            const rows = filledRows.map(x => x[index]);
+            columnsWidths[index] = GetMaxColumnWidth(GetHeaderText(header), rows, removeColumnIfEmpty);
+
+            if (removeColumnIfEmpty && columnsWidths[index] === 0) {
+                columnsToRemove.push(index);
+            }
+        });
 
-                return header;
-            })
-            .filter(x => x != null) as Array<string | TableHeader>;
+        // Removing unnecessary columns.
+        const finalHeaders = headers.filter((x, index) => columnsToRemove.indexOf(index) === -1);
+        const finalRows = filledRows.map(row => row.filter((x, index) => columnsToRemove.indexOf(index) === -1));
+        const finalColumnsWidths = columnsWidths.filter((x, index) => columnsToRemove.indexOf(index) === -1);
 
         const lines = [
             // Header
-            ...RenderTableHeader(finalHeaders, columnsWidths),
+            ...RenderTableHeader(finalHeaders, finalColumnsWidths),
             // Content
-            ...RenderTableContents(filledRows, columnsWidths)
+            ...RenderTableContents(finalRows, finalColumnsWidths)
         ];
 
         return lines;