UNPKG

2.67 kBJavaScriptView Raw
1"use strict";
2
3Object.defineProperty(exports, "__esModule", {
4 value: true
5});
6exports.default = void 0;
7
8var _lodash = _interopRequireDefault(require("lodash"));
9
10var _getBorderCharacters = _interopRequireDefault(require("./getBorderCharacters"));
11
12var _validateConfig = _interopRequireDefault(require("./validateConfig"));
13
14function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
15
16/**
17 * Merges user provided border characters with the default border ("honeywell") characters.
18 *
19 * @param {Object} border
20 * @returns {Object}
21 */
22const makeBorder = (border = {}) => {
23 return Object.assign({}, (0, _getBorderCharacters.default)('honeywell'), border);
24};
25/**
26 * Creates a configuration for every column using default
27 * values for the missing configuration properties.
28 *
29 * @param {number} columnCount
30 * @param {Object} columns
31 * @param {Object} columnDefault
32 * @returns {Object}
33 */
34
35
36const makeColumns = (columnCount, columns = {}, columnDefault = {}) => {
37 _lodash.default.times(columnCount, index => {
38 if (_lodash.default.isUndefined(columns[index])) {
39 columns[index] = {};
40 }
41
42 columns[index] = Object.assign({
43 alignment: 'left',
44 paddingLeft: 1,
45 paddingRight: 1,
46 truncate: Infinity,
47 wrapWord: false
48 }, columnDefault, columns[index]);
49 });
50
51 return columns;
52};
53/**
54 * @typedef {Object} columnConfig
55 * @property {string} alignment
56 * @property {number} width
57 * @property {number} truncate
58 * @property {number} paddingLeft
59 * @property {number} paddingRight
60 */
61
62/**
63 * @typedef {Object} streamConfig
64 * @property {columnConfig} columnDefault
65 * @property {Object} border
66 * @property {columnConfig[]}
67 * @property {number} columnCount Number of columns in the table (required).
68 */
69
70/**
71 * Makes a new configuration object out of the userConfig object
72 * using default values for the missing configuration properties.
73 *
74 * @param {streamConfig} userConfig
75 * @returns {Object}
76 */
77
78
79const makeStreamConfig = (userConfig = {}) => {
80 (0, _validateConfig.default)('streamConfig.json', userConfig);
81
82 const config = _lodash.default.cloneDeep(userConfig);
83
84 if (!config.columnDefault || !config.columnDefault.width) {
85 throw new Error('Must provide config.columnDefault.width when creating a stream.');
86 }
87
88 if (!config.columnCount) {
89 throw new Error('Must provide config.columnCount.');
90 }
91
92 config.border = makeBorder(config.border);
93 config.columns = makeColumns(config.columnCount, config.columns, config.columnDefault);
94 return config;
95};
96
97var _default = makeStreamConfig;
98exports.default = _default;
99//# sourceMappingURL=makeStreamConfig.js.map
\No newline at end of file