table 6.7.3 → 6.7.4

package/dist/test/drawBorder.js

@@ -0,0 +1,139 @@
+"use strict";
+/* eslint-disable sort-keys-fix/sort-keys-fix */
+Object.defineProperty(exports, "__esModule", { value: true });
+const chai_1 = require("chai");
+const drawBorder_1 = require("../src/drawBorder");
+const makeTableConfig_1 = require("../src/makeTableConfig");
+const defaultDrawVerticalLine = () => {
+    return true;
+};
+const customDrawVerticalLine = (index, size) => {
+    return index === size - 1;
+};
+context('drawBorder', () => {
+    it('draws a border using parts', () => {
+        const config = {
+            drawVerticalLine: defaultDrawVerticalLine,
+            separator: {
+                left: '╔',
+                right: '╗',
+                body: '═',
+                join: '╤',
+            },
+        };
+        (0, chai_1.expect)((0, drawBorder_1.drawBorder)([1], config)).to.equal('╔═╗\n');
+        (0, chai_1.expect)((0, drawBorder_1.drawBorder)([1, 1], config)).to.equal('╔═╤═╗\n');
+        (0, chai_1.expect)((0, drawBorder_1.drawBorder)([5, 10], config)).to.equal('╔═════╤══════════╗\n');
+        (0, chai_1.expect)((0, drawBorder_1.drawBorder)([5, 10], {
+            ...config,
+            drawVerticalLine: customDrawVerticalLine,
+        })).to.equal('═════╤══════════\n');
+    });
+});
+context('drawBorderTop', () => {
+    it('draws a border using parts', () => {
+        const config = {
+            border: {
+                topLeft: '╔',
+                topRight: '╗',
+                topBody: '═',
+                topJoin: '╤',
+            },
+            drawVerticalLine: defaultDrawVerticalLine,
+        };
+        (0, chai_1.expect)((0, drawBorder_1.drawBorderTop)([1], config)).to.equal('╔═╗\n');
+        (0, chai_1.expect)((0, drawBorder_1.drawBorderTop)([1, 1], config)).to.equal('╔═╤═╗\n');
+        (0, chai_1.expect)((0, drawBorder_1.drawBorderTop)([5, 10], config)).to.equal('╔═════╤══════════╗\n');
+        (0, chai_1.expect)((0, drawBorder_1.drawBorderTop)([5, 10], {
+            ...config,
+            drawVerticalLine: customDrawVerticalLine,
+        })).to.equal('═════╤══════════\n');
+    });
+    it('no leading new line if borderless', () => {
+        const config = {
+            border: {
+                topLeft: '',
+                topRight: '',
+                topBody: '',
+                topJoin: '',
+            },
+            drawVerticalLine: defaultDrawVerticalLine,
+        };
+        (0, chai_1.expect)((0, drawBorder_1.drawBorderTop)([1], config)).to.equal('');
+        (0, chai_1.expect)((0, drawBorder_1.drawBorderTop)([1, 1], config)).to.equal('');
+        (0, chai_1.expect)((0, drawBorder_1.drawBorderTop)([5, 10], config)).to.equal('');
+        (0, chai_1.expect)((0, drawBorder_1.drawBorderTop)([5, 10], {
+            ...config,
+            drawVerticalLine: customDrawVerticalLine,
+        })).to.equal('');
+    });
+});
+context('drawBorderJoin', () => {
+    it('draws a border using parts', () => {
+        const config = {
+            border: {
+                joinBody: '─',
+                joinLeft: '╟',
+                joinRight: '╢',
+                joinJoin: '┼',
+            },
+            drawVerticalLine: defaultDrawVerticalLine,
+        };
+        (0, chai_1.expect)((0, drawBorder_1.drawBorderJoin)([1], config)).to.equal('╟─╢\n');
+        (0, chai_1.expect)((0, drawBorder_1.drawBorderJoin)([1, 1], config)).to.equal('╟─┼─╢\n');
+        (0, chai_1.expect)((0, drawBorder_1.drawBorderJoin)([5, 10], config)).to.equal('╟─────┼──────────╢\n');
+        (0, chai_1.expect)((0, drawBorder_1.drawBorderJoin)([5, 10], {
+            ...config,
+            drawVerticalLine: customDrawVerticalLine,
+        })).to.equal('─────┼──────────\n');
+    });
+});
+context('drawBorderBottom', () => {
+    it('draws a border using parts', () => {
+        const config = {
+            border: {
+                bottomBody: '═',
+                bottomJoin: '╧',
+                bottomLeft: '╚',
+                bottomRight: '╝',
+            },
+            drawVerticalLine: defaultDrawVerticalLine,
+        };
+        (0, chai_1.expect)((0, drawBorder_1.drawBorderBottom)([1], config)).to.equal('╚═╝\n');
+        (0, chai_1.expect)((0, drawBorder_1.drawBorderBottom)([1, 1], config)).to.equal('╚═╧═╝\n');
+        (0, chai_1.expect)((0, drawBorder_1.drawBorderBottom)([5, 10], config)).to.equal('╚═════╧══════════╝\n');
+        (0, chai_1.expect)((0, drawBorder_1.drawBorderBottom)([5, 10], {
+            ...config,
+            drawVerticalLine: customDrawVerticalLine,
+        })).to.equal('═════╧══════════\n');
+    });
+});
+context('tableBorderGetter', () => {
+    context('when config.header is undefined', () => {
+        it('draw the table border normally', () => {
+            const config = (0, makeTableConfig_1.makeTableConfig)([['a', 'b', 'c']], {
+                header: undefined,
+            });
+            const getter = (0, drawBorder_1.createTableBorderGetter)([2, 1, 3], config);
+            (0, chai_1.expect)(getter(0, 3)).to.equal('╔══╤═╤═══╗\n');
+            (0, chai_1.expect)(getter(1, 3)).to.equal('╟──┼─┼───╢\n');
+            (0, chai_1.expect)(getter(2, 3)).to.equal('╟──┼─┼───╢\n');
+            (0, chai_1.expect)(getter(3, 3)).to.equal('╚══╧═╧═══╝\n');
+        });
+    });
+    context('when config.header is defined', () => {
+        it('draws the borders that modify for header', () => {
+            const config = (0, makeTableConfig_1.makeTableConfig)([['a', 'b', 'c']], {
+                header: {
+                    content: 'ddd',
+                },
+            });
+            const getter = (0, drawBorder_1.createTableBorderGetter)([2, 1, 3], config);
+            (0, chai_1.expect)(getter(0, 3)).to.equal('╔════════╗\n');
+            (0, chai_1.expect)(getter(1, 3)).to.equal('╟──┬─┬───╢\n');
+            (0, chai_1.expect)(getter(2, 3)).to.equal('╟──┼─┼───╢\n');
+            (0, chai_1.expect)(getter(3, 3)).to.equal('╚══╧═╧═══╝\n');
+        });
+    });
+});
+//# sourceMappingURL=drawBorder.js.map

