table 6.7.0 → 6.7.4

package/dist/test/table.js

@@ -0,0 +1,171 @@
+"use strict";
+/* eslint-disable max-nested-callbacks */
+Object.defineProperty(exports, "__esModule", { value: true });
+const chai_1 = require("chai");
+const src_1 = require("../src");
+const utils_1 = require("./utils");
+const data = [
+    ['Lorem ipsum', 'dolor sit'],
+    ['amet', 'consectetur'],
+    ['adipiscing', 'elit'],
+];
+const basicConfig = {
+    columnDefault: {
+        width: 5,
+    },
+};
+describe('drawTable', () => {
+    describe('drawHorizontalLine', () => {
+        context('only draw top and bottom borders', () => {
+            it('draws proper borders', () => {
+                const config = {
+                    ...basicConfig,
+                    drawHorizontalLine: (index, size) => {
+                        return index === 0 || index === size;
+                    },
+                };
+                (0, chai_1.expect)((0, src_1.table)(data, config)).to.be.deep.equal(`
+╔═══════╤═══════╗
+║ Lorem │ dolor ║
+║ ipsum │ sit   ║
+║ amet  │ conse ║
+║       │ ctetu ║
+║       │ r     ║
+║ adipi │ elit  ║
+║ scing │       ║
+╚═══════╧═══════╝
+`.trimLeft());
+            });
+        });
+        context('only draw inner borders', () => {
+            it('draws proper borders', () => {
+                const config = {
+                    ...basicConfig,
+                    drawHorizontalLine: (index, size) => {
+                        return index > 0 && index < size;
+                    },
+                };
+                (0, chai_1.expect)((0, src_1.table)(data, config)).to.be.deep.equal(`
+║ Lorem │ dolor ║
+║ ipsum │ sit   ║
+╟───────┼───────╢
+║ amet  │ conse ║
+║       │ ctetu ║
+║       │ r     ║
+╟───────┼───────╢
+║ adipi │ elit  ║
+║ scing │       ║
+`.trimLeft());
+            });
+        });
+        context('only draw top and next-to-last borders', () => {
+            it('draws proper borders', () => {
+                const config = {
+                    ...basicConfig,
+                    drawHorizontalLine: (index, size) => {
+                        return index === 0 || index === size - 1;
+                    },
+                };
+                (0, chai_1.expect)((0, src_1.table)(data, config)).to.be.deep.equal(`
+╔═══════╤═══════╗
+║ Lorem │ dolor ║
+║ ipsum │ sit   ║
+║ amet  │ conse ║
+║       │ ctetu ║
+║       │ r     ║
+╟───────┼───────╢
+║ adipi │ elit  ║
+║ scing │       ║
+`.trimLeft());
+            });
+        });
+    });
+    context('header', () => {
+        it('draw properly', () => {
+            const config = {
+                ...basicConfig,
+                header: {
+                    content: 'This is the long long header',
+                },
+            };
+            (0, chai_1.expect)((0, src_1.table)(data, config)).to.be.deep.equal(`
+╔═══════════════╗
+║ This is the l ║
+║ ong long head ║
+║      er       ║
+╟───────┬───────╢
+║ Lorem │ dolor ║
+║ ipsum │ sit   ║
+╟───────┼───────╢
+║ amet  │ conse ║
+║       │ ctetu ║
+║       │ r     ║
+╟───────┼───────╢
+║ adipi │ elit  ║
+║ scing │       ║
+╚═══════╧═══════╝
+`.trimLeft());
+        });
+    });
+    context('vertical alignment', () => {
+        // eslint-disable-next-line @typescript-eslint/no-shadow
+        const data = [
+            ['Lorem ipsum dolor sit amet, consectetur adipiscing elit',
+                'Phasellus pulvinar nibh sed',
+                'Phasellus pulvinar nibh sed',
+                'Phasellus pulvinar nibh sed'],
+        ];
+        it('works properly', () => {
+            const result = (0, src_1.table)(data, {
+                columnDefault: {
+                    width: 10,
+                },
+                columns: [
+                    {},
+                    { verticalAlignment: 'top' },
+                    { verticalAlignment: 'middle' },
+                    { verticalAlignment: 'bottom' }
+                ],
+            });
+            (0, utils_1.expectTable)(result, `
+╔════════════╤════════════╤════════════╤════════════╗
+║ Lorem ipsu │ Phasellus  │            │            ║
+║ m dolor si │ pulvinar n │ Phasellus  │            ║
+║ t amet, co │ ibh sed    │ pulvinar n │            ║
+║ nsectetur  │            │ ibh sed    │ Phasellus  ║
+║ adipiscing │            │            │ pulvinar n ║
+║ elit       │            │            │ ibh sed    ║
+╚════════════╧════════════╧════════════╧════════════╝`);
+        });
+        it('works with horizontal alignment', () => {
+            const result = (0, src_1.table)(data, {
+                columnDefault: {
+                    width: 8,
+                    wrapWord: true,
+                },
+                columns: [
+                    {},
+                    { alignment: 'center',
+                        verticalAlignment: 'top' },
+                    { alignment: 'right',
+                        verticalAlignment: 'middle' },
+                    { alignment: 'left',
+                        verticalAlignment: 'bottom' }
+                ],
+            });
+            (0, utils_1.expectTable)(result, `
+╔══════════╤══════════╤══════════╤══════════╗
+║ Lorem    │ Phasellu │          │          ║
+║ ipsum    │    s     │          │          ║
+║ dolor    │ pulvinar │ Phasellu │          ║
+║ sit      │ nibh sed │        s │          ║
+║ amet,    │          │ pulvinar │          ║
+║ consecte │          │ nibh sed │ Phasellu ║
+║ tur      │          │          │ s        ║
+║ adipisci │          │          │ pulvinar ║
+║ ng elit  │          │          │ nibh sed ║
+╚══════════╧══════════╧══════════╧══════════╝`);
+        });
+    });
+});
+//# sourceMappingURL=table.js.map

