table 6.7.0 → 6.7.4

package/dist/test/makeStreamConfig.js

@@ -0,0 +1,106 @@
+"use strict";
+/* eslint-disable max-nested-callbacks */
+Object.defineProperty(exports, "__esModule", { value: true });
+const chai_1 = require("chai");
+const makeStreamConfig_1 = require("../src/makeStreamConfig");
+const baseStreamConfig = {
+    columnCount: 1,
+    columnDefault: {
+        width: 5,
+    },
+};
+describe('makeStreamConfig', () => {
+    it('does not affect the parameter configuration object', () => {
+        (0, makeStreamConfig_1.makeStreamConfig)(baseStreamConfig);
+        (0, chai_1.expect)(baseStreamConfig).to.equal(baseStreamConfig);
+    });
+    context('columnDefault', () => {
+        context('not contains width', () => {
+            it('throws an error', () => {
+                (0, chai_1.expect)(() => {
+                    return (0, makeStreamConfig_1.makeStreamConfig)({ columnCount: 2,
+                        columnDefault: {} });
+                }).to.be.throw('Must provide config.columnDefault.width when creating a stream.');
+            });
+        });
+    });
+    context('column', () => {
+        context('alignment', () => {
+            context('is not provided', () => {
+                it('defaults to "left"', () => {
+                    const config = (0, makeStreamConfig_1.makeStreamConfig)(baseStreamConfig);
+                    (0, chai_1.expect)(config.columns[0].alignment).to.equal('left');
+                });
+            });
+            context('is provided', () => {
+                it('uses the custom value', () => {
+                    const config = (0, makeStreamConfig_1.makeStreamConfig)({ ...baseStreamConfig,
+                        columns: {
+                            0: {
+                                alignment: 'center',
+                            },
+                        } });
+                    (0, chai_1.expect)(config.columns[0].alignment).to.equal('center');
+                });
+            });
+        });
+        context('paddingLeft', () => {
+            context('is not provided', () => {
+                it('defaults to 1', () => {
+                    const config = (0, makeStreamConfig_1.makeStreamConfig)(baseStreamConfig);
+                    (0, chai_1.expect)(config.columns[0].paddingLeft).to.equal(1);
+                });
+            });
+            context('is provided', () => {
+                it('uses the custom value', () => {
+                    const config = (0, makeStreamConfig_1.makeStreamConfig)({ ...baseStreamConfig,
+                        columns: {
+                            0: {
+                                paddingLeft: 3,
+                            },
+                        } });
+                    (0, chai_1.expect)(config.columns[0].paddingLeft).to.equal(3);
+                });
+            });
+        });
+        context('paddingRight', () => {
+            context('is not provided', () => {
+                it('defaults to 1', () => {
+                    const config = (0, makeStreamConfig_1.makeStreamConfig)(baseStreamConfig);
+                    (0, chai_1.expect)(config.columns[0].paddingRight).to.equal(1);
+                });
+            });
+            context('is provided', () => {
+                it('uses the custom value', () => {
+                    const config = (0, makeStreamConfig_1.makeStreamConfig)({ ...baseStreamConfig,
+                        columns: {
+                            0: {
+                                paddingRight: 3,
+                            },
+                        } });
+                    (0, chai_1.expect)(config.columns[0].paddingRight).to.equal(3);
+                });
+            });
+        });
+    });
+    context('"drawVerticalLine', () => {
+        context('is not provided', () => {
+            it('defaults to retuning true', () => {
+                const config = (0, makeStreamConfig_1.makeStreamConfig)(baseStreamConfig);
+                (0, chai_1.expect)(config.drawVerticalLine(-1, -1)).to.equal(true);
+            });
+        });
+        context('is provided', () => {
+            it('uses the custom function', () => {
+                const config = (0, makeStreamConfig_1.makeStreamConfig)({
+                    ...baseStreamConfig,
+                    drawVerticalLine: () => {
+                        return false;
+                    },
+                });
+                (0, chai_1.expect)(config.drawVerticalLine(-1, -1)).to.equal(false);
+            });
+        });
+    });
+});
+//# sourceMappingURL=makeStreamConfig.js.map

