table 6.2.0 → 6.3.0

package/dist/src/padTableData.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = (rows, config) => {
+    return rows.map((cells) => {
+        return cells.map((value, index1) => {
+            const column = config.columns[index1];
+            return ' '.repeat(column.paddingLeft) + value + ' '.repeat(column.paddingRight);
+        });
+    });
+};
+//# sourceMappingURL=padTableData.js.map

package/dist/src/stringifyTableData.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = (rows) => {
+    return rows.map((cells) => {
+        return cells.map(String);
+    });
+};
+//# sourceMappingURL=stringifyTableData.js.map

package/dist/src/table.js

@@ -0,0 +1,28 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const alignTableData_1 = __importDefault(require("./alignTableData"));
+const calculateCellWidthIndex_1 = __importDefault(require("./calculateCellWidthIndex"));
+const calculateRowHeightIndex_1 = __importDefault(require("./calculateRowHeightIndex"));
+const drawTable_1 = __importDefault(require("./drawTable"));
+const makeConfig_1 = __importDefault(require("./makeConfig"));
+const mapDataUsingRowHeightIndex_1 = __importDefault(require("./mapDataUsingRowHeightIndex"));
+const padTableData_1 = __importDefault(require("./padTableData"));
+const stringifyTableData_1 = __importDefault(require("./stringifyTableData"));
+const truncateTableData_1 = __importDefault(require("./truncateTableData"));
+const validateTableData_1 = __importDefault(require("./validateTableData"));
+exports.default = (data, userConfig = {}) => {
+    validateTableData_1.default(data);
+    let rows = stringifyTableData_1.default(data);
+    const config = makeConfig_1.default(rows, userConfig);
+    rows = truncateTableData_1.default(rows, config);
+    const rowHeightIndex = calculateRowHeightIndex_1.default(rows, config);
+    rows = mapDataUsingRowHeightIndex_1.default(rows, rowHeightIndex, config);
+    rows = alignTableData_1.default(rows, config);
+    rows = padTableData_1.default(rows, config);
+    const cellWidthIndex = calculateCellWidthIndex_1.default(rows[0]);
+    return drawTable_1.default(rows, cellWidthIndex, rowHeightIndex, config);
+};
+//# sourceMappingURL=table.js.map

package/dist/src/truncateTableData.js

@@ -0,0 +1,20 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const lodash_truncate_1 = __importDefault(require("lodash.truncate"));
+/**
+ * @todo Make it work with ASCII content.
+ */
+exports.default = (rows, config) => {
+    return rows.map((cells) => {
+        return cells.map((content, index) => {
+            return lodash_truncate_1.default(content, {
+                length: config.columns[index].truncate,
+                omission: '…',
+            });
+        });
+    });
+};
+//# sourceMappingURL=truncateTableData.js.map

package/dist/src/types/api.d.ts

@@ -0,0 +1,99 @@
+export declare type DrawLinePredicate = (index: number, size: number) => boolean;
+export declare type DrawVerticalLine = DrawLinePredicate;
+export declare type DrawHorizontalLine = DrawLinePredicate;
+export declare type BorderUserConfig = {
+    readonly topLeft?: string;
+    readonly topRight?: string;
+    readonly topBody?: string;
+    readonly topJoin?: string;
+    readonly bottomLeft?: string;
+    readonly bottomRight?: string;
+    readonly bottomBody?: string;
+    readonly bottomJoin?: string;
+    readonly bodyRight?: string;
+    readonly bodyLeft?: string;
+    readonly bodyJoin?: string;
+    readonly joinLeft?: string;
+    readonly joinRight?: string;
+    readonly joinBody?: string;
+    readonly joinJoin?: string;
+};
+export declare type ColumnUserConfig = {
+    /**
+     * Cell content horizontal alignment (default: left)
+     */
+    readonly alignment?: 'center' | 'left' | 'right';
+    /**
+     * Column width (default: auto calculation based on the cell content)
+     */
+    readonly width?: number;
+    /**
+     * Number of characters are which the content will be truncated (default: Infinity)
+     */
+    readonly truncate?: number;
+    /**
+     * Cell content padding width left (default: 1)
+     */
+    readonly paddingLeft?: number;
+    /**
+     * Cell content padding width right (default: 1)
+     */
+    readonly paddingRight?: number;
+    /**
+     * If true, the text is broken at the nearest space or one of the special characters: "\|/_.,;-"
+     */
+    readonly wrapWord?: boolean;
+};
+export declare type BaseUserConfig = {
+    /**
+     * Custom border
+     */
+    readonly border?: BorderUserConfig;
+    /**
+     * Default values for all columns. Column specific settings overwrite the default values.
+     */
+    readonly columnDefault?: ColumnUserConfig;
+    /**
+     * Column specific configuration.
+     */
+    readonly columns?: Indexable<ColumnUserConfig>;
+    /**
+     * 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.
+     */
+    readonly drawVerticalLine?: DrawVerticalLine;
+};
+export declare type TableUserConfig = BaseUserConfig & {
+    /**
+     * 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.
+     */
+    readonly drawHorizontalLine?: DrawHorizontalLine;
+    /**
+     * Horizontal lines inside the table are not drawn.
+     */
+    readonly singleLine?: boolean;
+};
+export declare type StreamUserConfig = BaseUserConfig & {
+    /**
+     * The number of columns
+     */
+    readonly columnCount: number;
+    /**
+     * Default values for all columns. Column specific settings overwrite the default values.
+     */
+    readonly columnDefault: ColumnUserConfig & {
+        /**
+         * The default width for each column
+         */
+        readonly width: number;
+    };
+};
+export declare type WritableStream = {
+    readonly write: (rows: string[]) => void;
+};
+export declare type Indexable<T> = {
+    readonly [index: number]: T;
+};

