table 6.2.0 → 6.3.0

package/dist/table.js

@@ -1,121 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-
-var _alignTableData = _interopRequireDefault(require("./alignTableData"));
-
-var _calculateCellWidthIndex = _interopRequireDefault(require("./calculateCellWidthIndex"));
-
-var _calculateRowHeightIndex = _interopRequireDefault(require("./calculateRowHeightIndex"));
-
-var _drawTable = _interopRequireDefault(require("./drawTable"));
-
-var _makeConfig = _interopRequireDefault(require("./makeConfig"));
-
-var _mapDataUsingRowHeightIndex = _interopRequireDefault(require("./mapDataUsingRowHeightIndex"));
-
-var _padTableData = _interopRequireDefault(require("./padTableData"));
-
-var _stringifyTableData = _interopRequireDefault(require("./stringifyTableData"));
-
-var _truncateTableData = _interopRequireDefault(require("./truncateTableData"));
-
-var _validateTableData = _interopRequireDefault(require("./validateTableData"));
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-/**
- * @typedef {string} table~cell
- */
-
-/**
- * @typedef {table~cell[]} table~row
- */
-
-/**
- * @typedef {object} table~columns
- * @property {string} alignment Cell content alignment (enum: left, center, right) (default: left).
- * @property {number} width Column width (default: auto).
- * @property {number} truncate Number of characters are which the content will be truncated (default: Infinity).
- * @property {boolean} wrapWord When true the text is broken at the nearest space or one of the special characters
- * @property {number} paddingLeft Cell content padding width left (default: 1).
- * @property {number} paddingRight Cell content padding width right (default: 1).
- */
-
-/**
- * @typedef {object} table~border
- * @property {string} topBody
- * @property {string} topJoin
- * @property {string} topLeft
- * @property {string} topRight
- * @property {string} bottomBody
- * @property {string} bottomJoin
- * @property {string} bottomLeft
- * @property {string} bottomRight
- * @property {string} bodyLeft
- * @property {string} bodyRight
- * @property {string} bodyJoin
- * @property {string} joinBody
- * @property {string} joinLeft
- * @property {string} joinRight
- * @property {string} joinJoin
- */
-
-/**
- * Used to tell whether to draw a vertical line.
- * This callback is called for each non-content line of the table.
- * The default behavior is to always return true.
- *
- * @typedef {Function} drawVerticalLine
- * @param {number} index
- * @param {number} size
- * @returns {boolean}
- */
-
-/**
- * Used to tell whether to draw a horizontal line.
- * This callback is called for each non-content line of the table.
- * The default behavior is to always return true.
- *
- * @typedef {Function} drawHorizontalLine
- * @param {number} index
- * @param {number} size
- * @returns {boolean}
- */
-
-/**
- * @typedef {object} table~config
- * @property {table~border} border
- * @property {table~columns[]} columns Column specific configuration.
- * @property {table~columns} columnDefault Default values for all columns. Column specific settings overwrite the default values.
- * @property {table~drawVerticalLine} drawVerticalLine
- * @property {table~drawHorizontalLine} drawHorizontalLine
- * @property {table~singleLine} singleLine Horizontal lines inside the table are not drawn.
- */
-
-/**
- * Generates a text table.
- *
- * @param {table~row[]} data
- * @param {table~config} userConfig
- * @returns {string}
- */
-const table = (data, userConfig = {}) => {
-  let rows;
-  (0, _validateTableData.default)(data);
-  rows = (0, _stringifyTableData.default)(data);
-  const config = (0, _makeConfig.default)(rows, userConfig);
-  rows = (0, _truncateTableData.default)(data, config);
-  const rowHeightIndex = (0, _calculateRowHeightIndex.default)(rows, config);
-  rows = (0, _mapDataUsingRowHeightIndex.default)(rows, rowHeightIndex, config);
-  rows = (0, _alignTableData.default)(rows, config);
-  rows = (0, _padTableData.default)(rows, config);
-  const cellWidthIndex = (0, _calculateCellWidthIndex.default)(rows[0]);
-  return (0, _drawTable.default)(rows, cellWidthIndex, rowHeightIndex, config);
-};
-
-var _default = table;
-exports.default = _default;

