table 6.1.0 → 6.3.2

package/dist/wrapString.js

@@ -1,16 +1,10 @@
 "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 }; }
-
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const slice_ansi_1 = __importDefault(require("slice-ansi"));
+const string_width_1 = __importDefault(require("string-width"));
 /**
  * Creates an array of strings split into groups the length of size.
  * This function works with strings that contain ASCII characters.
@@ -18,22 +12,13 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
  * 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;
+exports.default = (subject, size) => {
+    let subjectSlice = subject;
+    const chunks = [];
+    do {
+        chunks.push(slice_ansi_1.default(subjectSlice, 0, size));
+        subjectSlice = slice_ansi_1.default(subjectSlice, size).trim();
+    } while (string_width_1.default(subjectSlice));
+    return chunks;
 };
-
-var _default = wrapString;
-exports.default = _default;

package/dist/wrapWord.d.ts

@@ -0,0 +1,2 @@
+declare const _default: (input: string, size: number) => string[];
+export default _default;

package/dist/wrapWord.js

@@ -1,46 +1,28 @@
 "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 __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const slice_ansi_1 = __importDefault(require("slice-ansi"));
+const string_width_1 = __importDefault(require("string-width"));
+exports.default = (input, size) => {
+    let subject = input;
+    const chunks = [];
+    // https://regex101.com/r/gY5kZ1/1
+    const re = new RegExp('(^.{1,' + String(size) + '}(\\s+|$))|(^.{1,' + String(size - 1) + '}(\\\\|/|_|\\.|,|;|-))');
+    do {
+        let chunk;
+        chunk = re.exec(subject);
+        if (chunk) {
+            chunk = chunk[0];
+            subject = slice_ansi_1.default(subject, string_width_1.default(chunk));
+            chunk = chunk.trim();
+        }
+        else {
+            chunk = slice_ansi_1.default(subject, 0, size);
+            subject = slice_ansi_1.default(subject, size);
+        }
+        chunks.push(chunk);
+    } while (string_width_1.default(subject));
+    return chunks;
 };
-
-var _default = wrapWord;
-exports.default = _default;

package/package.json

@@ -17,32 +17,35 @@
   },
   "description": "Formats data into a string table.",
   "devDependencies": {
-    "@babel/cli": "^7.12.10",
-    "@babel/core": "^7.12.10",
-    "@babel/plugin-transform-flow-strip-types": "^7.12.10",
-    "@babel/preset-env": "^7.12.11",
-    "@babel/register": "^7.12.10",
+    "@types/chai": "^4.2.16",
+    "@types/lodash.clonedeep": "^4.5.6",
+    "@types/lodash.flatten": "^4.4.6",
+    "@types/lodash.mapvalues": "^4.6.6",
+    "@types/lodash.truncate": "^4.4.6",
+    "@types/mocha": "^8.2.2",
+    "@types/node": "^14.14.37",
+    "@types/sinon": "^10.0.0",
+    "@types/slice-ansi": "^4.0.0",
     "ajv-cli": "^5.0.0",
     "ajv-keywords": "^5.0.0",
-    "babel-plugin-istanbul": "^6.0.0",
-    "babel-plugin-transform-export-default-name": "^2.1.0",
     "chai": "^4.2.0",
     "chalk": "^4.1.0",
     "coveralls": "^3.1.0",
     "eslint": "^7.16.0",
     "eslint-config-canonical": "^25.0.0",
-    "flow-bin": "^0.141.0",
-    "flow-copy-source": "^2.0.9",
     "gitdown": "^3.1.3",
     "husky": "^4.3.6",
     "js-beautify": "^1.13.0",
     "lodash.mapvalues": "^4.6.0",
     "lodash.random": "^3.2.0",
     "lodash.sample": "^4.2.1",
+    "mkdirp": "^1.0.4",
     "mocha": "^8.2.1",
     "nyc": "^15.1.0",
     "semantic-release": "^17.3.1",
-    "sinon": "^9.2.2"
+    "sinon": "^9.2.2",
+    "ts-node": "^9.1.1",
+    "typescript": "4.2.4"
   },
   "engines": {
     "node": ">=10.0.0"
@@ -50,7 +53,7 @@
   "husky": {
     "hooks": {
       "post-commit": "npm run create-readme && git add README.md && git commit -m 'docs: generate docs' --no-verify",
-      "pre-commit": "npm run lint && npm run test && npm run build"
+      "pre-commit": "npm run build && npm run lint && npm run test"
     }
   },
   "keywords": [
@@ -62,30 +65,35 @@
   ],
   "license": "BSD-3-Clause",
   "main": "./dist/index.js",
+  "files": [
+    "dist/**/*.js",
+    "dist/**/*.d.ts"
+  ],
   "name": "table",
   "nyc": {
-    "include": [
-      "src/**/*.js"
+    "extensions": [
+      ".ts"
+    ],
+    "exclude": [
+      "src/generated/validators.js",
+      "test/**/*.ts"
     ],
-    "instrument": false,
     "reporter": [
       "text-lcov"
-    ],
-    "require": [
-      "@babel/register"
-    ],
-    "sourceMap": false
+    ]
   },
   "repository": {
     "type": "git",
     "url": "https://github.com/gajus/table"
   },
   "scripts": {
-    "build": "rm -fr ./dist && NODE_ENV=production babel ./src --out-dir ./dist --copy-files && npm run create-validators && flow-copy-source src dist",
+    "compile": "tsc",
+    "prebuild": "rm -fr ./dist && mkdirp dist",
+    "build": "npm run create-validators && npm run compile",
     "create-readme": "gitdown ./.README/README.md --output-file ./README.md",
-    "create-validators": "ajv compile --all-errors --inline-refs=false -s src/schemas/config -s src/schemas/streamConfig -r src/schemas/shared -c ajv-keywords/dist/keywords/typeof -o | js-beautify > dist/validators.js",
-    "lint": "npm run build && eslint ./src ./test && flow",
-    "test": "mocha --require @babel/register"
+    "create-validators": "rm -fr ./src/generated && mkdirp ./src/generated && ajv compile --all-errors --inline-refs=false -s src/schemas/config -s src/schemas/streamConfig -r src/schemas/shared -c ajv-keywords/dist/keywords/typeof -o | js-beautify > ./src/generated/validators.js",
+    "lint": "eslint --ignore-path .gitignore ./src ./test",
+    "test": "npm run create-validators && mocha --require ts-node/register ./test/**/*.ts"
   },