package/dist/test/drawHeader.d.ts

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

package/dist/test/drawHeader.js

@@ -0,0 +1,172 @@
+"use strict";
+/* eslint-disable max-nested-callbacks */
+Object.defineProperty(exports, "__esModule", { value: true });
+const chai_1 = require("chai");
+const drawHeader_1 = require("../src/drawHeader");
+const makeTableConfig_1 = require("../src/makeTableConfig");
+const utils_1 = require("./utils");
+const basicContent = 'Lorem ipsum dolor sit amet';
+const basicRows = [['aaa', 'bb', 'c']];
+const createHeader = (headerWidth = 7, headerConfig) => {
+    const config = (0, makeTableConfig_1.makeTableConfig)(basicRows, {
+        header: headerConfig,
+    });
+    return (0, drawHeader_1.drawHeader)(headerWidth, config);
+};
+context('drawHeader', () => {
+    context('when no given header', () => {
+        it('throws an error', () => {
+            const config = (0, makeTableConfig_1.makeTableConfig)(basicRows, {
+                header: undefined,
+            });
+            (0, chai_1.expect)(() => {
+                return (0, drawHeader_1.drawHeader)(7, config);
+            }).to.throw('Can not draw header without header configuration');
+        });
+    });
+    context('width', () => {
+        it('forces to the given width', () => {
+            const header = createHeader(7, {
+                content: basicContent,
+            });
+            (0, chai_1.expect)(header).to.equal(`
+║ Lorem i ║
+║ psum do ║
+║ lor sit ║
+║  amet   ║
+`.trimLeft());
+        });
+    });
+    context('truncate', () => {
+        it('truncates to the truncation value', () => {
+            const header = createHeader(7, {
+                content: basicContent,
+                truncate: 7,
+            });
+            (0, chai_1.expect)(header).to.equal('║ Lorem … ║\n');
+        });
+    });
+    context('wrapWord', () => {
+        context('wrapWord = false', () => {
+            it('slices to the given width', () => {
+                const header = createHeader(7, {
+                    content: basicContent,
+                    wrapWord: false,
+                });
+                (0, chai_1.expect)(header).to.equal(`
+║ Lorem i ║
+║ psum do ║
+║ lor sit ║
+║  amet   ║
+`.trimLeft());
+            });
+        });
+        context('wrapWord = true', () => {
+            it('wraps word properly', () => {
+                const header = createHeader(7, {
+                    content: basicContent,
+                    wrapWord: true,
+                });
+                (0, chai_1.expect)(header).to.equal(`
+║  Lorem  ║
+║  ipsum  ║
+║  dolor  ║
+║   sit   ║
+║  amet   ║
+`.trimLeft());
+            });
+        });
+    });
+    context('alignment', () => {
+        context('left', () => {
+            it('aligns left', () => {
+                const header = createHeader(7, {
+                    alignment: 'left',
+                    content: basicContent,
+                    wrapWord: true,
+                });
+                (0, chai_1.expect)(header).to.equal(`
+║ Lorem   ║
+║ ipsum   ║
+║ dolor   ║
+║ sit     ║
+║ amet    ║
+`.trimLeft());
+            });
+        });
+        context('center', () => {
+            it('aligns center', () => {
+                const header = createHeader(7, {
+                    alignment: 'center',
+                    content: basicContent,
+                    wrapWord: true,
+                });
+                (0, chai_1.expect)(header).to.equal(`
+║  Lorem  ║
+║  ipsum  ║
+║  dolor  ║
+║   sit   ║
+║  amet   ║
+`.trimLeft());
+            });
+        });
+        context('right', () => {
+            it('aligns right', () => {
+                const header = createHeader(7, {
+                    alignment: 'right',
+                    content: basicContent,
+                    wrapWord: true,
+                });
+                (0, chai_1.expect)(header).to.equal(`
+║   Lorem ║
+║   ipsum ║
+║   dolor ║
+║     sit ║
+║    amet ║
+`.trimLeft());
+            });
+        });
+        context('justify', () => {
+            it('aligns justify', () => {
+                const header = createHeader(12, {
+                    alignment: 'justify',
+                    content: basicContent,
+                    wrapWord: true,
+                });
+                (0, chai_1.expect)(header).to.equal(`
+║ Lorem  ipsum ║
+║ dolor    sit ║
+║ amet         ║
+`.trimLeft());
+            });
+        });
+    });
+    context('padding', () => {
+        it('pads properly', () => {
+            const header = createHeader(12, {
+                content: basicContent,
+                paddingLeft: 2,
+                paddingRight: 3,
+            });
+            (0, chai_1.expect)(header).to.equal(`
+║  Lorem ipsum    ║
+║  dolor sit am   ║
+║       et        ║
+`.trimLeft());
+        });
+    });
+    context('mixed with ansi word', () => {
+        it('works properly', () => {
+            const header = createHeader(16, {
+                content: `${utils_1.openBold}This is the header with ${utils_1.openRed}ansi words${utils_1.closeRed}${utils_1.closeBold}`,
+                wrapWord: true,
+            });
+            (0, chai_1.expect)(header).to.equal(`
+║   ${utils_1.openBold}This is the${utils_1.closeBold}    ║
+║ ${utils_1.openBold}header with ${utils_1.openRed}ansi${utils_1.closeRed}${utils_1.closeBold} ║
+║      ${utils_1.openBold}${utils_1.openRed}words${utils_1.closeBold}${utils_1.closeRed}       ║
+`.trimLeft());
+        });
+    });
+});
+//# sourceMappingURL=drawHeader.js.map