package/dist/table.js.flow

@@ -1,108 +0,0 @@
-import alignTableData from './alignTableData';
-import calculateCellWidthIndex from './calculateCellWidthIndex';
-import calculateRowHeightIndex from './calculateRowHeightIndex';
-import drawTable from './drawTable';
-import makeConfig from './makeConfig';
-import mapDataUsingRowHeightIndex from './mapDataUsingRowHeightIndex';
-import padTableData from './padTableData';
-import stringifyTableData from './stringifyTableData';
-import truncateTableData from './truncateTableData';
-import validateTableData from './validateTableData';
-
-/**
- * @typedef {string} table~cell
- */
-
-/**
- * @typedef {table~cell[]} table~row
- */
-
-/**
- * @typedef {object} table~columns
- * @property {string} alignment Cell content alignment (enum: left, center, right) (default: left).
- * @property {number} width Column width (default: auto).
- * @property {number} truncate Number of characters are which the content will be truncated (default: Infinity).
- * @property {boolean} wrapWord When true the text is broken at the nearest space or one of the special characters
- * @property {number} paddingLeft Cell content padding width left (default: 1).
- * @property {number} paddingRight Cell content padding width right (default: 1).
- */
-
-/**
- * @typedef {object} table~border
- * @property {string} topBody
- * @property {string} topJoin
- * @property {string} topLeft
- * @property {string} topRight
- * @property {string} bottomBody
- * @property {string} bottomJoin
- * @property {string} bottomLeft
- * @property {string} bottomRight
- * @property {string} bodyLeft
- * @property {string} bodyRight
- * @property {string} bodyJoin
- * @property {string} joinBody
- * @property {string} joinLeft
- * @property {string} joinRight
- * @property {string} joinJoin
- */
-
-/**
- * Used to tell whether to draw a vertical line.
- * This callback is called for each non-content line of the table.
- * The default behavior is to always return true.
- *
- * @typedef {Function} drawVerticalLine
- * @param {number} index
- * @param {number} size
- * @returns {boolean}
- */
-
-/**
- * Used to tell whether to draw a horizontal line.
- * This callback is called for each non-content line of the table.
- * The default behavior is to always return true.
- *
- * @typedef {Function} drawHorizontalLine
- * @param {number} index
- * @param {number} size
- * @returns {boolean}
- */
-
-/**
- * @typedef {object} table~config
- * @property {table~border} border
- * @property {table~columns[]} columns Column specific configuration.
- * @property {table~columns} columnDefault Default values for all columns. Column specific settings overwrite the default values.
- * @property {table~drawVerticalLine} drawVerticalLine
- * @property {table~drawHorizontalLine} drawHorizontalLine
- * @property {table~singleLine} singleLine Horizontal lines inside the table are not drawn.
- */
-
-/**
- * Generates a text table.
- *
- * @param {table~row[]} data
- * @param {table~config} userConfig
- * @returns {string}
- */
-export default (data, userConfig = {}) => {
-  let rows;
-
-  validateTableData(data);
-
-  rows = stringifyTableData(data);
-
-  const config = makeConfig(rows, userConfig);
-
-  rows = truncateTableData(data, config);
-
-  const rowHeightIndex = calculateRowHeightIndex(rows, config);
-
-  rows = mapDataUsingRowHeightIndex(rows, rowHeightIndex, config);
-  rows = alignTableData(rows, config);
-  rows = padTableData(rows, config);
-
-  const cellWidthIndex = calculateCellWidthIndex(rows[0]);
-
-  return drawTable(rows, cellWidthIndex, rowHeightIndex, config);
-};

package/dist/truncateTableData.js

