console-table-printer 2.14.6 → 2.15.0

package/README.md

@@ -19,8 +19,8 @@ npm install console-table-printer --save
 
 ## Basic Example
 
-```javascript
-const { printTable } = require('console-table-printer');
+```typescript
+import { printTable } from 'console-table-printer';
 
 // Create a simple task list
 const tasks = [
@@ -39,8 +39,8 @@ printTable(tasks);
 
 You can also create a Table instance and print it:
 
-```javascript
-const { Table } = require('console-table-printer');
+```typescript
+import { Table } from 'console-table-printer';
 
 // Create a game leaderboard
 const leaderboard = new Table();
@@ -61,7 +61,9 @@ leaderboard.printTable();
 
 You can also put some color to your table like this:
 
-```javascript
+```typescript
+import { Table } from 'console-table-printer';
+
 const p = new Table();
 p.addRow({ item: 'Pizza', price: 12.99, rating: '5/5' }, { color: 'red' });
 p.addRow({ item: 'Burger', price: 8.99, rating: '4/5' }, { color: 'green' });
@@ -74,7 +76,9 @@ p.printTable();
 
 You can also put properties based on columns (color/alignment/title)
 
-```javascript
+```typescript
+import { Table } from 'console-table-printer';
+
 const p = new Table({
   title: 'Project Status',
   columns: [
@@ -115,13 +119,16 @@ Official documentation has been moved here: [console-table-documentation](https:
 
 3. Detailed way of creating table instance
 
-```javascript
+```typescript
+import { Table } from 'console-table-printer';
+
 new Table({
   title: '📊 Sales Report Q4 2024', // A text showsup on top of table (optional)
   columns: [
     { name: 'region', alignment: 'left', color: 'blue' }, // with alignment and color
     { name: 'sales', alignment: 'right', maxLen: 30 }, // lines bigger than this will be splitted in multiple lines
     { name: 'growth', title: 'Growth %' }, // Title is what will be shown while printing, by default title = name
+    { name: 'price', transform: (value) => `$${Number(value).toFixed(2)}` }, // Transform function to format cell values before display
   ],
   rows: [
     { region: 'North America', sales: '$2.5M', growth: '+15%' },
@@ -162,13 +169,13 @@ Check Docs: [color-vals](https://console-table.netlify.app/docs/doc-color)
 
 Example usage: To Create a row of color blue
 
-```js
+```typescript
 table.addRow(rowObject, { color: 'blue' });
 ```
 
 Example usage: To apply blue for all rows
 
-```js
+```typescript
 table.addRows(rowsArray, { color: 'blue' });
 ```
 

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

@@ -15,6 +15,6 @@ const rawColumnToInternalColumn = (column, defaultColumnStyles) => {
     var _a;
     return (Object.assign(Object.assign(Object.assign(Object.assign({ name: column.name, title: (_a = column.title) !== null && _a !== void 0 ? _a : column.name }, (0, exports.objIfExists)('color', (column.color || (defaultColumnStyles === null || defaultColumnStyles === void 0 ? void 0 : defaultColumnStyles.color)))), (0, exports.objIfExists)('maxLen', (column.maxLen || (defaultColumnStyles === null || defaultColumnStyles === void 0 ? void 0 : defaultColumnStyles.maxLen)))), (0, exports.objIfExists)('minLen', (column.minLen || (defaultColumnStyles === null || defaultColumnStyles === void 0 ? void 0 : defaultColumnStyles.minLen)))), { alignment: (column.alignment ||
             (defaultColumnStyles === null || defaultColumnStyles === void 0 ? void 0 : defaultColumnStyles.alignment) ||
-            table_constants_1.DEFAULT_ROW_ALIGNMENT) }));
+            table_constants_1.DEFAULT_ROW_ALIGNMENT), transform: column.transform }));
 };
 exports.rawColumnToInternalColumn = rawColumnToInternalColumn;

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

@@ -38,10 +38,26 @@ const renderWidthLimitedLines = (tableStyle, columns, row, colorMap, isHeader, c
     }
     return ret;
 };
+const transformRow = (row, columns) => {
+    const transformedRow = JSON.parse(JSON.stringify(row));
+    const transforms = {};
+    columns
+        .filter((c) => {
+        return !!c.transform;
+    })
+        .forEach((c) => {
+        transforms[c.name] = c.transform;
+    });
+    Object.keys(transforms).forEach((t) => {
+        transformedRow.text[t] = transforms[t](transformedRow.text[t]);
+    });
+    return transformedRow;
+};
 // ║ 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, undefined, table.charLength));
+    const transformedRow = transformRow(row, table.columns);
+    ret = ret.concat(renderWidthLimitedLines(table.tableStyle, table.columns, transformedRow, table.colorMap, undefined, table.charLength));
     return ret;
 };
 /*

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

@@ -1,5 +1,5 @@
 import { CharLengthDict, Dictionary, Row } from '../models/common';
-import { ColumnOptionsRaw, ComplexOptions, ComputedColumn, DefaultColumnOptions, RowFilterFunction, RowSortFunction } from '../models/external-table';
+import { ColumnOptionsRaw, ComplexOptions, ComputedColumn, DefaultColumnOptions, RowFilterFunction, RowSortFunction, Valuetransform } from '../models/external-table';
 import { Column, TableStyleDetails } from '../models/internal-table';
 import { ColorMap } from '../utils/colored-console-line';
 import { RowOptions } from '../utils/table-helpers';
@@ -17,6 +17,7 @@ declare class TableInternal {
     colorMap: ColorMap;
     charLength: CharLengthDict;
     defaultColumnOptions?: DefaultColumnOptions;
+    transforms?: Record<string, Valuetransform>;
     initSimple(columns: string[]): void;
     initDetailed(options: ComplexOptions): void;
     constructor(options?: ComplexOptions | string[]);

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

@@ -18,7 +18,7 @@ class TableInternal {
     initDetailed(options) {
         var _a;
         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.tableStyle = Object.assign(Object.assign({}, this.tableStyle), options === null || options === void 0 ? void 0 : options.style);
         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;
@@ -55,6 +55,7 @@ class TableInternal {
         this.colorMap = colored_console_line_1.DEFAULT_COLOR_MAP;
         this.charLength = {};
         this.defaultColumnOptions = undefined;
+        this.transforms = {};
         if (options instanceof Array) {
             this.initSimple(options);
         }

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

@@ -1,8 +1,10 @@
 import { ColorMap } from '../utils/colored-console-line';
 import { ALIGNMENT, CharLengthDict, COLOR, Dictionary } from './common';
-import { TableStyleDetails } from './internal-table';
+import { TableStyleDetails as InternalTableStyleDetails } from './internal-table';
 export { ALIGNMENT, COLOR };
-export type CellValue = string | number | undefined;
+export type TableStyleDetails = Partial<InternalTableStyleDetails>;
+export type CellValue = string | number | boolean | undefined | null;
+export type Valuetransform = (cellValue: CellValue) => CellValue;
 /**
  * Configuration options for a table column
  */
@@ -19,6 +21,8 @@ export interface ColumnOptionsRaw {
     maxLen?: number;
     /** Minimum length of text in the column. Shorter text will be padded with spaces */
     minLen?: number;
+    /** Value transform, For example 2.00000 => 2.0 */
+    transform?: Valuetransform;
 }
 /**
  * Configuration for a computed column that generates values dynamically

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

@@ -1,4 +1,5 @@
 import { ALIGNMENT, COLOR } from './common';
+import { Valuetransform } from './external-table';
 export interface Column {
     name: string;
     title: string;
@@ -7,6 +8,7 @@ export interface Column {
     length?: number;
     minLen?: number;
     maxLen?: number;
+    transform?: Valuetransform;
 }
 type TableLineDetailsKeys = 'left' | 'right' | 'mid' | 'other';
 export type TableLineDetails = {
@@ -17,6 +19,6 @@ export type TableStyleDetails = {
     headerBottom: TableLineDetails;
     tableBottom: TableLineDetails;
     vertical: string;
-    rowSeparator?: TableLineDetails;
+    rowSeparator: TableLineDetails;
 };
 export {};

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

@@ -1,6 +1,8 @@
 import { CharLengthDict, COLOR, Dictionary, Row } from '../models/common';
-import { Column } from '../models/internal-table';
-export declare const cellText: (text: string | number) => string;
+import { CellValue, Valuetransform } from '../models/external-table';
+import { Column, TableLineDetails } from '../models/internal-table';
+export declare const cellText: (text: CellValue) => string;
+export declare const evaluateCellText: (text: CellValue, transform?: Valuetransform) => string;
 export interface RowOptionsRaw {
     color?: string;
     separator?: boolean;
@@ -9,21 +11,19 @@ export interface RowOptions {
     color: COLOR;
     separator: boolean;
 }
+export interface CreateRowFunction {
+    (color: COLOR, text: Dictionary, separator: boolean): Row;
+}
 export declare const convertRawRowOptionsToStandard: (options?: RowOptionsRaw) => RowOptions | undefined;
-export declare const createTableHorizontalBorders: ({ left, mid, right, other, }: {
-    left: string;
-    mid: string;
-    right: string;
-    other: string;
-}, column_lengths: number[]) => string;
+export declare const createTableHorizontalBorders: ({ left, mid, right, other }: TableLineDetails, column_lengths: number[]) => string;
 export declare const createColumFromOnlyName: (name: string) => {
     name: string;
     title: string;
 };
-export declare const createRow: (color: COLOR, text: Dictionary, separator: boolean) => Row;
+export declare const createRow: CreateRowFunction;
 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 renderTableHorizontalBorders: (style: TableLineDetails, column_lengths: number[]) => string;
+export declare const createHeaderAsRow: (createRowFn: CreateRowFunction, columns: Column[]) => Row;
 export declare const getWidthLimitedColumnsArray: (columns: Column[], row: Row, charLength?: CharLengthDict) => {
     [key: string]: string[];
 };

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

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getWidthLimitedColumnsArray = exports.createHeaderAsRow = exports.renderTableHorizontalBorders = exports.findLenOfColumn = exports.createRow = exports.createColumFromOnlyName = exports.createTableHorizontalBorders = exports.convertRawRowOptionsToStandard = exports.cellText = void 0;
+exports.getWidthLimitedColumnsArray = exports.createHeaderAsRow = exports.renderTableHorizontalBorders = exports.findLenOfColumn = exports.createRow = exports.createColumFromOnlyName = exports.createTableHorizontalBorders = exports.convertRawRowOptionsToStandard = exports.evaluateCellText = exports.cellText = void 0;
 const console_utils_1 = require("./console-utils");
 const string_utils_1 = require("./string-utils");
 const table_constants_1 = require("./table-constants");
@@ -8,6 +8,9 @@ const max = (a, b) => Math.max(a, b);
 // takes any input that is given by user and converts to string
 const cellText = (text) => text === undefined || text === null ? '' : `${text}`;
 exports.cellText = cellText;
+// evaluate cell text with defined transform
+const evaluateCellText = (text, transform) => (transform ? `${transform(text)}` : (0, exports.cellText)(text));
+exports.evaluateCellText = evaluateCellText;
 const convertRawRowOptionsToStandard = (options) => {
     if (options) {
         return {
@@ -18,7 +21,8 @@ const convertRawRowOptionsToStandard = (options) => {
     return undefined;
 };
 exports.convertRawRowOptionsToStandard = convertRawRowOptionsToStandard;
-const createTableHorizontalBorders = ({ left, mid, right, other, }, column_lengths) => {
+// ({ left: "╚", mid: "╩", right: "╝", other: "═" }, [5, 10, 7]) => "╚═══════╩════════════╩═════════╝"
+const createTableHorizontalBorders = ({ left, mid, right, other }, column_lengths) => {
     // ╚
     let ret = left;
     // ╚═══════╩═══════════════════════════════════════╩════════╩
@@ -33,40 +37,49 @@ const createTableHorizontalBorders = ({ left, mid, right, other, }, column_lengt
     return ret;
 };
 exports.createTableHorizontalBorders = createTableHorizontalBorders;
+// ("id") => { name: "id", title: "id" }
 const createColumFromOnlyName = (name) => ({
     name,
     title: name,
 });
 exports.createColumFromOnlyName = createColumFromOnlyName;
+// ("green", { id: 1, name: "John" }, true) => { color: "green", separator: true, text: { id: 1, name: "John" } }
 const createRow = (color, text, separator) => ({
     color,
     separator,
     text,
 });
 exports.createRow = createRow;
+// ({ name: "id", title: "ID", minLen: 2 }, [{ text: { id: 1 } }, { text: { id: 100 } }]) => 3
+// Calculates optimal column width based on content and constraints
 const findLenOfColumn = (column, rows, charLength) => {
     const columnId = column.name;
     const columnTitle = column.title;
+    const datatransform = column.transform;
     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, charLength)));
-        length = rows.reduce((acc, row) => max(acc, (0, string_utils_1.biggestWordInSentence)((0, exports.cellText)(row.text[columnId]), charLength)), length);
+        length = rows.reduce((acc, row) => max(acc, (0, string_utils_1.biggestWordInSentence)((0, exports.evaluateCellText)(row.text[columnId], datatransform), charLength)), length);
         return length;
     }
     length = max(length, (0, console_utils_1.findWidthInConsole)(columnTitle, charLength));
     rows.forEach((row) => {
-        length = max(length, (0, console_utils_1.findWidthInConsole)((0, exports.cellText)(row.text[columnId]), charLength));
+        length = max(length, (0, console_utils_1.findWidthInConsole)((0, exports.evaluateCellText)(row.text[columnId], datatransform), charLength));
     });
     return length;
 };
 exports.findLenOfColumn = findLenOfColumn;
+// ({ left: "╚", mid: "╩", right: "╝", other: "═" }, [5, 10, 7]) => "╚═══════╩════════════╩═════════╝"
+// (undefined, [5, 10, 7]) => ""
 const renderTableHorizontalBorders = (style, column_lengths) => {
     const str = (0, exports.createTableHorizontalBorders)(style, column_lengths);
     return str;
 };
 exports.renderTableHorizontalBorders = renderTableHorizontalBorders;
+// (createRow, [{ name: "id", title: "ID" }, { name: "name", title: "Name" }]) =>
+// { color: "white_bold", separator: false, text: { id: "ID", name: "Name" } }
 const createHeaderAsRow = (createRowFn, columns) => {
     const headerColor = table_constants_1.DEFAULT_HEADER_FONT_COLOR;
     const row = createRowFn(headerColor, {}, false);
@@ -76,7 +89,8 @@ const createHeaderAsRow = (createRowFn, columns) => {
     return row;
 };
 exports.createHeaderAsRow = createHeaderAsRow;
-// { col1: ['How', 'Is', 'Going'], col2: ['I am', 'Tom'],  }
+// ([{ name: "desc", length: 10 }], { text: { desc: "This is a long description" } })
+// => { desc: ["This is a", "long", "description"] }
 const getWidthLimitedColumnsArray = (columns, row, charLength) => {
     const ret = {};
     columns.forEach((column) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "console-table-printer",
-  "version": "2.14.6",
+  "version": "2.15.0",
   "repository": "github:console-table-printer/console-table-printer",
   "description": "Printing pretty tables on console log",
   "main": "dist/index.js",
@@ -26,25 +26,25 @@
   "author": "Nahiyan Kamal",
   "license": "MIT",
   "devDependencies": {
-    "@eslint/js": "^9.28.0",
+    "@eslint/js": "^9.38.0",
     "@semantic-release/changelog": "^6.0.3",
     "@semantic-release/git": "^10.0.1",
-    "@types/jest": "^29.5.14",
-    "@types/node": "^24.0.3",
-    "eslint": "^9.28.0",
-    "eslint-config-prettier": "^10.1.5",
-    "eslint-plugin-prettier": "^5.4.1",
+    "@types/jest": "^30.0.0",
+    "@types/node": "^24.8.1",
+    "eslint": "^9.38.0",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-plugin-prettier": "^5.5.4",
     "husky": "^9.1.7",
-    "jest": "^29.7.0",
-    "prettier": "^3.5.3",
+    "jest": "^30.2.0",
+    "prettier": "^3.6.2",
     "pretty-quick": "^4.2.2",
-    "semantic-release": "^24.2.5",
-    "ts-jest": "^29.3.4",
-    "typescript": "^5.8.3",
-    "typescript-eslint": "^8.33.1"
+    "semantic-release": "^25.0.1",
+    "ts-jest": "^29.4.5",
+    "typescript": "^5.9.3",
+    "typescript-eslint": "^8.46.1"
   },
   "homepage": "https://console-table.netlify.app",
   "dependencies": {
-    "simple-wcswidth": "^1.0.1"
+    "simple-wcswidth": "^1.1.2"
   }
 }