1 import cloneDeep from 'lodash.clonedeep';
2 import getBorderCharacters from './getBorderCharacters';
3 import validateConfig from './validateConfig';
6 * Merges user provided border characters with the default border ("honeywell") characters.
8 * @param {object} border
11 const makeBorder = (border = {}) => {
12 return Object.assign({}, getBorderCharacters('honeywell'), border);
16 * Creates a configuration for every column using default
17 * values for the missing configuration properties.
19 * @param {number} columnCount
20 * @param {object} columns
21 * @param {object} columnDefault
24 const makeColumns = (columnCount, columns = {}, columnDefault = {}) => {
25 for (let index = 0; index < columnCount; index++) {
26 if (typeof columns[index] === 'undefined') {
30 columns[index] = Object.assign({
34 truncate: Number.POSITIVE_INFINITY,
36 }, columnDefault, columns[index]);
43 * @typedef {object} columnConfig
44 * @property {string} alignment
45 * @property {number} width
46 * @property {number} truncate
47 * @property {number} paddingLeft
48 * @property {number} paddingRight
52 * @typedef {object} streamConfig
53 * @property {columnConfig} columnDefault
54 * @property {object} border
55 * @property {columnConfig[]}
56 * @property {number} columnCount Number of columns in the table (required).
60 * Makes a new configuration object out of the userConfig object
61 * using default values for the missing configuration properties.
63 * @param {streamConfig} userConfig
66 export default (userConfig = {}) => {
67 validateConfig('streamConfig.json', userConfig);
69 const config = cloneDeep(userConfig);
71 if (!config.columnDefault || !config.columnDefault.width) {
72 throw new Error('Must provide config.columnDefault.width when creating a stream.');
75 if (!config.columnCount) {
76 throw new Error('Must provide config.columnCount.');
79 config.border = makeBorder(config.border);
80 config.columns = makeColumns(config.columnCount, config.columns, config.columnDefault);