package/dist/src/types/api.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=api.js.map

package/dist/src/types/internal.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=internal.js.map

package/dist/src/validateConfig.js

@@ -0,0 +1,27 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+// @ts-expect-error
+// eslint-disable-next-line import/no-unresolved
+const validators_1 = __importDefault(require("./validators"));
+exports.default = (schemaId, config) => {
+    const validate = validators_1.default[schemaId];
+    if (!validate(config)) {
+        const errors = validate.errors.map((error) => {
+            return {
+                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.');
+    }
+};
+//# sourceMappingURL=validateConfig.js.map

package/dist/src/validateTableData.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.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 row of rows) {
+        if (!Array.isArray(row)) {
+            throw new TypeError('Table row data must be an array.');
+        }
+        if (row.length !== columnNumber) {
+            throw new Error('Table must have a consistent number of cells.');
+        }
+        for (const cell of row) {
+            // 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.');
+            }
+        }
+    }
+};
+//# sourceMappingURL=validateTableData.js.map

package/dist/src/wrapCell.js

@@ -0,0 +1,33 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const wrapString_1 = __importDefault(require("./wrapString"));
+const wrapWord_1 = __importDefault(require("./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.
+ *
+ */
+exports.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_1.default(cellLines[lineNr], columnWidth);
+        }
+        else {
+            lineChunks = wrapString_1.default(cellLines[lineNr], columnWidth);
+        }
+        // Replace our original array element with whatever the wrapping returned
+        cellLines.splice(lineNr, 1, ...lineChunks);
+        lineNr += lineChunks.length;
+    }
+    return cellLines;
+};
+//# sourceMappingURL=wrapCell.js.map

package/dist/src/wrapString.js

@@ -0,0 +1,25 @@
+"use strict";
+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.
+ *
+ * wrapText is different from would-be "chunk" implementation
+ * in that whitespace characters that occur on a chunk size limit are trimmed.
+ *
+ */
+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;
+};
+//# sourceMappingURL=wrapString.js.map

package/dist/src/wrapWord.js

@@ -0,0 +1,29 @@
+"use strict";
+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;
+};
+//# sourceMappingURL=wrapWord.js.map

package/package.json

@@ -17,32 +17,34 @@
   },
   "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",
+    "typescript": "4.2.4"
   },
   "engines": {
     "node": ">=10.0.0"
@@ -50,7 +52,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": [
@@ -61,31 +63,37 @@
     "ansi"
   ],
   "license": "BSD-3-Clause",
-  "main": "./dist/index.js",
+  "main": "./dist/src/index.js",
+  "files": [
+    "dist/src/**/*.js",
+    "dist/src/types/api.d.ts",
+    "dist/src/index.d.ts"
+  ],
   "name": "table",
   "nyc": {
-    "include": [
-      "src/**/*.js"
+    "extensions": [
+      ".ts"
+    ],
+    "exclude": [
+      "dist/src/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/src",
+    "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": "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/src/validators.js",
+    "lint": "eslint ./src ./test",
+    "test": "mocha ./dist/test/**/*.js"
   },
-  "version": "6.2.0"
+  "version": "6.3.0"
 }

package/dist/alignString.js

@@ -1,107 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-
-var _isNumberObject = _interopRequireDefault(require("is-number-object"));
-
-var _isString = _interopRequireDefault(require("is-string"));
-
-var _stringWidth = _interopRequireDefault(require("string-width"));
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-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}
- */
-
-
-const alignString = (subject, containerWidth, alignment) => {
-  if (!(0, _isString.default)(subject)) {
-    throw new TypeError('Subject parameter value must be a string.');
-  }
-
-  if (!(0, _isNumberObject.default)(containerWidth)) {
-    throw new TypeError('Container width parameter value must be a number.');
-  }
-
-  const subjectWidth = (0, _stringWidth.default)(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 (!(0, _isString.default)(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);
-};
-
-var _default = alignString;
-exports.default = _default;

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

@@ -1,34 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-
-var _stringWidth = _interopRequireDefault(require("string-width"));
-
-var _alignString = _interopRequireDefault(require("./alignString"));
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-/**
- * @param {table~row[]} rows
- * @param {object} config
- * @returns {table~row[]}
- */
-const alignTableData = (rows, config) => {
-  return rows.map(cells => {
-    return cells.map((value, index1) => {
-      const column = config.columns[index1];
-
-      if ((0, _stringWidth.default)(value) === column.width) {
-        return value;
-      } else {
-        return (0, _alignString.default)(value, column.width, column.alignment);
-      }
-    });
-  });
-};
-
-var _default = alignTableData;
-exports.default = _default;