package/dist/test/tableConfigSamples.d.ts

@@ -0,0 +1,5 @@
+import type { TableUserConfig } from '../src';
+export declare const tableConfigSamples: {
+    invalid: unknown[];
+    valid: TableUserConfig[];
+};

package/dist/test/tableConfigSamples.js

@@ -0,0 +1,202 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.tableConfigSamples = void 0;
+exports.tableConfigSamples = {
+    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: { 0: { alignment: 'middle' } } },
+        { columns: { 1: { verticalAlignment: 1 } } },
+        { columns: { 1: { verticalAlignment: '1' } } },
+        { columns: { 0: { verticalAlignment: 'center' } } },
+        { columns: { 1: { width: 0 } } },
+        { columns: { 1: { width: 1.5 } } },
+        { columns: { 1: { width: '5' } } },
+        { columns: { 1: { wrapWord: 1 } } },
+        { columns: { 1: { wrapWord: 'true' } } },
+        { columns: { 1: { truncate: '1' } } },
+        { columns: { 1: { paddingLeft: '1' } } },
+        { columns: { 1: { paddingRight: '1' } } },
+        { columns: [1] },
+        { columns: [''] },
+        { columns: [{ unknown: 1 }] },
+        { columnDefault: 1 },
+        { columnDefault: { unknown: 1 } },
+        { columnDefault: { alignment: 1 } },
+        { columnDefault: { alignment: '1' } },
+        { columnDefault: { alignment: 'middle' } },
+        { columnDefault: { verticalAlignment: 1 } },
+        { columnDefault: { verticalAlignment: '1' } },
+        { columnDefault: { verticalAlignment: 'center' } },
+        { columnDefault: { width: 0 } },
+        { columnDefault: { width: 1.5 } },
+        { columnDefault: { width: '5' } },
+        { columnDefault: { wrapWord: 1 } },
+        { columnDefault: { wrapWord: 'true' } },
+        { columnDefault: { truncate: '1' } },
+        { columnDefault: { paddingLeft: '1' } },
+        { columnDefault: { paddingRight: '1' } },
+        { drawHorizontalLine: 1 },
+        { unknown: 1 },
+        { header: 'a' },
+        { header: { unknown: 'x' } },
+        { header: { content: 1 } },
+        { header: { content: 'x',
+                width: 10 } },
+    ],
+    valid: [
+        {},
+        {
+            columns: {
+                0: {
+                    alignment: 'left',
+                    verticalAlignment: 'bottom',
+                    width: 10,
+                },
+                1: {
+                    alignment: 'center',
+                    verticalAlignment: 'middle',
+                    width: 10,
+                },
+                2: {
+                    alignment: 'right',
+                    verticalAlignment: 'top',
+                    width: 10,
+                },
+            },
+        },
+        {
+            border: {
+                bodyJoin: '│',
+                bodyLeft: '│',
+                bodyRight: '│',
+                bottomBody: '─',
+                bottomJoin: '┴',
+                bottomLeft: '└',
+                bottomRight: '┘',
+                joinBody: '─',
+                joinJoin: '┼',
+                joinLeft: '├',
+                joinRight: '┤',
+                topBody: '─',
+                topJoin: '┬',
+                topLeft: '┌',
+                topRight: '┐',
+            },
+        },
+        {
+            columns: {
+                0: {
+                    paddingLeft: 3,
+                },
+                1: {
+                    paddingRight: 3,
+                    width: 2,
+                },
+            },
+        },
+        {
+            border: {},
+            columnDefault: {
+                paddingLeft: 0,
+                paddingRight: 1,
+            },
+            drawHorizontalLine: () => {
+                return false;
+            },
+        },
+        {
+            columnDefault: {
+                width: 50,
+            },
+            columns: {
+                0: {
+                    alignment: 'right',
+                    width: 10,
+                },
+                1: {
+                    alignment: 'center',
+                },
+                2: {
+                    width: 10,
+                },
+            },
+        },
+        { columns: { 0: { alignment: 'left' } } },
+        { columns: { 1: { alignment: 'right' } } },
+        { columns: { 2: { alignment: 'center' } } },
+        { columns: { 3: { alignment: 'justify' } } },
+        { columns: { 0: { verticalAlignment: 'top' } } },
+        { columns: { 1: { verticalAlignment: 'middle' } } },
+        { columns: { 2: { verticalAlignment: 'bottom' } } },
+        { 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: 1 } } },
+        { columns: { 1: { width: 5 } } },
+        { columns: { 1: { wrapWord: true } } },
+        { columns: { 1: { wrapWord: false } } },
+        { columns: { 1: { truncate: 1 } } },
+        { columns: { 1: { paddingLeft: 1 } } },
+        { columns: { 1: { paddingRight: 1 } } },
+        { columns: [] },
+        { columns: [{ width: 5 }] },
+        { columns: [{ wrapWord: true }, { truncate: 1 }] },
+        { columns: [{ paddingLeft: 1 }, { paddingRight: 1 }, { alignment: 'right' }] },
+        { columnDefault: { alignment: 'left' } },
+        { columnDefault: { width: 1 } },
+        { columnDefault: { width: 5 } },
+        { columnDefault: { wrapWord: true } },
+        { columnDefault: { wrapWord: false } },
+        { columnDefault: { truncate: 1 } },
+        { columnDefault: { paddingLeft: 1 } },
+        { columnDefault: { paddingRight: 1 } },
+        { drawHorizontalLine: () => {
+                return false;
+            } },
+        { header: { content: '' } },
+        { header: {
+                alignment: 'justify',
+                content: 'a',
+                paddingLeft: 5,
+                paddingRight: 8,
+                truncate: 3,
+                wrapWord: true,
+            } },
+    ],
+};
+//# sourceMappingURL=tableConfigSamples.js.map