@@ -1,30 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-
-var _lodash = _interopRequireDefault(require("lodash.truncate"));
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-/**
- * @todo Make it work with ASCII content.
- * @param {table~row[]} rows
- * @param {object} config
- * @returns {table~row[]}
- */
-const truncateTableData = (rows, config) => {
-  return rows.map(cells => {
-    return cells.map((content, index) => {
-      return (0, _lodash.default)(content, {
-        length: config.columns[index].truncate,
-        omission: '…'
-      });
-    });
-  });
-};
-
-var _default = truncateTableData;
-exports.default = _default;

package/dist/truncateTableData.js.flow

@@ -1,18 +0,0 @@
-import truncate from 'lodash.truncate';
-
-/**
- * @todo Make it work with ASCII content.
- * @param {table~row[]} rows
- * @param {object} config
- * @returns {table~row[]}
- */
-export default (rows, config) => {
-  return rows.map((cells) => {
-    return cells.map((content, index) => {
-      return truncate(content, {
-        length: config.columns[index].truncate,
-        omission: '…',
-      });
-    });
-  });
-};

package/dist/validateConfig.js

@@ -1,40 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-
-var _validators = _interopRequireDefault(require("../dist/validators"));
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-/**
- * @param {string} schemaId
- * @param {formatData~config} config
- * @returns {undefined}
- */
-const validateConfig = (schemaId, config = {}) => {
-  const validate = _validators.default[schemaId];
-
-  if (!validate(config)) {
-    const errors = validate.errors.map(error => {
-      return {
-        dataPath: error.dataPath,
-        message: error.message,
-        params: error.params,
-        schemaPath: error.schemaPath
-      };
-    });
-    /* eslint-disable no-console */
-
-    console.log('config', config);
-    console.log('errors', errors);
-    /* eslint-enable no-console */
-
-    throw new Error('Invalid config.');
-  }
-};
-
-var _default = validateConfig;
-exports.default = _default;

package/dist/validateConfig.js.flow

@@ -1,27 +0,0 @@
-import validators from '../dist/validators';
-
-/**
- * @param {string} schemaId
- * @param {formatData~config} config
- * @returns {undefined}
- */
-export default (schemaId, config = {}) => {
-  const validate = validators[schemaId];
-  if (!validate(config)) {
-    const errors = validate.errors.map((error) => {
-      return {
-        dataPath: error.dataPath,
-        message: error.message,
-        params: error.params,
-        schemaPath: error.schemaPath,
-      };
-    });
-
-    /* eslint-disable no-console */
-    console.log('config', config);
-    console.log('errors', errors);
-    /* eslint-enable no-console */
-
-    throw new Error('Invalid config.');
-  }
-};

package/dist/validateTableData.js

@@ -1,54 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-
-/**
- * @typedef {string} cell
- */
-
-/**
- * @typedef {cell[]} validateData~column
- */
-
-/**
- * @param {column[]} rows
- * @returns {undefined}
- */
-const validateTableData = rows => {
-  if (!Array.isArray(rows)) {
-    throw new TypeError('Table data must be an array.');
-  }
-
-  if (rows.length === 0) {
-    throw new Error('Table must define at least one row.');
-  }
-
-  if (rows[0].length === 0) {
-    throw new Error('Table must define at least one column.');
-  }
-
-  const columnNumber = rows[0].length;
-
-  for (const cells of rows) {
-    if (!Array.isArray(cells)) {
-      throw new TypeError('Table row data must be an array.');
-    }
-
-    if (cells.length !== columnNumber) {
-      throw new Error('Table must have a consistent number of cells.');
-    }
-
-    for (const cell of cells) {
-      // eslint-disable-next-line no-control-regex
-      if (/[\u0001-\u0006\u0008\u0009\u000B-\u001A]/.test(cell)) {
-        throw new Error('Table data must not contain control characters.');
-      }
-    }
-  }
-};
-
-var _default = validateTableData;
-exports.default = _default;

package/dist/validateTableData.js.flow