package/dist/test/mapDataUsingRowHeights.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/test/mapDataUsingRowHeights.js

@@ -0,0 +1,150 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const chai_1 = require("chai");
+const chalk_1 = __importDefault(require("chalk"));
+const makeTableConfig_1 = require("../src/makeTableConfig");
+const mapDataUsingRowHeights_1 = require("../src/mapDataUsingRowHeights");
+describe('mapDataUsingRowHeights', () => {
+    context('no data spans multiple rows', () => {
+        it('maps data to a single cell', () => {
+            const rowHeights = [1];
+            const data = [
+                ['aa'],
+            ];
+            const config = (0, makeTableConfig_1.makeTableConfig)(data, {
+                columns: {
+                    0: {
+                        width: 2,
+                    },
+                },
+            });
+            const mappedData = (0, mapDataUsingRowHeights_1.mapDataUsingRowHeights)(data, rowHeights, config);
+            (0, chai_1.expect)(mappedData).to.deep.equal([
+                ['aa'],
+            ]);
+        });
+    });
+    context('single cell spans multiple rows', () => {
+        it('maps data to multiple rows', () => {
+            const rowHeights = [5];
+            const data = [
+                ['aabbccddee'],
+            ];
+            const config = (0, makeTableConfig_1.makeTableConfig)(data, {
+                columns: {
+                    0: {
+                        width: 2,
+                    },
+                },
+            });
+            const mappedData = (0, mapDataUsingRowHeights_1.mapDataUsingRowHeights)(data, rowHeights, config);
+            (0, chai_1.expect)(mappedData).to.deep.equal([
+                ['aa'],
+                ['bb'],
+                ['cc'],
+                ['dd'],
+                ['ee'],
+            ]);
+        });
+    });
+    context('single cell contains newlines', () => {
+        it('maps data to multiple rows', () => {
+            const rowHeights = [5];
+            const data = [
+                [
+                    'aa\nbb\ncc\ndd\nee',
+                ],
+            ];
+            const config = (0, makeTableConfig_1.makeTableConfig)(data, {
+                columns: {
+                    0: {
+                        width: 100,
+                    },
+                },
+            });
+            const mappedData = (0, mapDataUsingRowHeights_1.mapDataUsingRowHeights)(data, rowHeights, config);
+            (0, chai_1.expect)(mappedData).to.deep.equal([
+                ['aa'],
+                ['bb'],
+                ['cc'],
+                ['dd'],
+                ['ee'],
+            ]);
+        });
+        it('maps data with color coding to multiple rows', () => {
+            const rowHeights = [
+                5,
+            ];
+            const data = [
+                [
+                    chalk_1.default.red('aa\nbb\ncc\ndd\nee'),
+                ],
+            ];
+            const config = (0, makeTableConfig_1.makeTableConfig)(data, {
+                columns: {
+                    0: {
+                        width: 100,
+                    },
+                },
+            });
+            const mappedData = (0, mapDataUsingRowHeights_1.mapDataUsingRowHeights)(data, rowHeights, config);
+            (0, chai_1.expect)(mappedData).to.deep.equal([
+                [chalk_1.default.red('aa')],
+                [chalk_1.default.red('bb')],
+                [chalk_1.default.red('cc')],
+                [chalk_1.default.red('dd')],
+                [chalk_1.default.red('ee')],
+            ]);
+        });
+    });
+    context('multiple cells spans multiple rows', () => {
+        it('maps data to multiple rows', () => {
+            const rowHeights = [
+                5,
+            ];
+            const data = [
+                [
+                    'aabbccddee',
+                    '00001111',
+                ],
+            ];
+            const config = (0, makeTableConfig_1.makeTableConfig)(data, {
+                columns: {
+                    0: {
+                        width: 2,
+                    },
+                    1: {
+                        width: 4,
+                    },
+                },
+            });
+            const mappedData = (0, mapDataUsingRowHeights_1.mapDataUsingRowHeights)(data, rowHeights, config);
+            (0, chai_1.expect)(mappedData).to.deep.equal([
+                [
+                    'aa',
+                    '0000',
+                ],
+                [
+                    'bb',
+                    '1111',
+                ],
+                [
+                    'cc',
+                    '',
+                ],
+                [
+                    'dd',
+                    '',
+                ],
+                [
+                    'ee',
+                    '',
+                ],
+            ]);
+        });
+    });
+});
+//# sourceMappingURL=mapDataUsingRowHeights.js.map