package/dist/test/truncateTableData.d.ts

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

package/dist/test/truncateTableData.js

@@ -0,0 +1,92 @@
+"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 truncateTableData_1 = require("../src/truncateTableData");
+describe('truncateTableData', () => {
+    context('when no given userConfig', () => {
+        it('not truncate at all', () => {
+            const rows = [['a'.repeat(100)]];
+            (0, chai_1.expect)((0, truncateTableData_1.truncateTableData)(rows, (0, makeTableConfig_1.makeTableConfig)(rows, undefined))).to.deep.equal([['a'.repeat(100)]]);
+        });
+    });
+    context('when given truncate value in columnDefault', () => {
+        context('when no given column-specific truncate', () => {
+            it('uses the columnDefault value', () => {
+                const rows = [['a'.repeat(100)]];
+                (0, chai_1.expect)((0, truncateTableData_1.truncateTableData)(rows, (0, makeTableConfig_1.makeTableConfig)(rows, { columnDefault: {
+                        truncate: 20,
+                    } }))).to.deep.equal([['a'.repeat(19) + '…']]);
+            });
+        });
+        context('when given column-specific truncate value', () => {
+            it('uses column-specific truncate value', () => {
+                const rows = [['a'.repeat(100)]];
+                (0, chai_1.expect)((0, truncateTableData_1.truncateTableData)(rows, (0, makeTableConfig_1.makeTableConfig)(rows, {
+                    columnDefault: {
+                        truncate: 20,
+                    },
+                    columns: {
+                        0: {
+                            truncate: 30,
+                        },
+                    },
+                }))).to.deep.equal([['a'.repeat(29) + '…']]);
+            });
+        });
+    });
+    context('when given multiple rows and columns', () => {
+        it('uses corresponding column-specific truncate values or fallback to the default truncate value', () => {
+            const rows = [['a'.repeat(100), 'b'.repeat(100)], ['c'.repeat(100), 'd'.repeat(100)]];
+            (0, chai_1.expect)((0, truncateTableData_1.truncateTableData)(rows, (0, makeTableConfig_1.makeTableConfig)(rows, {
+                columnDefault: {
+                    truncate: 20,
+                },
+                columns: {
+                    0: {
+                        truncate: 30,
+                    },
+                },
+            }))).to.deep.equal([
+                ['a'.repeat(29) + '…', 'b'.repeat(19) + '…'],
+                ['c'.repeat(29) + '…', 'd'.repeat(19) + '…']
+            ]);
+        });
+    });
+    context('edge cases', () => {
+        context('truncate = 0', () => {
+            it('returns ellipsis only', () => {
+                const rows = [['a'.repeat(100)]];
+                (0, chai_1.expect)((0, truncateTableData_1.truncateTableData)(rows, (0, makeTableConfig_1.makeTableConfig)(rows, {
+                    columns: { 0: { truncate: 0 } },
+                }))).to.deep.equal([['…']]);
+            });
+        });
+        context('truncate = 1', () => {
+            it('returns ellipsis only', () => {
+                const rows = [['a'.repeat(100)]];
+                (0, chai_1.expect)((0, truncateTableData_1.truncateTableData)(rows, (0, makeTableConfig_1.makeTableConfig)(rows, {
+                    columns: { 0: { truncate: 1 } },
+                }))).to.deep.equal([['…']]);
+            });
+        });
+        context('truncate = 2', () => {
+            it('returns 2-length string with ellipsis', () => {
+                const rows = [['a'.repeat(100)]];
+                (0, chai_1.expect)((0, truncateTableData_1.truncateTableData)(rows, (0, makeTableConfig_1.makeTableConfig)(rows, {
+                    columns: { 0: { truncate: 2 } },
+                }))).to.deep.equal([['a…']]);
+            });
+        });
+        context('empty string', () => {
+            it('returns empty string', () => {
+                const rows = [['']];
+                (0, chai_1.expect)((0, truncateTableData_1.truncateTableData)(rows, (0, makeTableConfig_1.makeTableConfig)(rows, {
+                    columns: { 0: { truncate: 100 } },
+                }))).to.deep.equal([['']]);
+            });
+        });
+    });
+});
+//# sourceMappingURL=truncateTableData.js.map