package/dist/test/drawRow.d.ts

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

package/dist/test/drawRow.js

@@ -0,0 +1,54 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const chai_1 = require("chai");
+const drawRow_1 = require("../src/drawRow");
+const drawVerticalLine = () => {
+    return true;
+};
+describe('drawRow', () => {
+    context('default drawVerticalLine', () => {
+        it('draws a row using all parts', () => {
+            const border = {
+                bodyJoin: '│',
+                bodyLeft: '║',
+                bodyRight: '║',
+            };
+            const config = {
+                border,
+                drawVerticalLine,
+            };
+            (0, chai_1.expect)((0, drawRow_1.drawRow)([], config)).to.equal('║║\n');
+            (0, chai_1.expect)((0, drawRow_1.drawRow)(['a'], config)).to.equal('║a║\n');
+            (0, chai_1.expect)((0, drawRow_1.drawRow)(['a', ' b '], config)).to.equal('║a│ b ║\n');
+        });
+    });
+    context('custom drawVerticalLine', () => {
+        it('draws the vertical line when the drawVerticalLine returns true', () => {
+            const rows = [' a ', ' b ', ' c '];
+            const border = {
+                bodyJoin: '│',
+                bodyLeft: '║',
+                bodyRight: '║',
+            };
+            (0, chai_1.expect)((0, drawRow_1.drawRow)(rows, {
+                border,
+                drawVerticalLine: (index) => {
+                    return index === 0;
+                },
+            })).to.equal('║ a  b  c \n');
+            (0, chai_1.expect)((0, drawRow_1.drawRow)(rows, {
+                border,
+                drawVerticalLine: (index) => {
+                    return index % 2 === 0;
+                },
+            })).to.equal('║ a  b │ c \n');
+            (0, chai_1.expect)((0, drawRow_1.drawRow)(rows, {
+                border,
+                drawVerticalLine: (index, size) => {
+                    return index > 0 && index <= size;
+                },
+            })).to.equal(' a │ b │ c ║\n');
+        });
+    });
+});
+//# sourceMappingURL=drawRow.js.map

