makeStreamConfig.js 2.9 KB

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