package/dist/test/utils.d.ts

@@ -0,0 +1,7 @@
+export declare const openRed = "\u001B[31m";
+export declare const closeRed = "\u001B[39m";
+export declare const openBold = "\u001B[1m";
+export declare const closeBold = "\u001B[22m";
+export declare const stringToRed: (string: string) => string;
+export declare const arrayToRed: (array: string[]) => string[];
+export declare const expectTable: (result: string, expectedResult: string) => void;

package/dist/test/utils.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.expectTable = exports.arrayToRed = exports.stringToRed = exports.closeBold = exports.openBold = exports.closeRed = exports.openRed = void 0;
+const chai_1 = require("chai");
+exports.openRed = '\u001b[31m';
+exports.closeRed = '\u001b[39m';
+exports.openBold = '\u001b[1m';
+exports.closeBold = '\u001b[22m';
+const stringToRed = (string) => {
+    return exports.openRed + string + exports.closeRed;
+};
+exports.stringToRed = stringToRed;
+const arrayToRed = (array) => {
+    return array.map((string) => {
+        return string === '' ? '' : (0, exports.stringToRed)(string);
+    });
+};
+exports.arrayToRed = arrayToRed;
+const expectTable = (result, expectedResult) => {
+    (0, chai_1.expect)(result).to.equal(expectedResult.trim() + '\n');
+};
+exports.expectTable = expectTable;
+//# sourceMappingURL=utils.js.map

package/dist/test/validateConfig.d.ts

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

package/dist/test/validateConfig.js

