console-table-printer 2.11.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
@@ -147,12 +147,19 @@ new Table({
   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/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, colorMap) => {
+const renderOneLine = (tableStyle, columns, currentLineIndex, widthLimitedColumnsArray, isHeader, row, colorMap, charLength) => {
     const line = new colored_console_line_1.default(colorMap);
-    line.addCharsWithColor(table_constants_1.DEFAULT_ROW_FONT_COLOR, tableStyle.vertical);
+    line.addCharsWithColor('', tableStyle.vertical); // dont Color the Column borders
     columns.forEach((column) => {
         const thisLineHasText = currentLineIndex < widthLimitedColumnsArray[column.name].length;
         const textForThisLine = thisLineHasText
             ? (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, (0, 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, colorMap, isHeader) => {
+const renderWidthLimitedLines = (tableStyle, columns, row, colorMap, isHeader, charLength) => {
     // { col1: ['How', 'Is', 'Going'], col2: ['I am', 'Tom'],  }
-    const widthLimitedColumnsArray = (0, 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, colorMap);
+        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, colorMap, 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, table.colorMap));
+    ret = ret.concat(renderWidthLimitedLines(table.tableStyle, table.columns, row, table.colorMap, undefined, table.charLength));
     return ret;
 };
 /*

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

@@ -1,4 +1,4 @@
-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';
@@ -15,6 +15,7 @@ declare class TableInternal {
     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

@@ -21,6 +21,7 @@ class TableInternal {
         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);
         }
@@ -47,6 +48,7 @@ class TableInternal {
         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);
         }

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

@@ -24,7 +24,7 @@ const enableColumnsIfNecessary = (table) => {
 };
 const findColumnWidth = (table) => {
     table.columns.forEach((column) => {
-        column.length = (0, 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,6 +4,9 @@ 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;

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

@@ -1,5 +1,5 @@
 import { ColorMap } from '../utils/colored-console-line';
-import { ALIGNMENT, COLOR, Dictionary } from './common';
+import { ALIGNMENT, CharLengthDict, COLOR, Dictionary } from './common';
 import { TableStyleDetails } from './internal-table';
 export { ALIGNMENT, COLOR };
 export interface ColumnOptionsRaw {
@@ -27,4 +27,5 @@ export interface ComplexOptions {
     computedColumns?: ComputedColumn[];
     rowSeparator?: boolean;
     colorMap?: ColorMap;
+    charLength?: CharLengthDict;
 }

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) => (0, 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 = (0, 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 = (0, 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, (0, 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-helpers.d.ts

@@ -1,4 +1,4 @@
-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;
@@ -10,7 +10,7 @@ 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;
@@ -20,9 +20,9 @@ export declare const createTableHorizontalBorders: ({ left, mid, right, other, }
 export declare const createColumFromOnlyName: (name: string) => Column;
 export declare const createColumFromComputedColumn: (column: ComputedColumn) => Column;
 export declare const createRow: (color: COLOR, text: Dictionary, separator: boolean) => Row;
-export declare const findLenOfColumn: (column: Column, rows: Row[]) => number;
+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

@@ -50,20 +50,20 @@ const createRow = (color, text, 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, (0, string_utils_1.biggestWordInSentence)(columnTitle)));
-        length = rows.reduce((acc, row) => max(acc, (0, string_utils_1.biggestWordInSentence)((0, 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, (0, console_utils_1.default)(columnTitle));
+    length = max(length, (0, console_utils_1.default)(columnTitle, charLength));
     rows.forEach((row) => {
-        length = max(length, (0, console_utils_1.default)((0, exports.cellText)(row.text[columnId])));
+        length = max(length, (0, console_utils_1.default)((0, exports.cellText)(row.text[columnId]), charLength));
     });
     return length;
 };
@@ -83,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] = (0, string_utils_1.limitWidth)((0, 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.11.0",
+  "version": "2.11.1",
   "repository": "github:ayonious/console-table-printer",
   "description": "Printing pretty tables on console log",
   "main": "dist/index.js",
@@ -27,22 +27,22 @@
   "devDependencies": {
     "@semantic-release/changelog": "^6.0.1",
     "@semantic-release/git": "^10.0.1",
-    "@types/jest": "^27.0.2",
-    "@typescript-eslint/eslint-plugin": "^5.2.0",
-    "@typescript-eslint/parser": "^5.2.0",
+    "@types/jest": "^28.1.8",
+    "@typescript-eslint/eslint-plugin": "^5.34.0",
+    "@typescript-eslint/parser": "^5.34.0",
     "chalk": "^4.1.2",
-    "eslint": "^8.1.0",
-    "eslint-config-airbnb-base": "^14.2.1",
-    "eslint-config-prettier": "^8.3.0",
-    "eslint-plugin-import": "^2.25.2",
-    "eslint-plugin-prettier": "^4.0.0",
-    "husky": "^7.0.4",
-    "jest": "^27.3.1",
-    "prettier": "^2.4.1",
-    "pretty-quick": "^3.1.1",
-    "semantic-release": "^18.0.0",
-    "ts-jest": "^27.0.7",
-    "typescript": "^4.4.4"
+    "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": {