@@ -1,44 +0,0 @@
-/**
- * @typedef {string} cell
- */
-
-/**
- * @typedef {cell[]} validateData~column
- */
-
-/**
- * @param {column[]} rows
- * @returns {undefined}
- */
-export default (rows) => {
-  if (!Array.isArray(rows)) {
-    throw new TypeError('Table data must be an array.');
-  }
-
-  if (rows.length === 0) {
-    throw new Error('Table must define at least one row.');
-  }
-
-  if (rows[0].length === 0) {
-    throw new Error('Table must define at least one column.');
-  }
-
-  const columnNumber = rows[0].length;
-
-  for (const cells of rows) {
-    if (!Array.isArray(cells)) {
-      throw new TypeError('Table row data must be an array.');
-    }
-
-    if (cells.length !== columnNumber) {
-      throw new Error('Table must have a consistent number of cells.');
-    }
-
-    for (const cell of cells) {
-      // eslint-disable-next-line no-control-regex
-      if (/[\u0001-\u0006\u0008\u0009\u000B-\u001A]/.test(cell)) {
-        throw new Error('Table data must not contain control characters.');
-      }
-    }
-  }
-};

package/dist/wrapCell.js

@@ -1,47 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-
-var _wrapString = _interopRequireDefault(require("./wrapString"));
-
-var _wrapWord = _interopRequireDefault(require("./wrapWord"));
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-/**
- * Wrap a single cell value into a list of lines
- *
- * Always wraps on newlines, for the remainder uses either word or string wrapping
- * depending on user configuration.
- *
- * @param {string} cellValue
- * @param {number} columnWidth
- * @param {boolean} useWrapWord
- * @returns {Array}
- */
-const wrapCell = (cellValue, columnWidth, useWrapWord) => {
-  // First split on literal newlines
-  const cellLines = cellValue.split('\n'); // Then iterate over the list and word-wrap every remaining line if necessary.
-
-  for (let lineNr = 0; lineNr < cellLines.length;) {
-    let lineChunks;
-
-    if (useWrapWord) {
-      lineChunks = (0, _wrapWord.default)(cellLines[lineNr], columnWidth);
-    } else {
-      lineChunks = (0, _wrapString.default)(cellLines[lineNr], columnWidth);
-    } // Replace our original array element with whatever the wrapping returned
-
-
-    cellLines.splice(lineNr, 1, ...lineChunks);
-    lineNr += lineChunks.length;
-  }
-
-  return cellLines;
-};
-
-var _default = wrapCell;
-exports.default = _default;

package/dist/wrapCell.js.flow

@@ -1,35 +0,0 @@
-import wrapString from './wrapString';
-import wrapWord from './wrapWord';
-
-/**
- * Wrap a single cell value into a list of lines
- *
- * Always wraps on newlines, for the remainder uses either word or string wrapping
- * depending on user configuration.
- *
- * @param {string} cellValue
- * @param {number} columnWidth
- * @param {boolean} useWrapWord
- * @returns {Array}
- */
-export default (cellValue, columnWidth, useWrapWord) => {
-  // First split on literal newlines
-  const cellLines = cellValue.split('\n');
-
-  // Then iterate over the list and word-wrap every remaining line if necessary.
-  for (let lineNr = 0; lineNr < cellLines.length;) {
-    let lineChunks;
-
-    if (useWrapWord) {
-      lineChunks = wrapWord(cellLines[lineNr], columnWidth);
-    } else {
-      lineChunks = wrapString(cellLines[lineNr], columnWidth);
-    }
-
-    // Replace our original array element with whatever the wrapping returned
-    cellLines.splice(lineNr, 1, ...lineChunks);
-    lineNr += lineChunks.length;
-  }
-
-  return cellLines;
-};

package/dist/wrapString.js