@@ -0,0 +1,36 @@
+"use strict";
+/* eslint-disable max-nested-callbacks */
+Object.defineProperty(exports, "__esModule", { value: true });
+const chai_1 = require("chai");
+const validateConfig_1 = require("../src/validateConfig");
+describe('validateConfig', () => {
+    context('given invalid config', () => {
+        it('throws an error', () => {
+            (0, chai_1.expect)(() => {
+                (0, validateConfig_1.validateConfig)('config.json', { x: 1 });
+            }).to.be.throw(Error, 'Invalid config.');
+        });
+    });
+    context('given valid config', () => {
+        it('does not throw an error', () => {
+            (0, chai_1.expect)(() => {
+                (0, validateConfig_1.validateConfig)('config.json', {
+                    columnDefault: {
+                        width: 50,
+                    },
+                    columns: {
+                        0: {
+                            alignment: 'left',
+                            width: 10,
+                        },
+                    },
+                    drawHorizontalLine: () => {
+                        return false;
+                    },
+                    singleLine: true,
+                });
+            }).to.be.not.throw();
+        });
+    });
+});
+//# sourceMappingURL=validateConfig.js.map

package/dist/test/validateStreamConfig.d.ts

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

package/dist/test/validateStreamConfig.js

@@ -0,0 +1,39 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const ajv_1 = __importDefault(require("ajv"));
+const ajv_keywords_1 = __importDefault(require("ajv-keywords"));
+const json_schema_draft_06_json_1 = __importDefault(require("ajv/lib/refs/json-schema-draft-06.json"));
+const chai_1 = require("chai");
+const validators_1 = __importDefault(require("../src/generated/validators"));
+const shared_json_1 = __importDefault(require("../src/schemas/shared.json"));
+const streamConfig_json_1 = __importDefault(require("../src/schemas/streamConfig.json"));
+const streamConfigSamples_1 = __importDefault(require("./streamConfigSamples"));
+const validateConfig = validators_1.default['streamConfig.json'];
+describe('streamConfig.json schema', () => {
+    let validate;
+    before(() => {
+        const ajv = new ajv_1.default({
+            allErrors: true,
+        });
+        ajv.addMetaSchema(json_schema_draft_06_json_1.default);
+        (0, ajv_keywords_1.default)(ajv, 'typeof');
+        ajv.addSchema(shared_json_1.default);
+        validate = ajv.compile(streamConfig_json_1.default);
+    });
+    it('passes validation of valid streamConfig samples', () => {
+        for (const sample of streamConfigSamples_1.default.valid) {
+            (0, chai_1.expect)(validate(sample)).to.equal(true);
+            (0, chai_1.expect)(validateConfig(sample)).to.equal(true);
+        }
+    });
+    it('fails validation of invalid streamConfig samples', () => {
+        for (const sample of streamConfigSamples_1.default.invalid) {
+            (0, chai_1.expect)(validate(sample)).to.equal(false);
+            (0, chai_1.expect)(validateConfig(sample)).to.equal(false);
+        }
+    });
+});
+//# sourceMappingURL=validateStreamConfig.js.map

package/dist/test/validateTableConfig.d.ts

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

package/dist/test/validateTableConfig.js

@@ -0,0 +1,35 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const ajv_1 = __importDefault(require("ajv"));
+const ajv_keywords_1 = __importDefault(require("ajv-keywords"));
+const chai_1 = require("chai");
+const validators_1 = __importDefault(require("../src/generated/validators"));
+const config_json_1 = __importDefault(require("../src/schemas/config.json"));
+const shared_json_1 = __importDefault(require("../src/schemas/shared.json"));
+const tableConfigSamples_1 = require("./tableConfigSamples");
+const validateConfig = validators_1.default['config.json'];
+describe('config.json schema', () => {
+    let validate;
+    before(() => {
+        const ajv = new ajv_1.default({ allErrors: true });
+        (0, ajv_keywords_1.default)(ajv, 'typeof');
+        ajv.addSchema(shared_json_1.default);
+        validate = ajv.compile(config_json_1.default);
+    });
+    it('passes validation of valid config samples', () => {
+        for (const sample of tableConfigSamples_1.tableConfigSamples.valid) {
+            (0, chai_1.expect)(validate(sample)).to.equal(true);
+            (0, chai_1.expect)(validateConfig(sample)).to.equal(true);
+        }
+    });
+    it('fails validation of invalid config samples', () => {
+        for (const sample of tableConfigSamples_1.tableConfigSamples.invalid) {
+            (0, chai_1.expect)(validate(sample)).to.equal(false);
+            (0, chai_1.expect)(validateConfig(sample)).to.equal(false);
+        }
+    });
+});
+//# sourceMappingURL=validateTableConfig.js.map

package/dist/test/validateTableData.d.ts

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