package/dist/test/padTableData.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/test/padTableData.js

@@ -0,0 +1,62 @@
+"use strict";
+/* eslint-disable max-nested-callbacks */
+Object.defineProperty(exports, "__esModule", { value: true });
+const chai_1 = require("chai");
+const makeTableConfig_1 = require("../src/makeTableConfig");
+const padTableData_1 = require("../src/padTableData");
+describe('padTableData', () => {
+    context('when no given userConfig', () => {
+        it('inserts 01 whitespace character regardless of string whitespaces', () => {
+            const rows = [[' a  ']];
+            (0, chai_1.expect)((0, padTableData_1.padTableData)(rows, (0, makeTableConfig_1.makeTableConfig)(rows, undefined))).to.deep.equal([['  a   ']]);
+        });
+    });
+    context('when given paddings in columnDefault', () => {
+        context('when no given column-specific paddings', () => {
+            it('uses the columnDefault values', () => {
+                const rows = [['a']];
+                (0, chai_1.expect)((0, padTableData_1.padTableData)(rows, (0, makeTableConfig_1.makeTableConfig)(rows, { columnDefault: {
+                        paddingLeft: 2,
+                        paddingRight: 3,
+                    } }))).to.deep.equal([['  a   ']]);
+            });
+        });
+        context('when given column-specific padding values', () => {
+            it('uses column-specific padding values', () => {
+                const rows = [['a']];
+                (0, chai_1.expect)((0, padTableData_1.padTableData)(rows, (0, makeTableConfig_1.makeTableConfig)(rows, {
+                    columnDefault: {
+                        paddingLeft: 2,
+                        paddingRight: 3,
+                    },
+                    columns: {
+                        0: {
+                            paddingLeft: 4,
+                            paddingRight: 5,
+                        },
+                    },
+                }))).to.deep.equal([['    a     ']]);
+            });
+        });
+    });
+    context('when given multiple rows and columns', () => {
+        it('uses corresponding column-specific padding values or fallback to the default padding values', () => {
+            const rows = [['a', 'b'], ['c', 'd']];
+            (0, chai_1.expect)((0, padTableData_1.padTableData)(rows, (0, makeTableConfig_1.makeTableConfig)(rows, {
+                columnDefault: {
+                    paddingLeft: 2,
+                    paddingRight: 3,
+                },
+                columns: {
+                    0: {
+                        paddingLeft: 4,
+                    },
+                    1: {
+                        paddingRight: 5,
+                    },
+                },
+            }))).to.deep.equal([['    a   ', '  b     '], ['    c   ', '  d     ']]);
+        });
+    });
+});
+//# sourceMappingURL=padTableData.js.map

package/dist/test/streamConfigSamples.d.ts

@@ -0,0 +1,6 @@
+import type { StreamUserConfig } from '../src';
+declare const streamConfigSamples: {
+    invalid: unknown[];
+    valid: StreamUserConfig[];
+};
+export default streamConfigSamples;

package/dist/test/streamConfigSamples.js