package/dist/test/getBorderCharacters.d.ts

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

package/dist/test/getBorderCharacters.js

@@ -0,0 +1,104 @@
+"use strict";
+/* eslint-disable max-nested-callbacks */
+/* eslint-disable sort-keys-fix/sort-keys-fix */
+Object.defineProperty(exports, "__esModule", { value: true });
+const chai_1 = require("chai");
+const src_1 = require("../src");
+describe('getBorderCharacters', () => {
+    context('given name \'honeywell\'', () => {
+        it('returns the \'honeywell\' template', () => {
+            (0, chai_1.expect)((0, src_1.getBorderCharacters)('honeywell')).to.be.deep.equal({
+                headerJoin: '┬',
+                bodyJoin: '│',
+                bodyLeft: '║',
+                bodyRight: '║',
+                bottomJoin: '╧',
+                bottomLeft: '╚',
+                bottomRight: '╝',
+                bottomBody: '═',
+                joinBody: '─',
+                joinJoin: '┼',
+                joinLeft: '╟',
+                joinRight: '╢',
+                topBody: '═',
+                topJoin: '╤',
+                topLeft: '╔',
+                topRight: '╗',
+            });
+        });
+    });
+    context('given name \'norc\'', () => {
+        it('returns the \'norc\' template', () => {
+            (0, chai_1.expect)((0, src_1.getBorderCharacters)('norc')).to.be.deep.equal({
+                headerJoin: '┬',
+                bodyJoin: '│',
+                bodyLeft: '│',
+                bodyRight: '│',
+                bottomJoin: '┴',
+                bottomLeft: '└',
+                bottomRight: '┘',
+                bottomBody: '─',
+                joinJoin: '┼',
+                joinLeft: '├',
+                joinRight: '┤',
+                joinBody: '─',
+                topBody: '─',
+                topJoin: '┬',
+                topLeft: '┌',
+                topRight: '┐',
+            });
+        });
+    });
+    context('given name \'ramac\'', () => {
+        it('returns the \'ramac\' template', () => {
+            (0, chai_1.expect)((0, src_1.getBorderCharacters)('ramac')).to.be.deep.equal({
+                headerJoin: '+',
+                bodyJoin: '|',
+                bodyLeft: '|',
+                bodyRight: '|',
+                bottomJoin: '+',
+                bottomLeft: '+',
+                bottomRight: '+',
+                bottomBody: '-',
+                joinJoin: '|',
+                joinLeft: '|',
+                joinRight: '|',
+                joinBody: '-',
+                topBody: '-',
+                topJoin: '+',
+                topLeft: '+',
+                topRight: '+',
+            });
+        });
+    });
+    context('given name \'void\'', () => {
+        it('returns the \'void\' template', () => {
+            (0, chai_1.expect)((0, src_1.getBorderCharacters)('void')).to.be.deep.equal({
+                headerJoin: '',
+                bodyJoin: '',
+                bodyLeft: '',
+                bodyRight: '',
+                bottomJoin: '',
+                bottomLeft: '',
+                bottomRight: '',
+                bottomBody: '',
+                joinJoin: '',
+                joinLeft: '',
+                joinRight: '',
+                joinBody: '',
+                topBody: '',
+                topJoin: '',
+                topLeft: '',
+                topRight: '',
+            });
+        });
+    });
+    context('given another name', () => {
+        it('throws an error', () => {
+            (0, chai_1.expect)(() => {
+                return (0, src_1.getBorderCharacters)('bold');
+            }).to.throw(Error, 'Unknown border template "bold".');
+        });
+    });
+});
+//# sourceMappingURL=getBorderCharacters.js.map