-  "version": "6.1.0"
+  "version": "6.3.2"
 }

package/dist/alignString.js.flow

@@ -1,97 +0,0 @@
-import isNumber from 'is-number-object';
-import isString from 'is-string';
-import stringWidth from 'string-width';
-
-const alignments = [
-  'left',
-  'right',
-  'center',
-];
-
-/**
- * @param {string} subject
- * @param {number} width
- * @returns {string}
- */
-const alignLeft = (subject, width) => {
-  return subject + ' '.repeat(width);
-};
-
-/**
- * @param {string} subject
- * @param {number} width
- * @returns {string}
- */
-const alignRight = (subject, width) => {
-  return ' '.repeat(width) + subject;
-};
-
-/**
- * @param {string} subject
- * @param {number} width
- * @returns {string}
- */
-const alignCenter = (subject, width) => {
-  let halfWidth;
-
-  halfWidth = width / 2;
-
-  if (width % 2 === 0) {
-    return ' '.repeat(halfWidth) + subject + ' '.repeat(halfWidth);
-  } else {
-    halfWidth = Math.floor(halfWidth);
-
-    return ' '.repeat(halfWidth) + subject + ' '.repeat(halfWidth + 1);
-  }
-};
-
-/**
- * Pads a string to the left and/or right to position the subject
- * text in a desired alignment within a container.
- *
- * @param {string} subject
- * @param {number} containerWidth
- * @param {string} alignment One of the valid options (left, right, center).
- * @returns {string}
- */
-export default (subject, containerWidth, alignment) => {
-  if (!isString(subject)) {
-    throw new TypeError('Subject parameter value must be a string.');
-  }
-
-  if (!isNumber(containerWidth)) {
-    throw new TypeError('Container width parameter value must be a number.');
-  }
-
-  const subjectWidth = stringWidth(subject);
-
-  if (subjectWidth > containerWidth) {
-    // console.log('subjectWidth', subjectWidth, 'containerWidth', containerWidth, 'subject', subject);
-
-    throw new Error('Subject parameter value width cannot be greater than the container width.');
-  }
-
-  if (!isString(alignment)) {
-    throw new TypeError('Alignment parameter value must be a string.');
-  }
-
-  if (!alignments.includes(alignment)) {
-    throw new Error('Alignment parameter value must be a known alignment parameter value (left, right, center).');
-  }
-
-  if (subjectWidth === 0) {
-    return ' '.repeat(containerWidth);
-  }
-
-  const availableWidth = containerWidth - subjectWidth;
-
-  if (alignment === 'left') {
-    return alignLeft(subject, availableWidth);
-  }
-
-  if (alignment === 'right') {
-    return alignRight(subject, availableWidth);
-  }
-
-  return alignCenter(subject, availableWidth);
-};

package/dist/alignTableData.js.flow