@@ -1,39 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-
-var _sliceAnsi = _interopRequireDefault(require("slice-ansi"));
-
-var _stringWidth = _interopRequireDefault(require("string-width"));
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-/**
- * Creates an array of strings split into groups the length of size.
- * This function works with strings that contain ASCII characters.
- *
- * wrapText is different from would-be "chunk" implementation
- * in that whitespace characters that occur on a chunk size limit are trimmed.
- *
- * @param {string} subject
- * @param {number} size
- * @returns {Array}
- */
-const wrapString = (subject, size) => {
-  let subjectSlice;
-  subjectSlice = subject;
-  const chunks = [];
-
-  do {
-    chunks.push((0, _sliceAnsi.default)(subjectSlice, 0, size));
-    subjectSlice = (0, _sliceAnsi.default)(subjectSlice, size).trim();
-  } while ((0, _stringWidth.default)(subjectSlice));
-
-  return chunks;
-};
-
-var _default = wrapString;
-exports.default = _default;

package/dist/wrapString.js.flow

@@ -1,29 +0,0 @@
-import slice from 'slice-ansi';
-import stringWidth from 'string-width';
-
-/**
- * Creates an array of strings split into groups the length of size.
- * This function works with strings that contain ASCII characters.
- *
- * wrapText is different from would-be "chunk" implementation
- * in that whitespace characters that occur on a chunk size limit are trimmed.
- *
- * @param {string} subject
- * @param {number} size
- * @returns {Array}
- */
-export default (subject, size) => {
-  let subjectSlice;
-
-  subjectSlice = subject;
-
-  const chunks = [];
-
-  do {
-    chunks.push(slice(subjectSlice, 0, size));
-
-    subjectSlice = slice(subjectSlice, size).trim();
-  } while (stringWidth(subjectSlice));
-
-  return chunks;
-};

package/dist/wrapWord.js

@@ -1,46 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-
-var _sliceAnsi = _interopRequireDefault(require("slice-ansi"));
-
-var _stringWidth = _interopRequireDefault(require("string-width"));
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-/**
- * @param {string} input
- * @param {number} size
- * @returns {Array}
- */
-const wrapWord = (input, size) => {
-  let subject;
-  subject = input;
-  const chunks = []; // https://regex101.com/r/gY5kZ1/1
-
-  const re = new RegExp('(^.{1,' + size + '}(\\s+|$))|(^.{1,' + (size - 1) + '}(\\\\|/|_|\\.|,|;|-))');
-
-  do {
-    let chunk;
-    chunk = subject.match(re);
-
-    if (chunk) {
-      chunk = chunk[0];
-      subject = (0, _sliceAnsi.default)(subject, (0, _stringWidth.default)(chunk));
-      chunk = chunk.trim();
-    } else {
-      chunk = (0, _sliceAnsi.default)(subject, 0, size);
-      subject = (0, _sliceAnsi.default)(subject, size);
-    }
-
-    chunks.push(chunk);
-  } while ((0, _stringWidth.default)(subject));
-
-  return chunks;
-};
-
-var _default = wrapWord;
-exports.default = _default;

package/dist/wrapWord.js.flow

@@ -1,39 +0,0 @@
-import slice from 'slice-ansi';
-import stringWidth from 'string-width';
-
-/**
- * @param {string} input
- * @param {number} size
- * @returns {Array}
- */
-export default (input, size) => {
-  let subject;
-
-  subject = input;
-
-  const chunks = [];
-
-  // https://regex101.com/r/gY5kZ1/1
-  const re = new RegExp('(^.{1,' + size + '}(\\s+|$))|(^.{1,' + (size - 1) + '}(\\\\|/|_|\\.|,|;|-))');
-
-  do {
-    let chunk;
-
-    chunk = subject.match(re);
-
-    if (chunk) {
-      chunk = chunk[0];
-
-      subject = slice(subject, stringWidth(chunk));
-
-      chunk = chunk.trim();
-    } else {
-      chunk = slice(subject, 0, size);
-      subject = slice(subject, size);
-    }
-
-    chunks.push(chunk);
-  } while (stringWidth(subject));
-
-  return chunks;
-};