feat: add option to specify initial rows, make add methods chainable,…

… export renderSimpleTable (#396)

README.md

@@ -136,6 +136,7 @@ new Table({
     { name: 'column2', alignment: 'right', maxLen: 30 }, // lines bigger than this will be splitted in multiple lines
     { name: 'column3', title: 'Column3' }, // Title is what will be shown while printing, by default title = name
   ],
+  rows: [{ column1: 'row1' }, { column2: 'row2' }, { column3: 'row3' }],
   sort: (row1, row2) => row2.column1 - row1.column1, // sorting order of rows (optional), this is normal js sort function for Array.sort
   filter: (row) => row.column1 < 3, // filtering rows (optional)
   enabledColumns: ['column1'], // array of columns that you want to see, all other will be ignored (optional)

index.ts

@@ -1,6 +1,9 @@
 import Table from './src/console-table-printer';
-import { printSimpleTable as printTable } from './src/internalTable/internal-table-printer';
+import {
+  printSimpleTable as printTable,
+  renderSimpleTable as renderTable,
+} from './src/internalTable/internal-table-printer';
 
 import { COLOR, ALIGNMENT } from './src/models/external-table';
 
-export { Table, printTable, COLOR, ALIGNMENT };
+export { Table, printTable, renderTable, COLOR, ALIGNMENT };

src/console-table-printer.ts

@@ -15,21 +15,25 @@ export default class Table {
 
   addColumn(column: string) {
     this.table.addColumn(column);
+    return this;
   }
 
   addColumns(columns: string[]) {
     this.table.addColumns(columns);
+    return this;
   }
 
   addRow(text: Dictionary, rowOptions?: RowOptionsRaw) {
     this.table.addRow(text, convertRawRowOptionsToStandard(rowOptions));
+    return this;
   }
 
   addRows(toBeInsertedRows: any, rowOptions?: RowOptionsRaw) {
     this.table.addRows(
       toBeInsertedRows,
       convertRawRowOptionsToStandard(rowOptions)
     );
+    return this;
   }
 
   printTable() {

src/internalTable/internal-table.ts

@@ -65,6 +65,10 @@ class TableInternal {
     this.columns =
       options?.columns?.map(rawColumnToInternalColumn) || this.columns;
     this.rowSeparator = options?.rowSeparator || this.rowSeparator;
+
+    if (options.rows !== undefined) {
+      this.addRows(options.rows);
+    }
   }
 
   constructor(options?: ComplexOptions | string[]) {

src/models/external-table.ts

@@ -1,4 +1,4 @@
-import { ALIGNMENT, COLOR } from './common';
+import { ALIGNMENT, COLOR, Dictionary } from './common';
 import { TableStyleDetails } from './internal-table';
 
 export { ALIGNMENT, COLOR };
@@ -24,6 +24,7 @@ export interface ComplexOptions {
   style?: TableStyleDetails;
   title?: string;
   columns?: ColumnOptionsRaw[];
+  rows?: Dictionary[];
   sort?: RowSortFunction;
   filter?: RowFilterFunction;
   enabledColumns?: string[];

test/__snapshots__/types.test.ts.snap

@@ -7,3 +7,12 @@ exports[`Testing column alignment all kind of alignments are working 1`] = `
 │ 2                    │ This row is blue │       10.212       │
 └──────────────────────┴──────────────────┴────────────────────┘"
 `;
+
+exports[`Testing column alignment should allow chaining add methods 1`] = `
+"┌─────┬─────┐
+│ foo │ bar │
+├─────┼─────┤
+│   1 │     │
+│     │   2 │
+└─────┴─────┘"
+`;

test/general.test.ts

@@ -0,0 +1,14 @@
+import { Table } from '../index';
+
+describe('General tests', () => {
+  it('should yield the same state when adding rows during instantation than with method', () => {
+    const rows = [{ foo: '1', bar: '2' }];
+
+    const table1 = new Table();
+    table1.addRows(rows);
+
+    const table2 = new Table({ rows });
+
+    expect(table1.table).toStrictEqual(table2.table);
+  });
+});

test/types.test.ts

@@ -38,4 +38,15 @@ describe('Testing column alignment', () => {
     p.printTable();
     expect(p.render()).toMatchSnapshot();
   });
+
+  it('should allow chaining add methods', () => {
+    const p = new Table()
+      .addColumn('foo')
+      .addColumns(['bar'])
+      .addRow({ foo: '1' })
+      .addRows([{ bar: '2' }]);
+
+    p.printTable();
+    expect(p.render()).toMatchSnapshot();
+  });
 });