@@ -1,21 +0,0 @@
-import stringWidth from 'string-width';
-import alignString from './alignString';
-
-/**
- * @param {table~row[]} rows
- * @param {object} config
- * @returns {table~row[]}
- */
-export default (rows, config) => {
-  return rows.map((cells) => {
-    return cells.map((value, index1) => {
-      const column = config.columns[index1];
-
-      if (stringWidth(value) === column.width) {
-        return value;
-      } else {
-        return alignString(value, column.width, column.alignment);
-      }
-    });
-  });
-};

package/dist/calculateCellHeight.js.flow

@@ -1,24 +0,0 @@
-import isString from 'is-string';
-import wrapCell from './wrapCell';
-
-/**
- * @param {string} value
- * @param {number} columnWidth
- * @param {boolean} useWrapWord
- * @returns {number}
- */
-export default (value, columnWidth, useWrapWord = false) => {
-  if (!isString(value)) {
-    throw new TypeError('Value must be a string.');
-  }
-
-  if (!Number.isInteger(columnWidth)) {
-    throw new TypeError('Column width must be an integer.');
-  }
-
-  if (columnWidth < 1) {
-    throw new Error('Column width must be greater than 0.');
-  }
-
-  return wrapCell(value, columnWidth, useWrapWord).length;
-};

package/dist/calculateCellWidthIndex.js.flow

@@ -1,17 +0,0 @@
-import stringWidth from 'string-width';
-
-/**
- * Calculates width of each cell contents.
- *
- * @param {string[]} cells
- * @returns {number[]}
- */
-export default (cells) => {
-  return cells.map((value) => {
-    return Math.max(
-      ...value.split('\n').map((line) => {
-        return stringWidth(line);
-      }),
-    );
-  });
-};

package/dist/calculateMaximumColumnWidthIndex.js.flow

@@ -1,27 +0,0 @@
-import calculateCellWidthIndex from './calculateCellWidthIndex';
-
-/**
- * Produces an array of values that describe the largest value length (width) in every column.
- *
- * @param {Array[]} rows
- * @returns {number[]}
- */
-export default (rows) => {
-  if (!rows[0]) {
-    throw new Error('Dataset must have at least one row.');
-  }
-
-  const columns = new Array(rows[0].length).fill(0);
-
-  rows.forEach((row) => {
-    const columnWidthIndex = calculateCellWidthIndex(row);
-
-    columnWidthIndex.forEach((valueWidth, index0) => {
-      if (columns[index0] < valueWidth) {
-        columns[index0] = valueWidth;
-      }
-    });
-  });
-
-  return columns;
-};

package/dist/calculateRowHeightIndex.js.flow

@@ -1,36 +0,0 @@
-import isBoolean from 'is-boolean-object';
-import isNumber from 'is-number-object';
-import calculateCellHeight from './calculateCellHeight';
-
-/**
- * Calculates the vertical row span index.
- *
- * @param {Array[]} rows
- * @param {object} config
- * @returns {number[]}
- */
-export default (rows, config) => {
-  const tableWidth = rows[0].length;
-
-  const rowSpanIndex = [];
-
-  rows.forEach((cells) => {
-    const cellHeightIndex = new Array(tableWidth).fill(1);
-
-    cells.forEach((value, index1) => {
-      if (!isNumber(config.columns[index1].width)) {
-        throw new TypeError('column[index].width must be a number.');
-      }
-
-      if (!isBoolean(config.columns[index1].wrapWord)) {
-        throw new TypeError('column[index].wrapWord must be a boolean.');
-      }
-
-      cellHeightIndex[index1] = calculateCellHeight(value, config.columns[index1].width, config.columns[index1].wrapWord);
-    });
-
-    rowSpanIndex.push(Math.max(...cellHeightIndex));
-  });
-
-  return rowSpanIndex;
-};

package/dist/createStream.js.flow