package/dist/test/makeConfig.d.ts

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

package/dist/test/makeConfig.js

@@ -0,0 +1,152 @@
+"use strict";
+/* eslint-disable max-nested-callbacks */
+Object.defineProperty(exports, "__esModule", { value: true });
+const chai_1 = require("chai");
+const makeTableConfig_1 = require("../src/makeTableConfig");
+describe('makeConfig', () => {
+    const rows = [['aaaaa']];
+    it('does not affect the parameter configuration object', () => {
+        const config = {};
+        (0, makeTableConfig_1.makeTableConfig)(rows, config);
+        (0, chai_1.expect)(config).to.deep.equal({});
+    });
+    context('column', () => {
+        context('"alignment"', () => {
+            context('is not provided', () => {
+                it('defaults to "left"', () => {
+                    const config = (0, makeTableConfig_1.makeTableConfig)(rows);
+                    (0, chai_1.expect)(config.columns[0].alignment).to.equal('left');
+                });
+            });
+            context('is provided', () => {
+                it('uses the custom value', () => {
+                    const config = (0, makeTableConfig_1.makeTableConfig)(rows, { columns: {
+                            0: { alignment: 'center' },
+                        } });
+                    (0, chai_1.expect)(config.columns[0].alignment).to.equal('center');
+                });
+            });
+        });
+        context('"width"', () => {
+            context('is not provided', () => {
+                it('defaults to the maximum column width', () => {
+                    const config = (0, makeTableConfig_1.makeTableConfig)(rows);
+                    (0, chai_1.expect)(config.columns[0].width).to.equal(5);
+                });
+            });
+            context('is provided', () => {
+                it('uses the custom value', () => {
+                    const config = (0, makeTableConfig_1.makeTableConfig)(rows, { columns: { 0: { width: 7 } } });
+                    (0, chai_1.expect)(config.columns[0].width).to.equal(7);
+                });
+            });
+        });
+        context('"padding"', () => {
+            context('is not provided', () => {
+                it('defaults to 1', () => {
+                    const config = (0, makeTableConfig_1.makeTableConfig)(rows);
+                    (0, chai_1.expect)(config.columns[0].paddingLeft).to.equal(1);
+                    (0, chai_1.expect)(config.columns[0].paddingRight).to.equal(1);
+                });
+            });
+            context('is provided', () => {
+                it('uses the custom value', () => {
+                    const config = (0, makeTableConfig_1.makeTableConfig)(rows, { columns: { 0: { paddingLeft: 3,
+                                paddingRight: 2 } } });
+                    (0, chai_1.expect)(config.columns[0].paddingLeft).to.equal(3);
+                    (0, chai_1.expect)(config.columns[0].paddingRight).to.equal(2);
+                });
+            });
+        });
+    });
+    context('"drawVerticalLine', () => {
+        context('is not provided', () => {
+            it('defaults to retuning true', () => {
+                const config = (0, makeTableConfig_1.makeTableConfig)(rows);
+                (0, chai_1.expect)(config.drawVerticalLine(-1, -1)).to.equal(true);
+            });
+        });
+        context('is provided', () => {
+            it('uses the custom function', () => {
+                const config = (0, makeTableConfig_1.makeTableConfig)(rows, { drawVerticalLine: () => {
+                        return false;
+                    } });
+                (0, chai_1.expect)(config.drawVerticalLine(-1, -1)).to.equal(false);
+            });
+        });
+    });
+    context('"drawHorizontalLine', () => {
+        context('is not provided', () => {
+            it('defaults to retuning true', () => {
+                const config = (0, makeTableConfig_1.makeTableConfig)([['aaaaa']]);
+                (0, chai_1.expect)(config.drawHorizontalLine(-1, -1)).to.equal(true);
+            });
+        });
+        context('is provided', () => {
+            it('uses the custom function', () => {
+                const config = (0, makeTableConfig_1.makeTableConfig)(rows, { drawHorizontalLine: () => {
+                        return false;
+                    } });
+                (0, chai_1.expect)(config.drawHorizontalLine(-1, -1)).to.be.equal(false);
+            });
+        });
+    });
+    context('"singleLine', () => {
+        context('is not provided', () => {
+            it('defaults to retuning false', () => {
+                const config = (0, makeTableConfig_1.makeTableConfig)(rows);
+                (0, chai_1.expect)(config.singleLine).to.equal(false);
+            });
+        });
+        context('is provided', () => {
+            it('uses the custom value', () => {
+                const config = (0, makeTableConfig_1.makeTableConfig)(rows, { singleLine: true });
+                (0, chai_1.expect)(config.singleLine).to.equal(true);
+            });
+        });
+    });
+    context('header', () => {
+        context('when no given', () => {
+            it('returns undefined', () => {
+                const config = (0, makeTableConfig_1.makeTableConfig)(rows, { header: undefined });
+                (0, chai_1.expect)(config.header).to.equal(undefined);
+            });
+        });
+        context('when given content only', () => {
+            it('returns the default config', () => {
+                const config = (0, makeTableConfig_1.makeTableConfig)(rows, { header: {
+                        content: 'bb',
+                    } });
+                (0, chai_1.expect)(config.header).to.deep.equal({
+                    alignment: 'center',
+                    content: 'bb',
+                    paddingLeft: 1,
+                    paddingRight: 1,
+                    truncate: Number.POSITIVE_INFINITY,
+                    wrapWord: false,
+                });
+            });
+        });
+        context('when given extra configs', () => {
+            it('overrides the default', () => {
+                const config = (0, makeTableConfig_1.makeTableConfig)(rows, { header: {
+                        alignment: 'center',
+                        content: 'bb',
+                        paddingLeft: 2,
+                        paddingRight: 3,
+                        truncate: 5,
+                        wrapWord: true,
+                    } });
+                (0, chai_1.expect)(config.header).to.deep.equal({
+                    alignment: 'center',
+                    content: 'bb',
+                    paddingLeft: 2,
+                    paddingRight: 3,
+                    truncate: 5,
+                    wrapWord: true,
+                });
+            });
+        });
+    });
+});
+//# sourceMappingURL=makeConfig.js.map

package/dist/test/makeStreamConfig.d.ts

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