@@ -0,0 +1,287 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const streamConfigSamples = {
+    invalid: [
+        {},
+        { border: 1 },
+        { border: { unknown: '-' } },
+        { border: { topBody: 1 } },
+        { border: { topJoin: 1 } },
+        { border: { topLeft: 1 } },
+        { border: { topRight: 1 } },
+        { border: { bottomBody: 1 } },
+        { border: { bottomJoin: 1 } },
+        { border: { bottomLeft: 1 } },
+        { border: { bottomRight: 1 } },
+        { border: { bodyLeft: 1 } },
+        { border: { bodyRight: 1 } },
+        { border: { bodyJoin: 1 } },
+        { border: { joinBody: 1 } },
+        { border: { joinLeft: 1 } },
+        { border: { joinRight: 1 } },
+        { border: { joinJoin: 1 } },
+        { columns: 1 },
+        { columns: { a: { width: 5 } } },
+        { columns: { 1: 1 } },
+        { columns: { 1: { unknown: 1 } } },
+        { columns: { 1: { alignment: 1 } } },
+        { columns: { 1: { alignment: '1' } } },
+        { columns: { 1: { width: '5' } } },
+        { columns: { 1: { wrapWord: 1 } } },
+        { columns: { 1: { truncate: '1' } } },
+        { columns: { 1: { paddingLeft: '1' } } },
+        { columns: { 1: { paddingRight: '1' } } },
+        { columnCount: 3,
+            columnDefault: {
+                width: 50,
+            },
+            columns: [1] },
+        { columnCount: 3,
+            columnDefault: {
+                width: 50,
+            },
+            columns: [''] },
+        { columnCount: 3,
+            columnDefault: {
+                width: 50,
+            },
+            columns: [{ unknown: 1 }] },
+        { columnDefault: 1 },
+        { columnDefault: { unknown: 1 } },
+        { columnDefault: { alignment: 1 } },
+        { columnDefault: { alignment: '1' } },
+        { columnDefault: { width: '5' } },
+        { columnDefault: { wrapWord: 1 } },
+        { columnDefault: { truncate: '1' } },
+        { columnDefault: { paddingLeft: '1' } },
+        { columnDefault: { paddingRight: '1' } },
+        { unknown: 1 },
+        {
+            columnCount: 3,
+            columnDefault: { width: 20 },
+            columns: { 0: { alignment: 'middle' } },
+        },
+        {
+            columnCount: 3,
+            columnDefault: { width: 20,
+                wrapWord: 'true' },
+        },
+        {
+            columnCount: 3,
+            columnDefault: { width: 20 },
+            columns: { 0: { wrapWord: 'true' } },
+        },
+        {
+            columnCount: 3,
+            columnDefault: { width: 20 },
+            columns: { 0: { wrapWord: 1 } },
+        },
+        {
+            columnCount: 1,
+            columnDefault: { width: 2 },
+            columns: { 0: { width: 0 } },
+        },
+        {
+            columnCount: 1,
+            columnDefault: { width: 2 },
+            columns: { 0: { width: 1.5 } },
+        },
+        {
+            columnCount: 1,
+            columnDefault: { width: 0 },
+        },
+        {
+            columnCount: 1,
+            columnDefault: { width: 1.5 },
+        },
+        { border: { topBody: '-' } },
+        { border: { topJoin: '-' } },
+        { border: { topLeft: '-' } },
+        { border: { topRight: '-' } },
+        { border: { bottomBody: '-' } },
+        { border: { bottomJoin: '-' } },
+        { border: { bottomLeft: '-' } },
+        { border: { bottomRight: '-' } },
+        { border: { bodyLeft: '-' } },
+        { border: { bodyRight: '-' } },
+        { border: { bodyJoin: '-' } },
+        { border: { joinBody: '-' } },
+        { border: { joinLeft: '-' } },
+        { border: { joinRight: '-' } },
+        { border: { joinJoin: '-' } },
+        { columns: { 1: { alignment: 'left' } } },
+        { columns: { 1: { width: 5 } } },
+        { columns: { 1: { wrapWord: true } } },
+        { columns: { 1: { truncate: 1 } } },
+        { columns: { 1: { paddingLeft: 1 } } },
+        { columns: { 1: { paddingRight: 1 } } },
+        { columnDefault: { alignment: 'left' } },
+        { columnDefault: { width: 5 } },
+        { columnDefault: { wrapWord: true } },
+        { columnDefault: { truncate: 1 } },
+        { columnDefault: { paddingLeft: 1 } },
+        { columnDefault: { paddingRight: 1 } },
+    ],
+    valid: [
+        {
+            columnCount: 1,
+            columnDefault: { width: 1 },
+        },
+        {
+            columnCount: 3,
+            columnDefault: { width: 20 },
+        },
+        {
+            columnCount: 1,
+            columnDefault: { width: 1 },
+            columns: { 0: { width: 1 } },
+        },
+        {
+            columnCount: 1,
+            columnDefault: { width: 5 },
+            columns: { 0: { width: 5 } },
+        },
+        {
+            columnCount: 3,
+            columnDefault: { width: 20 },
+            columns: { 0: { alignment: 'left' } },
+        },
+        {
+            columnCount: 3,
+            columnDefault: { width: 20 },
+            columns: { 1: { alignment: 'right' } },
+        },
+        {
+            columnCount: 3,
+            columnDefault: { width: 20 },
+            columns: { 2: { alignment: 'center' } },
+        },
+        {
+            columnCount: 3,
+            columnDefault: { width: 20 },
+            columns: { 2: { alignment: 'justify' } },
+        },
+        {
+            columnCount: 3,
+            columnDefault: {
+                width: 20,
+            },
+            columns: {
+                0: {
+                    alignment: 'left',
+                    width: 10,
+                },
+                1: {
+                    alignment: 'center',
+                    width: 10,
+                },
+                2: {
+                    alignment: 'right',
+                    width: 10,
+                },
+            },
+        },
+        {
+            border: {
+                bodyJoin: '│',
+                bodyLeft: '│',
+                bodyRight: '│',
+                bottomBody: '─',
+                bottomJoin: '┴',
+                bottomLeft: '└',
+                bottomRight: '┘',
+                joinBody: '─',
+                joinJoin: '┼',
+                joinLeft: '├',
+                joinRight: '┤',
+                topBody: '─',
+                topJoin: '┬',
+                topLeft: '┌',
+                topRight: '┐',
+            },
+            columnCount: 1,
+            columnDefault: {
+                width: 10,
+            },
+        },
+        {
+            columnCount: 1,
+            columnDefault: {
+                width: 2,
+            },
+            columns: {
+                0: {
+                    paddingLeft: 3,
+                },
+                1: {
+                    paddingRight: 3,
+                    width: 2,
+                },
+            },
+        },
+        {
+            border: {},
+            columnCount: 1,
+            columnDefault: {
+                paddingLeft: 0,
+                paddingRight: 1,
+                width: 2,
+            },
+        },
+        {
+            columnCount: 3,
+            columnDefault: {
+                width: 50,
+            },
+            columns: {
+                0: {
+                    alignment: 'right',
+                    width: 10,
+                },
+                1: {
+                    alignment: 'center',
+                },
+                2: {
+                    width: 10,
+                },
+            },
+        },
+        {
+            columnCount: 3,
+            columnDefault: { width: 20,
+                wrapWord: true },
+        },
+        {
+            columnCount: 3,
+            columnDefault: { width: 20 },
+            columns: { 0: { wrapWord: true } },
+        },
+        {
+            columnCount: 3,
+            columnDefault: { width: 20 },
+            columns: { 0: { wrapWord: false } },
+        },
+        { columnCount: 3,
+            columnDefault: {
+                width: 50,
+            },
+            columns: [] },
+        { columnCount: 3,
+            columnDefault: {
+                width: 50,
+            },
+            columns: [{ width: 5 }] },
+        { columnCount: 3,
+            columnDefault: {
+                width: 50,
+            },
+            columns: [{ wrapWord: true }, { truncate: 1 }] },
+        { columnCount: 3,
+            columnDefault: {
+                width: 50,
+            },
+            columns: [{ paddingLeft: 1 }, { paddingRight: 1 }, { alignment: 'right' }] },
+    ],
+};
+exports.default = streamConfigSamples;
+//# sourceMappingURL=streamConfigSamples.js.map

package/dist/test/stringifyTableData.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/test/stringifyTableData.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const chai_1 = require("chai");
+const stringifyTableData_1 = require("../src/stringifyTableData");
+describe('stringifyTableData', () => {
+    it('converts all cell values to strings', () => {
+        const rows = [[null, undefined, true, false],
+            [0, -3.14159, Number.NaN, Number.POSITIVE_INFINITY],
+            [['a', 'b'], { cd: 1 }]];
+        (0, chai_1.expect)((0, stringifyTableData_1.stringifyTableData)(rows)).to.deep.equal([
+            ['null', 'undefined', 'true', 'false'],
+            ['0', '-3.14159', 'NaN', 'Infinity'],
+            ['a,b', '[object Object]'],
+        ]);
+    });
+});
+//# sourceMappingURL=stringifyTableData.js.map

package/dist/test/table.d.ts

@@ -0,0 +1 @@
+export {};