@@ -1,125 +0,0 @@
-import alignTableData from './alignTableData';
-import calculateRowHeightIndex from './calculateRowHeightIndex';
-import {
-  drawBorderBottom,
-  drawBorderJoin,
-  drawBorderTop,
-} from './drawBorder';
-import drawRow from './drawRow';
-import makeStreamConfig from './makeStreamConfig';
-import mapDataUsingRowHeightIndex from './mapDataUsingRowHeightIndex';
-import padTableData from './padTableData';
-import stringifyTableData from './stringifyTableData';
-import truncateTableData from './truncateTableData';
-
-/**
- * @param {Array} data
- * @param {streamConfig} config
- * @returns {Array}
- */
-const prepareData = (data, config) => {
-  let rows;
-
-  rows = stringifyTableData(data);
-
-  rows = truncateTableData(rows, config);
-
-  const rowHeightIndex = calculateRowHeightIndex(rows, config);
-
-  rows = mapDataUsingRowHeightIndex(rows, rowHeightIndex, config);
-  rows = alignTableData(rows, config);
-  rows = padTableData(rows, config);
-
-  return rows;
-};
-
-/**
- * @param {string[]} row
- * @param {number[]} columnWidthIndex
- * @param {streamConfig} config
- * @returns {undefined}
- */
-const create = (row, columnWidthIndex, config) => {
-  const rows = prepareData([row], config);
-
-  const body = rows.map((literalRow) => {
-    return drawRow(literalRow, config);
-  }).join('');
-
-  let output;
-
-  output = '';
-
-  output += drawBorderTop(columnWidthIndex, config);
-  output += body;
-  output += drawBorderBottom(columnWidthIndex, config);
-
-  output = output.trimEnd();
-
-  process.stdout.write(output);
-};
-
-/**
- * @param {string[]} row
- * @param {number[]} columnWidthIndex
- * @param {streamConfig} config
- * @returns {undefined}
- */
-const append = (row, columnWidthIndex, config) => {
-  const rows = prepareData([row], config);
-
-  const body = rows.map((literalRow) => {
-    return drawRow(literalRow, config);
-  }).join('');
-
-  let output = '';
-  const bottom = drawBorderBottom(columnWidthIndex, config);
-
-  if (bottom !== '\n') {
-    output = '\r\u001B[K';
-  }
-
-  output += drawBorderJoin(columnWidthIndex, config);
-  output += body;
-  output += bottom;
-
-  output = output.trimEnd();
-
-  process.stdout.write(output);
-};
-
-/**
- * @param {object} userConfig
- * @returns {object}
- */
-export default (userConfig = {}) => {
-  const config = makeStreamConfig(userConfig);
-
-  const columnWidthIndex = Object.values(config.columns).map((column) => {
-    return column.width + column.paddingLeft + column.paddingRight;
-  });
-
-  let empty;
-
-  empty = true;
-
-  return {
-    /**
-     * @param {string[]} row
-     * @returns {undefined}
-     */
-    write: (row) => {
-      if (row.length !== config.columnCount) {
-        throw new Error('Row cell count does not match the config.columnCount.');
-      }
-
-      if (empty) {
-        empty = false;
-
-        return create(row, columnWidthIndex, config);
-      } else {
-        return append(row, columnWidthIndex, config);
-      }
-    },
-  };
-};

package/dist/drawBorder.js.flow

@@ -1,89 +0,0 @@
-import drawHorizontalContent from './drawHorizontalContent';
-
-/**
- * @typedef drawBorder~border
- * @property {string} left
- * @property {string} right
- * @property {string} body
- * @property {string} join
- */
-
-/**
- * @param {number[]} columnSizeIndex
- * @param {object} config
- * @param {drawBorder~border} config.border
- * @param {Function} config.drawVerticalLine
- * @returns {string}
- */
-const drawBorder = (columnSizeIndex, {border, drawVerticalLine}) => {
-  const columns = columnSizeIndex.map((size) => {
-    return border.body.repeat(size);
-  });
-
-  return drawHorizontalContent(columns, {
-    drawVerticalLine,
-    separator: border,
-  });
-};
-
-/**
- * @param {number[]} columnSizeIndex
- * @param {table~config} config
- * @returns {string}
- */
-const drawBorderTop = (columnSizeIndex, {border, drawVerticalLine}) => {
-  const result = drawBorder(columnSizeIndex, {border: {
-    body: border.topBody,
-    join: border.topJoin,
-    left: border.topLeft,
-    right: border.topRight,
-  },
-  drawVerticalLine});
-
-  if (result === '\n') {
-    return '';
-  }
-
-  return result;
-};
-
-/**
- * @param {number[]} columnSizeIndex
- * @param {table~config} config
- * @returns {string}
- */
-const drawBorderJoin = (columnSizeIndex, {border, drawVerticalLine}) => {
-  return drawBorder(columnSizeIndex, {
-    border: {
-      body: border.joinBody,
-      join: border.joinJoin,
-      left: border.joinLeft,
-      right: border.joinRight,
-    },
-    drawVerticalLine,
-  });
-};
-
-/**
- * @param {number[]} columnSizeIndex
- * @param {table~config} config
- * @returns {string}
- */
-const drawBorderBottom = (columnSizeIndex, {border, drawVerticalLine}) => {
-  return drawBorder(columnSizeIndex, {
-    border: {
-      body: border.bottomBody,
-      join: border.bottomJoin,
-      left: border.bottomLeft,
-      right: border.bottomRight,
-    },
-    drawVerticalLine,
-  });
-};
-
-export {
-  drawBorder,
-  drawBorderBottom,
-  drawBorderJoin,
-  drawBorderTop,
-};