console-table-printer 2.9.0 → 2.11.1

package/README.md

@@ -45,10 +45,10 @@ const testCases = [
 printTable(testCases);
 ```
 
-Output:
-
 ![Screenshot](https://cdn.jsdelivr.net/gh/ayonious/console-table-printer@master/static-resources/quick-print.png)
 
+## 🚨🚨Announcement🚨🚨 Official Documentation is moved [Here](https://console-table.netlify.app/docs)
+
 You can also create a Table instance and print it:
 
 ```javascript
@@ -89,14 +89,20 @@ You can also put properties based on columns (color/alignment/title)
 ```javascript
 const p = new Table({
   columns: [
-    { name: 'index', alignment: 'left', color: 'blue' }, //with alignment and color
+    { name: 'index', alignment: 'left', color: 'blue' }, // with alignment and color
     { name: 'text', alignment: 'right' },
     { name: 'is_priority_today', title: 'Is This Priority?' }, // with Title as separate Text
   ],
+  colorMap: {
+    custom_green: '\x1b[32m', // define customized color
+  },
 });
 
 p.addRow({ index: 1, text: 'red wine', value: 10.212 }, { color: 'green' });
-p.addRow({ index: 2, text: 'green gemuse', value: 20.0 });
+p.addRow(
+  { index: 2, text: 'green gemuse', value: 20.0 },
+  { color: 'custom_green' } // your green
+);
 p.addRow(
   { index: 3, text: 'gelb bananen', value: 100, is_priority_today: 'Y' },
   { color: 'yellow' }
@@ -108,7 +114,7 @@ p.addRow(
 p.printTable();
 ```
 
-![Screenshot](https://cdn.jsdelivr.net/gh/ayonious/console-table-printer@master/static-resources/screenshot-column-props.png)
+![Screenshot](https://cdn.jsdelivr.net/gh/ayonious/console-table-printer@master/static-resources/screenshot-column-props-2.png)
 
 ## CLI
 
@@ -136,16 +142,24 @@ 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)
   disabledColumns: ['column2'], // array of columns that you DONT want to see, these will always be hidden
+  colorMap: {
+    custom_green: '\x1b[32m', // define customized color
+  },
+  charLength: {
+    '👋': 2,
+    '😅': 2,
+  }, // custom len of chars in console
 });
 ```
 
 ### Functions
 
-- `addRow(rowObjet, options)` adding single row.
+- `addRow(rowObjet, options)` adding single row. This can be chained
 - `addRows(rowObjects, options)` adding multiple rows. array of row object. This case options will be applied to all the objects in row
 - `addColumn(columnObject)` adding single column
 - `addColumns(columnObjects)` adding multiple columns

package/dist/index.d.ts

@@ -1,4 +1,4 @@
 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 };

package/dist/index.js

@@ -3,8 +3,9 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.printTable = exports.Table = void 0;
+exports.renderTable = exports.printTable = exports.Table = void 0;
 const console_table_printer_1 = __importDefault(require("./src/console-table-printer"));
 exports.Table = console_table_printer_1.default;
 const internal_table_printer_1 = require("./src/internalTable/internal-table-printer");
 Object.defineProperty(exports, "printTable", { enumerable: true, get: function () { return internal_table_printer_1.printSimpleTable; } });
+Object.defineProperty(exports, "renderTable", { enumerable: true, get: function () { return internal_table_printer_1.renderSimpleTable; } });

package/dist/src/console-table-printer.d.ts

@@ -5,10 +5,10 @@ import { RowOptionsRaw } from './utils/table-helpers';
 export default class Table {
     table: TableInternal;
     constructor(options?: ComplexOptions | string[]);
-    addColumn(column: string): void;
-    addColumns(columns: string[]): void;
-    addRow(text: Dictionary, rowOptions?: RowOptionsRaw): void;
-    addRows(toBeInsertedRows: any, rowOptions?: RowOptionsRaw): void;
+    addColumn(column: string): this;
+    addColumns(columns: string[]): this;
+    addRow(text: Dictionary, rowOptions?: RowOptionsRaw): this;
+    addRows(toBeInsertedRows: any, rowOptions?: RowOptionsRaw): this;
     printTable(): void;
     render(): string;
 }

package/dist/src/console-table-printer.js

@@ -11,15 +11,19 @@ class Table {
     }
     addColumn(column) {
         this.table.addColumn(column);
+        return this;
     }
     addColumns(columns) {
         this.table.addColumns(columns);
+        return this;
     }
     addRow(text, rowOptions) {
-        this.table.addRow(text, table_helpers_1.convertRawRowOptionsToStandard(rowOptions));
+        this.table.addRow(text, (0, table_helpers_1.convertRawRowOptionsToStandard)(rowOptions));
+        return this;
     }
     addRows(toBeInsertedRows, rowOptions) {
-        this.table.addRows(toBeInsertedRows, table_helpers_1.convertRawRowOptionsToStandard(rowOptions));
+        this.table.addRows(toBeInsertedRows, (0, table_helpers_1.convertRawRowOptionsToStandard)(rowOptions));
+        return this;
     }
     printTable() {
         const tableRendered = this.table.renderTable();

package/dist/src/internalTable/input-converter.js

@@ -11,5 +11,5 @@ const objIfExists = (key, val) => {
     };
 };
 exports.objIfExists = objIfExists;
-const rawColumnToInternalColumn = (column) => (Object.assign(Object.assign(Object.assign(Object.assign({ name: column.name, title: column.title || column.name }, exports.objIfExists('color', column.color)), exports.objIfExists('maxLen', column.maxLen)), exports.objIfExists('minLen', column.minLen)), { alignment: column.alignment || table_constants_1.DEFAULT_ROW_ALIGNMENT }));
+const rawColumnToInternalColumn = (column) => (Object.assign(Object.assign(Object.assign(Object.assign({ name: column.name, title: column.title || column.name }, (0, exports.objIfExists)('color', column.color)), (0, exports.objIfExists)('maxLen', column.maxLen)), (0, exports.objIfExists)('minLen', column.minLen)), { alignment: column.alignment || table_constants_1.DEFAULT_ROW_ALIGNMENT }));
 exports.rawColumnToInternalColumn = rawColumnToInternalColumn;

package/dist/src/internalTable/internal-table-printer.js

@@ -11,29 +11,29 @@ const table_helpers_1 = require("../utils/table-helpers");
 const internal_table_1 = __importDefault(require("./internal-table"));
 const table_pre_processors_1 = require("./table-pre-processors");
 // ║ Index ║         ║        ║
-const renderOneLine = (tableStyle, columns, currentLineIndex, widthLimitedColumnsArray, isHeader, row) => {
-    const line = new colored_console_line_1.default();
-    line.addCharsWithColor(table_constants_1.DEFAULT_ROW_FONT_COLOR, tableStyle.vertical);
+const renderOneLine = (tableStyle, columns, currentLineIndex, widthLimitedColumnsArray, isHeader, row, colorMap, charLength) => {
+    const line = new colored_console_line_1.default(colorMap);
+    line.addCharsWithColor('', tableStyle.vertical); // dont Color the Column borders
     columns.forEach((column) => {
         const thisLineHasText = currentLineIndex < widthLimitedColumnsArray[column.name].length;
         const textForThisLine = thisLineHasText
-            ? table_helpers_1.cellText(widthLimitedColumnsArray[column.name][currentLineIndex])
+            ? (0, table_helpers_1.cellText)(widthLimitedColumnsArray[column.name][currentLineIndex])
             : '';
         line.addCharsWithColor(table_constants_1.DEFAULT_ROW_FONT_COLOR, ' ');
-        line.addCharsWithColor((isHeader && table_constants_1.DEFAULT_HEADER_FONT_COLOR) || column.color || row.color, string_utils_1.textWithPadding(textForThisLine, column.alignment || table_constants_1.DEFAULT_ROW_ALIGNMENT, column.length || table_constants_1.DEFAULT_COLUMN_LEN));
-        line.addCharsWithColor(table_constants_1.DEFAULT_ROW_FONT_COLOR, ` ${tableStyle.vertical}`);
+        line.addCharsWithColor((isHeader && table_constants_1.DEFAULT_HEADER_FONT_COLOR) || column.color || row.color, (0, string_utils_1.textWithPadding)(textForThisLine, column.alignment || table_constants_1.DEFAULT_ROW_ALIGNMENT, column.length || table_constants_1.DEFAULT_COLUMN_LEN, charLength));
+        line.addCharsWithColor('', ` ${tableStyle.vertical}`); // dont Color the Column borders
     });
     return line.renderConsole();
 };
 // ║ Bold  ║    text ║  value ║
 // ║ Index ║         ║        ║
-const renderWidthLimitedLines = (tableStyle, columns, row, isHeader) => {
+const renderWidthLimitedLines = (tableStyle, columns, row, colorMap, isHeader, charLength) => {
     // { col1: ['How', 'Is', 'Going'], col2: ['I am', 'Tom'],  }
-    const widthLimitedColumnsArray = table_helpers_1.getWidthLimitedColumnsArray(columns, row);
+    const widthLimitedColumnsArray = (0, table_helpers_1.getWidthLimitedColumnsArray)(columns, row, charLength);
     const totalLines = Object.values(widthLimitedColumnsArray).reduce((a, b) => Math.max(a, b.length), 0);
     const ret = [];
     for (let currentLineIndex = 0; currentLineIndex < totalLines; currentLineIndex += 1) {
-        const singleLine = renderOneLine(tableStyle, columns, currentLineIndex, widthLimitedColumnsArray, isHeader, row);
+        const singleLine = renderOneLine(tableStyle, columns, currentLineIndex, widthLimitedColumnsArray, isHeader, row, colorMap, charLength);
         ret.push(singleLine);
     }
     return ret;
@@ -41,7 +41,7 @@ const renderWidthLimitedLines = (tableStyle, columns, row, isHeader) => {
 // ║ 1     ║     I would like some red wine please ║ 10.212 ║
 const renderRow = (table, row) => {
     let ret = [];
-    ret = ret.concat(renderWidthLimitedLines(table.tableStyle, table.columns, row));
+    ret = ret.concat(renderWidthLimitedLines(table.tableStyle, table.columns, row, table.colorMap, undefined, table.charLength));
     return ret;
 };
 /*
@@ -61,8 +61,8 @@ const renderTableTitle = (table) => {
             .map((m) => m.length || table_constants_1.DEFAULT_COLUMN_LEN)
             .reduce(reducer, 1);
     };
-    const titleWithPadding = string_utils_1.textWithPadding(table.title, table_constants_1.DEFAULT_HEADER_ALIGNMENT, getTableWidth());
-    const styledText = new colored_console_line_1.default();
+    const titleWithPadding = (0, string_utils_1.textWithPadding)(table.title, table_constants_1.DEFAULT_HEADER_ALIGNMENT, getTableWidth());
+    const styledText = new colored_console_line_1.default(table.colorMap);
     styledText.addCharsWithColor(table_constants_1.DEFAULT_HEADER_FONT_COLOR, titleWithPadding);
     //                  The analysis Result
     ret.push(styledText.renderConsole());
@@ -76,28 +76,39 @@ const renderTableTitle = (table) => {
 const renderTableHeaders = (table) => {
     let ret = [];
     // ╔═══════╦═══════════════════════════════════════╦════════╗
-    ret.push(table_helpers_1.renderTableHorizontalBorders(table.tableStyle.headerTop, table.columns.map((m) => m.length || table_constants_1.DEFAULT_COLUMN_LEN)));
+    ret.push((0, table_helpers_1.renderTableHorizontalBorders)(table.tableStyle.headerTop, table.columns.map((m) => m.length || table_constants_1.DEFAULT_COLUMN_LEN)));
     // ║ index ║                                  text ║  value ║
-    const row = table_helpers_1.createHeaderAsRow(table_helpers_1.createRow, table.columns);
-    ret = ret.concat(renderWidthLimitedLines(table.tableStyle, table.columns, row, true));
+    const row = (0, table_helpers_1.createHeaderAsRow)(table_helpers_1.createRow, table.columns);
+    ret = ret.concat(renderWidthLimitedLines(table.tableStyle, table.columns, row, table.colorMap, true));
     // ╟═══════╬═══════════════════════════════════════╬════════╢
-    ret.push(table_helpers_1.renderTableHorizontalBorders(table.tableStyle.headerBottom, table.columns.map((m) => m.length || table_constants_1.DEFAULT_COLUMN_LEN)));
+    ret.push((0, table_helpers_1.renderTableHorizontalBorders)(table.tableStyle.headerBottom, table.columns.map((m) => m.length || table_constants_1.DEFAULT_COLUMN_LEN)));
     return ret;
 };
 const renderTableEnding = (table) => {
     const ret = [];
     // ╚═══════╩═══════════════════════════════════════╩════════╝
-    ret.push(table_helpers_1.renderTableHorizontalBorders(table.tableStyle.tableBottom, table.columns.map((m) => m.length || table_constants_1.DEFAULT_COLUMN_LEN)));
+    ret.push((0, table_helpers_1.renderTableHorizontalBorders)(table.tableStyle.tableBottom, table.columns.map((m) => m.length || table_constants_1.DEFAULT_COLUMN_LEN)));
+    return ret;
+};
+const renderRowSeparator = (table, row) => {
+    const ret = [];
+    const lastRowIndex = table.rows.length - 1;
+    const currentRowIndex = table.rows.indexOf(row);
+    if (currentRowIndex !== lastRowIndex && row.separator) {
+        // ╟═══════╬═══════════════════════════════════════╬════════╢
+        ret.push((0, table_helpers_1.renderTableHorizontalBorders)(table.tableStyle.rowSeparator, table.columns.map((m) => m.length || table_constants_1.DEFAULT_COLUMN_LEN)));
+    }
     return ret;
 };
 const renderTable = (table) => {
-    table_pre_processors_1.preProcessColumns(table); // enable / disable cols, find maxLn of each col/ computed Columns
-    table_pre_processors_1.preProcessRows(table); // sort and filter
+    (0, table_pre_processors_1.preProcessColumns)(table); // enable / disable cols, find maxLn of each col/ computed Columns
+    (0, table_pre_processors_1.preProcessRows)(table); // sort and filter
     const ret = [];
     renderTableTitle(table).forEach((row) => ret.push(row));
     renderTableHeaders(table).forEach((row) => ret.push(row));
     table.rows.forEach((row) => {
         renderRow(table, row).forEach((row_) => ret.push(row_));
+        renderRowSeparator(table, row).forEach((row_) => ret.push(row_));
     });
     renderTableEnding(table).forEach((row) => ret.push(row));
     return ret.join('\n');
@@ -106,10 +117,10 @@ exports.renderTable = renderTable;
 const renderSimpleTable = (rows) => {
     const table = new internal_table_1.default();
     table.addRows(rows);
-    return exports.renderTable(table);
+    return (0, exports.renderTable)(table);
 };
 exports.renderSimpleTable = renderSimpleTable;
 const printSimpleTable = (rows) => {
-    console.log(exports.renderSimpleTable(rows));
+    console.log((0, exports.renderSimpleTable)(rows));
 };
 exports.printSimpleTable = printSimpleTable;

package/dist/src/internalTable/internal-table.d.ts

@@ -1,6 +1,7 @@
-import { Dictionary, Row } from '../models/common';
+import { CharLengthDict, Dictionary, Row } from '../models/common';
 import { ComplexOptions, ComputedColumn, RowFilterFunction, RowSortFunction } from '../models/external-table';
 import { Column, TableStyleDetails } from '../models/internal-table';
+import { ColorMap } from '../utils/colored-console-line';
 import { RowOptions } from '../utils/table-helpers';
 declare class TableInternal {
     title?: string;
@@ -12,6 +13,9 @@ declare class TableInternal {
     enabledColumns: string[];
     disabledColumns: string[];
     computedColumns: any[];
+    rowSeparator: boolean;
+    colorMap: ColorMap;
+    charLength: CharLengthDict;
     initSimple(columns: string[]): void;
     initDetailed(options: ComplexOptions): void;
     constructor(options?: ComplexOptions | string[]);

package/dist/src/internalTable/internal-table.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+const colored_console_line_1 = require("../utils/colored-console-line");
 const table_constants_1 = require("../utils/table-constants");
 const table_helpers_1 = require("../utils/table-helpers");
 const input_converter_1 = require("./input-converter");
@@ -18,6 +19,9 @@ class TableInternal {
         this.enabledColumns = [];
         this.disabledColumns = [];
         this.computedColumns = [];
+        this.rowSeparator = table_constants_1.DEFAULT_ROW_SEPARATOR;
+        this.colorMap = colored_console_line_1.DEFAULT_COLOR_MAP;
+        this.charLength = {};
         if (options instanceof Array) {
             this.initSimple(options);
         }
@@ -34,29 +38,38 @@ class TableInternal {
     }
     initDetailed(options) {
         var _a;
-        this.title = options.title || undefined;
-        this.tableStyle = (options === null || options === void 0 ? void 0 : options.style) || table_constants_1.DEFAULT_TABLE_STYLE;
-        this.sortFunction = (options === null || options === void 0 ? void 0 : options.sort) || DEFAULT_ROW_SORT_FUNC;
-        this.filterFunction = (options === null || options === void 0 ? void 0 : options.filter) || DEFAULT_ROW_FILTER_FUNC;
-        this.enabledColumns = (options === null || options === void 0 ? void 0 : options.enabledColumns) || [];
-        this.disabledColumns = (options === null || options === void 0 ? void 0 : options.disabledColumns) || [];
-        this.computedColumns = (options === null || options === void 0 ? void 0 : options.computedColumns) || [];
-        this.columns = ((_a = options.columns) === null || _a === void 0 ? void 0 : _a.map(input_converter_1.rawColumnToInternalColumn)) || [];
+        this.title = (options === null || options === void 0 ? void 0 : options.title) || this.title;
+        this.tableStyle = (options === null || options === void 0 ? void 0 : options.style) || this.tableStyle;
+        this.sortFunction = (options === null || options === void 0 ? void 0 : options.sort) || this.sortFunction;
+        this.filterFunction = (options === null || options === void 0 ? void 0 : options.filter) || this.filterFunction;
+        this.enabledColumns = (options === null || options === void 0 ? void 0 : options.enabledColumns) || this.enabledColumns;
+        this.disabledColumns = (options === null || options === void 0 ? void 0 : options.disabledColumns) || this.disabledColumns;
+        this.computedColumns = (options === null || options === void 0 ? void 0 : options.computedColumns) || this.computedColumns;
+        this.columns =
+            ((_a = options === null || options === void 0 ? void 0 : options.columns) === null || _a === void 0 ? void 0 : _a.map(input_converter_1.rawColumnToInternalColumn)) || this.columns;
+        this.rowSeparator = (options === null || options === void 0 ? void 0 : options.rowSeparator) || this.rowSeparator;
+        this.charLength = (options === null || options === void 0 ? void 0 : options.charLength) || this.charLength;
+        if (options === null || options === void 0 ? void 0 : options.colorMap) {
+            this.colorMap = Object.assign(Object.assign({}, this.colorMap), options.colorMap);
+        }
+        if (options.rows !== undefined) {
+            this.addRows(options.rows);
+        }
     }
     createColumnFromRow(text) {
         const colNames = this.columns.map((col) => col.name);
         Object.keys(text).forEach((key) => {
             if (!colNames.includes(key)) {
-                this.columns.push(table_helpers_1.createColumFromOnlyName(key));
+                this.columns.push((0, table_helpers_1.createColumFromOnlyName)(key));
             }
         });
     }
     addColumn(textOrObj) {
         if (typeof textOrObj === 'string') {
-            this.columns.push(table_helpers_1.createColumFromOnlyName(textOrObj));
+            this.columns.push((0, table_helpers_1.createColumFromOnlyName)(textOrObj));
         }
         else {
-            this.columns.push(table_helpers_1.createColumFromComputedColumn(textOrObj));
+            this.columns.push((0, table_helpers_1.createColumFromComputedColumn)(textOrObj));
         }
     }
     addColumns(toBeInsertedColumns) {
@@ -66,7 +79,9 @@ class TableInternal {
     }
     addRow(text, options) {
         this.createColumnFromRow(text);
-        this.rows.push(table_helpers_1.createRow((options === null || options === void 0 ? void 0 : options.color) || table_constants_1.DEFAULT_ROW_FONT_COLOR, text));
+        this.rows.push((0, table_helpers_1.createRow)((options === null || options === void 0 ? void 0 : options.color) || table_constants_1.DEFAULT_ROW_FONT_COLOR, text, (options === null || options === void 0 ? void 0 : options.separator) !== undefined
+            ? options === null || options === void 0 ? void 0 : options.separator
+            : this.rowSeparator));
     }
     addRows(toBeInsertedRows, options) {
         toBeInsertedRows.forEach((toBeInsertedRow) => {
@@ -74,7 +89,7 @@ class TableInternal {
         });
     }
     renderTable() {
-        return internal_table_printer_1.renderTable(this);
+        return (0, internal_table_printer_1.renderTable)(this);
     }
 }
 exports.default = TableInternal;

package/dist/src/internalTable/table-pre-processors.js

@@ -24,7 +24,7 @@ const enableColumnsIfNecessary = (table) => {
 };
 const findColumnWidth = (table) => {
     table.columns.forEach((column) => {
-        column.length = table_helpers_1.findLenOfColumn(column, table.rows);
+        column.length = (0, table_helpers_1.findLenOfColumn)(column, table.rows, table.charLength);
     });
 };
 const preProcessColumns = (table) => {

package/dist/src/models/common.d.ts

@@ -4,7 +4,11 @@ export declare type COLOR = typeof COLORS[number];
 export interface Dictionary {
     [key: string]: any;
 }
+export interface CharLengthDict {
+    [key: string]: number;
+}
 export interface Row {
     color: COLOR;
+    separator: boolean;
     text: Dictionary;
 }

package/dist/src/models/external-table.d.ts

@@ -1,4 +1,5 @@
-import { ALIGNMENT, COLOR } from './common';
+import { ColorMap } from '../utils/colored-console-line';
+import { ALIGNMENT, CharLengthDict, COLOR, Dictionary } from './common';
 import { TableStyleDetails } from './internal-table';
 export { ALIGNMENT, COLOR };
 export interface ColumnOptionsRaw {
@@ -18,9 +19,13 @@ export interface ComplexOptions {
     style?: TableStyleDetails;
     title?: string;
     columns?: ColumnOptionsRaw[];
+    rows?: Dictionary[];
     sort?: RowSortFunction;
     filter?: RowFilterFunction;
     enabledColumns?: string[];
     disabledColumns?: string[];
     computedColumns?: ComputedColumn[];
+    rowSeparator?: boolean;
+    colorMap?: ColorMap;
+    charLength?: CharLengthDict;
 }

package/dist/src/models/internal-table.d.ts

@@ -17,5 +17,6 @@ export declare type TableStyleDetails = {
     headerBottom: TableLineDetails;
     tableBottom: TableLineDetails;
     vertical: string;
+    rowSeparator?: TableLineDetails;
 };
 export {};

package/dist/src/utils/colored-console-line.d.ts

@@ -1,8 +1,12 @@
 import { COLOR } from '../models/common';
-export declare const colorString: (color: COLOR, text: string) => string;
+export declare type ColorMap = {
+    [key in COLOR]?: string;
+};
+export declare const DEFAULT_COLOR_MAP: ColorMap;
 export default class ColoredConsoleLine {
     text: string;
-    constructor();
+    colorMap: ColorMap;
+    constructor(colorMap?: ColorMap);
     addCharsWithColor(color: COLOR, text: string): void;
     renderConsole(): string;
 }

package/dist/src/utils/colored-console-line.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.colorString = void 0;
-const COLOR_MAP = {
+exports.DEFAULT_COLOR_MAP = void 0;
+exports.DEFAULT_COLOR_MAP = {
     red: '\x1b[31m',
     green: '\x1b[32m',
     yellow: '\x1b[33m',
@@ -13,14 +13,17 @@ const COLOR_MAP = {
     white_bold: '\x1b[01m',
     reset: '\x1b[0m',
 };
-const colorString = (color, text) => `${color && COLOR_MAP[color]}${text}${COLOR_MAP.reset}`;
-exports.colorString = colorString;
 class ColoredConsoleLine {
-    constructor() {
+    constructor(colorMap = exports.DEFAULT_COLOR_MAP) {
         this.text = '';
+        this.colorMap = colorMap;
     }
     addCharsWithColor(color, text) {
-        this.text += exports.colorString(color, text);
+        const colorAnsi = this.colorMap[color];
+        this.text +=
+            colorAnsi !== undefined
+                ? `${colorAnsi}${text}${this.colorMap.reset}`
+                : text;
     }
     renderConsole() {
         return this.text;

package/dist/src/utils/console-utils.d.ts

@@ -1,2 +1,3 @@
-declare const findWidthInConsole: (str: string) => number;
+import { CharLengthDict } from '../models/common';
+export declare const findWidthInConsole: (str: string, charLength?: CharLengthDict) => number;
 export default findWidthInConsole;

package/dist/src/utils/console-utils.js

@@ -1,8 +1,23 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.findWidthInConsole = void 0;
 const simple_wcswidth_1 = require("simple-wcswidth");
 /* eslint-disable no-control-regex */
 const colorRegex = /\x1b\[\d{1,3}m/g; // \x1b[30m  \x1b[305m
 const stripAnsi = (str) => str.replace(colorRegex, '');
-const findWidthInConsole = (str) => simple_wcswidth_1.wcswidth(stripAnsi(str));
-exports.default = findWidthInConsole;
+const findWidthInConsole = (str, charLength) => {
+    let strLen = 0;
+    str = stripAnsi(str);
+    if (charLength) {
+        Object.entries(charLength).forEach(([key, value]) => {
+            // count appearance of the key in the string and remove from original string
+            let regex = new RegExp(key, 'g');
+            strLen += (str.match(regex) || []).length * value;
+            str = str.replace(key, '');
+        });
+    }
+    strLen += (0, simple_wcswidth_1.wcswidth)(str);
+    return strLen;
+};
+exports.findWidthInConsole = findWidthInConsole;
+exports.default = exports.findWidthInConsole;

package/dist/src/utils/string-utils.d.ts

@@ -1,4 +1,4 @@
-import { ALIGNMENT } from '../models/common';
-export declare const textWithPadding: (text: string, alignment: ALIGNMENT, columnLen: number) => string;
-export declare const limitWidth: (inpStr: string, width: number) => string[];
-export declare const biggestWordInSentence: (inpStr: string) => number;
+import { ALIGNMENT, CharLengthDict } from '../models/common';
+export declare const textWithPadding: (text: string, alignment: ALIGNMENT, columnLen: number, charLength?: CharLengthDict) => string;
+export declare const limitWidth: (inpStr: string, width: number, charLength?: CharLengthDict) => string[];
+export declare const biggestWordInSentence: (inpStr: string, charLength?: CharLengthDict) => number;

package/dist/src/utils/string-utils.js

@@ -7,11 +7,15 @@ exports.biggestWordInSentence = exports.limitWidth = exports.textWithPadding = v
 const console_utils_1 = __importDefault(require("./console-utils"));
 // ("How are you?",center, 20) => "    How are you?    "
 // ("How are you?",right, 20)  => "        How are you?"
-const textWithPadding = (text, alignment, columnLen) => {
-    const curTextSize = console_utils_1.default(text);
+const textWithPadding = (text, alignment, columnLen, charLength) => {
+    const curTextSize = (0, console_utils_1.default)(text, charLength);
     // alignments for center padding case
     const leftPadding = Math.floor((columnLen - curTextSize) / 2);
     const rightPadding = columnLen - leftPadding - curTextSize;
+    // handle edge cases where the text size is larger than the column length
+    if (columnLen < curTextSize) {
+        return text;
+    }
     // console.log(text, columnLen, curTextSize);
     switch (alignment) {
         case 'left':
@@ -28,13 +32,13 @@ const textWithPadding = (text, alignment, columnLen) => {
 };
 exports.textWithPadding = textWithPadding;
 // ("How are you?",10) => ["How are ", "you?"]
-const limitWidth = (inpStr, width) => {
+const limitWidth = (inpStr, width, charLength) => {
     const ret = [];
     const spaceSeparatedStrings = inpStr.split(' ');
     let now = [];
     let cnt = 0;
     spaceSeparatedStrings.forEach((strWithoutSpace) => {
-        const consoleWidth = console_utils_1.default(strWithoutSpace);
+        const consoleWidth = (0, console_utils_1.default)(strWithoutSpace, charLength);
         if (cnt + consoleWidth <= width) {
             cnt += consoleWidth + 1; // 1 for the space
             now.push(strWithoutSpace);
@@ -50,5 +54,7 @@ const limitWidth = (inpStr, width) => {
 };
 exports.limitWidth = limitWidth;
 // ("How are you?",10) => ["How are ", "you?"]
-const biggestWordInSentence = (inpStr) => inpStr.split(' ').reduce((a, b) => Math.max(a, console_utils_1.default(b)), 0);
+const biggestWordInSentence = (inpStr, charLength) => inpStr
+    .split(' ')
+    .reduce((a, b) => Math.max(a, (0, console_utils_1.default)(b, charLength)), 0);
 exports.biggestWordInSentence = biggestWordInSentence;

package/dist/src/utils/table-constants.d.ts

@@ -1,6 +1,7 @@
 import { ALIGNMENT, COLOR } from '../models/common';
 import { TableStyleDetails } from '../models/internal-table';
 export declare const DEFAULT_COLUMN_LEN = 20;
+export declare const DEFAULT_ROW_SEPARATOR = false;
 export declare const DEFAULT_TABLE_STYLE: TableStyleDetails;
 export declare const ALIGNMENTS: string[];
 export declare const COLORS: string[];

package/dist/src/utils/table-constants.js

@@ -1,7 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DEFAULT_HEADER_ALIGNMENT = exports.DEFAULT_ROW_ALIGNMENT = exports.DEFAULT_HEADER_FONT_COLOR = exports.DEFAULT_ROW_FONT_COLOR = exports.COLORS = exports.ALIGNMENTS = exports.DEFAULT_TABLE_STYLE = exports.DEFAULT_COLUMN_LEN = void 0;
+exports.DEFAULT_HEADER_ALIGNMENT = exports.DEFAULT_ROW_ALIGNMENT = exports.DEFAULT_HEADER_FONT_COLOR = exports.DEFAULT_ROW_FONT_COLOR = exports.COLORS = exports.ALIGNMENTS = exports.DEFAULT_TABLE_STYLE = exports.DEFAULT_ROW_SEPARATOR = exports.DEFAULT_COLUMN_LEN = void 0;
 exports.DEFAULT_COLUMN_LEN = 20;
+exports.DEFAULT_ROW_SEPARATOR = false;
 exports.DEFAULT_TABLE_STYLE = {
     /*
         Default Style
@@ -29,6 +30,12 @@ exports.DEFAULT_TABLE_STYLE = {
         other: '─',
     },
     vertical: '│',
+    rowSeparator: {
+        left: '├',
+        mid: '┼',
+        right: '┤',
+        other: '─',
+    },
 };
 exports.ALIGNMENTS = ['right', 'left', 'center'];
 exports.COLORS = [

package/dist/src/utils/table-helpers.d.ts

@@ -1,14 +1,16 @@
-import { COLOR, Dictionary, Row } from '../models/common';
+import { CharLengthDict, COLOR, Dictionary, Row } from '../models/common';
 import { ComputedColumn } from '../models/external-table';
 import { Column } from '../models/internal-table';
 export declare const cellText: (text: string | number) => string;
 export interface RowOptionsRaw {
-    color: string;
+    color?: string;
+    separator?: boolean;
 }
 export interface RowOptions {
     color: COLOR;
+    separator: boolean;
 }
-export declare const convertRawRowOptionsToStandard: (options?: RowOptionsRaw | undefined) => RowOptions | undefined;
+export declare const convertRawRowOptionsToStandard: (options?: RowOptionsRaw) => RowOptions | undefined;
 export declare const createTableHorizontalBorders: ({ left, mid, right, other, }: {
     left: string;
     mid: string;
@@ -17,10 +19,10 @@ export declare const createTableHorizontalBorders: ({ left, mid, right, other, }
 }, column_lengths: number[]) => string;
 export declare const createColumFromOnlyName: (name: string) => Column;
 export declare const createColumFromComputedColumn: (column: ComputedColumn) => Column;
-export declare const createRow: (color: COLOR, text: Dictionary) => Row;
-export declare const findLenOfColumn: (column: Column, rows: Row[]) => number;
+export declare const createRow: (color: COLOR, text: Dictionary, separator: boolean) => Row;
+export declare const findLenOfColumn: (column: Column, rows: Row[], charLength?: CharLengthDict) => number;
 export declare const renderTableHorizontalBorders: (style: any, column_lengths: number[]) => string;
 export declare const createHeaderAsRow: (createRowFn: any, columns: Column[]) => Row;
-export declare const getWidthLimitedColumnsArray: (columns: Column[], row: Row) => {
+export declare const getWidthLimitedColumnsArray: (columns: Column[], row: Row, charLength?: CharLengthDict) => {
     [key: string]: string[];
 };

package/dist/src/utils/table-helpers.js

@@ -16,6 +16,7 @@ const convertRawRowOptionsToStandard = (options) => {
     if (options) {
         return {
             color: options.color,
+            separator: options.separator || table_constants_1.DEFAULT_ROW_SEPARATOR,
         };
     }
     return undefined;
@@ -41,39 +42,40 @@ const createColumFromOnlyName = (name) => ({
     title: name,
 });
 exports.createColumFromOnlyName = createColumFromOnlyName;
-const createColumFromComputedColumn = (column) => (Object.assign(Object.assign(Object.assign(Object.assign({ name: column.name, title: column.title || column.name }, input_converter_1.objIfExists('color', column.color)), input_converter_1.objIfExists('maxLen', column.maxLen)), input_converter_1.objIfExists('minLen', column.minLen)), { alignment: column.alignment || table_constants_1.DEFAULT_ROW_ALIGNMENT }));
+const createColumFromComputedColumn = (column) => (Object.assign(Object.assign(Object.assign(Object.assign({ name: column.name, title: column.title || column.name }, (0, input_converter_1.objIfExists)('color', column.color)), (0, input_converter_1.objIfExists)('maxLen', column.maxLen)), (0, input_converter_1.objIfExists)('minLen', column.minLen)), { alignment: column.alignment || table_constants_1.DEFAULT_ROW_ALIGNMENT }));
 exports.createColumFromComputedColumn = createColumFromComputedColumn;
-const createRow = (color, text) => ({
+const createRow = (color, text, separator) => ({
     color,
+    separator,
     text,
 });
 exports.createRow = createRow;
-const findLenOfColumn = (column, rows) => {
+const findLenOfColumn = (column, rows, charLength) => {
     const columnId = column.name;
     const columnTitle = column.title;
     let length = max(0, (column === null || column === void 0 ? void 0 : column.minLen) || 0);
     if (column.maxLen) {
         // if customer input is mentioned a max width, lets see if all other can fit here
         // if others cant fit find the max word length so that at least the table can be printed
-        length = max(length, max(column.maxLen, string_utils_1.biggestWordInSentence(columnTitle)));
-        length = rows.reduce((acc, row) => max(acc, string_utils_1.biggestWordInSentence(exports.cellText(row.text[columnId]))), length);
+        length = max(length, max(column.maxLen, (0, string_utils_1.biggestWordInSentence)(columnTitle, charLength)));
+        length = rows.reduce((acc, row) => max(acc, (0, string_utils_1.biggestWordInSentence)((0, exports.cellText)(row.text[columnId]), charLength)), length);
         return length;
     }
-    length = max(length, console_utils_1.default(columnTitle));
+    length = max(length, (0, console_utils_1.default)(columnTitle, charLength));
     rows.forEach((row) => {
-        length = max(length, console_utils_1.default(exports.cellText(row.text[columnId])));
+        length = max(length, (0, console_utils_1.default)((0, exports.cellText)(row.text[columnId]), charLength));
     });
     return length;
 };
 exports.findLenOfColumn = findLenOfColumn;
 const renderTableHorizontalBorders = (style, column_lengths) => {
-    const str = exports.createTableHorizontalBorders(style, column_lengths);
+    const str = (0, exports.createTableHorizontalBorders)(style, column_lengths);
     return str;
 };
 exports.renderTableHorizontalBorders = renderTableHorizontalBorders;
 const createHeaderAsRow = (createRowFn, columns) => {
-    const headerColor = 'white_bold';
-    const row = createRowFn(headerColor, {});
+    const headerColor = table_constants_1.DEFAULT_HEADER_FONT_COLOR;
+    const row = createRowFn(headerColor, {}, false);
     columns.forEach((column) => {
         row.text[column.name] = column.title;
     });
@@ -81,10 +83,10 @@ const createHeaderAsRow = (createRowFn, columns) => {
 };
 exports.createHeaderAsRow = createHeaderAsRow;
 // { col1: ['How', 'Is', 'Going'], col2: ['I am', 'Tom'],  }
-const getWidthLimitedColumnsArray = (columns, row) => {
+const getWidthLimitedColumnsArray = (columns, row, charLength) => {
     const ret = {};
     columns.forEach((column) => {
-        ret[column.name] = string_utils_1.limitWidth(exports.cellText(row.text[column.name]), column.length || table_constants_1.DEFAULT_COLUMN_LEN);
+        ret[column.name] = (0, string_utils_1.limitWidth)((0, exports.cellText)(row.text[column.name]), column.length || table_constants_1.DEFAULT_COLUMN_LEN, charLength);
     });
     return ret;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "console-table-printer",
-  "version": "2.9.0",
+  "version": "2.11.1",
   "repository": "github:ayonious/console-table-printer",
   "description": "Printing pretty tables on console log",
   "main": "dist/index.js",
@@ -25,24 +25,24 @@
   "author": "Nahiyan Kamal",
   "license": "MIT",
   "devDependencies": {
-    "@semantic-release/changelog": "^5.0.1",
-    "@semantic-release/git": "^9.0.0",
-    "@types/jest": "^26.0.23",
-    "@typescript-eslint/eslint-plugin": "^4.23.0",
-    "@typescript-eslint/parser": "^4.23.0",
-    "chalk": "^4.1.1",
-    "eslint": "^7.26.0",
-    "eslint-config-airbnb-base": "^14.2.1",
-    "eslint-config-prettier": "^8.3.0",
-    "eslint-plugin-import": "^2.22.1",
-    "eslint-plugin-prettier": "^3.4.0",
-    "husky": "^6.0.0",
-    "jest": "^26.6.3",
-    "prettier": "^2.3.0",
-    "pretty-quick": "^3.1.0",
-    "semantic-release": "^17.4.2",
-    "ts-jest": "^26.5.6",
-    "typescript": "^4.2.4"
+    "@semantic-release/changelog": "^6.0.1",
+    "@semantic-release/git": "^10.0.1",
+    "@types/jest": "^28.1.8",
+    "@typescript-eslint/eslint-plugin": "^5.34.0",
+    "@typescript-eslint/parser": "^5.34.0",
+    "chalk": "^4.1.2",
+    "eslint": "^8.22.0",
+    "eslint-config-airbnb-base": "^15.0.0",
+    "eslint-config-prettier": "^8.5.0",
+    "eslint-plugin-import": "^2.26.0",
+    "eslint-plugin-prettier": "^4.2.1",
+    "husky": "^8.0.1",
+    "jest": "^28.1.3",
+    "prettier": "^2.7.1",
+    "pretty-quick": "^3.1.3",
+    "semantic-release": "^19.0.5",
+    "ts-jest": "^28.0.8",
+    "typescript": "^4.7.4"
   },
   "homepage": "https://console-table.netlify.app",
   "dependencies": {

package/CHANGELOG.md

@@ -1,96 +0,0 @@
-# [2.9.0](https://github.com/ayonious/console-table-printer/compare/v2.8.2...v2.9.0) (2021-05-12)
-
-
-### Bug Fixes
-
-* **technical:** fixing types error for compilation ([68a8bf7](https://github.com/ayonious/console-table-printer/commit/68a8bf7fdd6234702adbf7209e63e4d1b3bdcd4a))
-
-
-### Features
-
-* min width ([#363](https://github.com/ayonious/console-table-printer/issues/363)) ([3a1b4e8](https://github.com/ayonious/console-table-printer/commit/3a1b4e8fff70033d2391fc58bd0c4258f18efffa))
-
-## [2.8.2](https://github.com/ayonious/console-table-printer/compare/v2.8.1...v2.8.2) (2021-03-19)
-
-
-### Bug Fixes
-
-* added circle ci ([79e72eb](https://github.com/ayonious/console-table-printer/commit/79e72eba75763d9c5e964a3aafc1a83a36f75b5a))
-* Calculated Columns Title is shown ([#349](https://github.com/ayonious/console-table-printer/issues/349)) ([88ae550](https://github.com/ayonious/console-table-printer/commit/88ae55070818e7cc06d8a0872aeb45ffd3ed0299))
-
-## [2.8.1](https://github.com/ayonious/console-table-printer/compare/v2.8.0...v2.8.1) (2021-03-06)
-
-
-### Bug Fixes
-
-* fixing deployment ([981d819](https://github.com/ayonious/console-table-printer/commit/981d819e552c60f7d1a4f9f24a83e33a97eb582c))
-
-# [2.8.0](https://github.com/ayonious/console-table-printer/compare/v2.7.5...v2.8.0) (2021-03-06)
-
-
-### Features
-
-* Width Limit  ([#343](https://github.com/ayonious/console-table-printer/issues/343)) ([f5a541b](https://github.com/ayonious/console-table-printer/commit/f5a541ba39d22cbe37cbbd8100b3b740b4247ba3))
-
-## [2.7.5](https://github.com/ayonious/console-table-printer/compare/v2.7.4...v2.7.5) (2020-12-08)
-
-
-### Bug Fixes
-
-* **technical:** migrate to yarn and fix deployment ([0a1babb](https://github.com/ayonious/console-table-printer/commit/0a1babb87ec404da68471517dcca9a5595a03e81))
-
-## [2.7.4](https://github.com/ayonious/console-table-printer/compare/v2.7.3...v2.7.4) (2020-12-08)
-
-
-### Bug Fixes
-
-* Asian Languages width fixing with simple-wcswidth ([a14272f](https://github.com/ayonious/console-table-printer/commit/a14272f6738310cc21492c38adf71fac06b2a9dd))
-
-## [2.7.3](https://github.com/ayonious/console-table-printer/compare/v2.7.2...v2.7.3) (2020-12-06)
-
-
-### Bug Fixes
-
-* revert wcwidth and special character support ([#329](https://github.com/ayonious/console-table-printer/issues/329)) ([d6e7847](https://github.com/ayonious/console-table-printer/commit/d6e78475f10fac718c2848483ac88611bd804b01))
-
-## [2.7.2](https://github.com/ayonious/console-table-printer/compare/v2.7.1...v2.7.2) (2020-12-06)
-
-
-### Bug Fixes
-
-* column width calculation with special characters ([#303](https://github.com/ayonious/console-table-printer/issues/303)) ([5a288e7](https://github.com/ayonious/console-table-printer/commit/5a288e7e4e5ee3daa9a3da7befc450fea3adbea1))
-
-## [2.7.1](https://github.com/ayonious/console-table-printer/compare/v2.7.0...v2.7.1) (2020-12-05)
-
-
-### Bug Fixes
-
-* **docs:** readme update for Header title ([#321](https://github.com/ayonious/console-table-printer/issues/321)) ([572979f](https://github.com/ayonious/console-table-printer/commit/572979f7d5d8b9f83a69bc51020cbaebd83a3f93))
-
-# [2.7.0](https://github.com/ayonious/console-table-printer/compare/v2.6.0...v2.7.0) (2020-12-05)
-
-
-### Features
-
-* Header title - View Header Title in console instead of ugly header name ([#319](https://github.com/ayonious/console-table-printer/issues/319)) ([78bb5aa](https://github.com/ayonious/console-table-printer/commit/78bb5aa6a6cb76d09c63f115f37cb9f4ad02e315))
-
-# [2.6.0](https://github.com/ayonious/console-table-printer/compare/v2.5.1...v2.6.0) (2020-12-04)
-
-
-### Features
-
-* Allow cell coloring ([#317](https://github.com/ayonious/console-table-printer/issues/317)) ([1026d51](https://github.com/ayonious/console-table-printer/commit/1026d5136240228b6e44d29afee45f1a6350ad07))
-
-## [2.5.1](https://github.com/ayonious/console-table-printer/compare/v2.5.0...v2.5.1) (2020-11-07)
-
-
-### Bug Fixes
-
-* **technical:** update dependency eslint to ^7.13.0 and remove package-lock deps updates ([#290](https://github.com/ayonious/console-table-printer/issues/290)) ([adc9c05](https://github.com/ayonious/console-table-printer/commit/adc9c052311e4b1508d17edfb2c0a92c65577e99))
-
-# [2.5.0](https://github.com/ayonious/console-table-printer/compare/v2.4.36...v2.5.0) (2020-11-04)
-
-
-### Features
-
-* **technical:** semantic release ([#288](https://github.com/ayonious/console-table-printer/issues/288)) ([3121382](https://github.com/ayonious/console-table-printer/commit/31213829a2b8e1e6f6aa9ee0b34e6a0450816952))