table 3.7.9 → 3.8.3

package/dist/validateTableData.js

@@ -1,16 +1,12 @@
 'use strict';
 
 Object.defineProperty(exports, "__esModule", {
-    value: true
+  value: true
 });
 
-var _forEach2 = require('lodash/forEach');
+var _lodash = require('lodash');
 
-var _forEach3 = _interopRequireDefault(_forEach2);
-
-var _isArray2 = require('lodash/isArray');
-
-var _isArray3 = _interopRequireDefault(_isArray2);
+var _lodash2 = _interopRequireDefault(_lodash);
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
@@ -26,42 +22,38 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
  * @param {column[]} rows
  * @returns {undefined}
  */
+exports.default = rows => {
+  if (!_lodash2.default.isArray(rows)) {
+    throw new Error('Table data must be an array.');
+  }
 
-exports.default = function (rows) {
-    var columnNumber = void 0;
+  if (rows.length === 0) {
+    throw new Error('Table must define at least one row.');
+  }
 
-    if (!(0, _isArray3.default)(rows)) {
-        throw new Error('Table data must be an array.');
-    }
+  if (rows[0].length === 0) {
+    throw new Error('Table must define at least one column.');
+  }
 
-    if (rows.length === 0) {
-        throw new Error('Table must define at least one row.');
-    }
+  const columnNumber = rows[0].length;
 
-    if (rows[0].length === 0) {
-        throw new Error('Table must define at least one column.');
+  _lodash2.default.forEach(rows, cells => {
+    if (!_lodash2.default.isArray(cells)) {
+      throw new Error('Table row data must be an array.');
     }
 
-    columnNumber = rows[0].length;
-
-    (0, _forEach3.default)(rows, function (cells) {
-        if (!(0, _isArray3.default)(cells)) {
-            throw new Error('Table row data must be an array.');
-        }
-
-        if (cells.length !== columnNumber) {
-            throw new Error('Table must have a consistent number of cells.');
-        }
+    if (cells.length !== columnNumber) {
+      throw new Error('Table must have a consistent number of cells.');
+    }
 
-        // @todo Make an exception for newline characters.
-        // @see https://github.com/gajus/table/issues/9
-        (0, _forEach3.default)(cells, function (cell) {
-            if (/[\x01-\x1A]/.test(cell)) {
-                throw new Error('Table data must not contain control characters.');
-            }
-        });
+    // @todo Make an exception for newline characters.
+    // @see https://github.com/gajus/table/issues/9
+    _lodash2.default.forEach(cells, cell => {
+      if (/[\x01-\x1A]/.test(cell)) {
+        throw new Error('Table data must not contain control characters.');
+      }
     });
+  });
 };
 
-module.exports = exports['default'];
-//# sourceMappingURL=validateTableData.js.map
+module.exports = exports['default'];

package/dist/wrapString.js

@@ -1,12 +1,12 @@
 'use strict';
 
 Object.defineProperty(exports, "__esModule", {
-    value: true
+  value: true
 });
 
-var _trim2 = require('lodash/trim');
+var _lodash = require('lodash');
 
-var _trim3 = _interopRequireDefault(_trim2);
+var _lodash2 = _interopRequireDefault(_lodash);
 
 var _sliceAnsi = require('slice-ansi');
 
@@ -29,23 +29,20 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
  * @param {number} size
  * @returns {Array}
  */
+exports.default = (subject, size) => {
+  let subjectSlice;
 
-exports.default = function (subject, size) {
-    var chunks = void 0,
-        subjectSlice = void 0;
+  subjectSlice = subject;
 
-    subjectSlice = subject;
+  const chunks = [];
 
-    chunks = [];
+  do {
+    chunks.push((0, _sliceAnsi2.default)(subjectSlice, 0, size));
 
-    do {
-        chunks.push((0, _sliceAnsi2.default)(subjectSlice, 0, size));
+    subjectSlice = _lodash2.default.trim((0, _sliceAnsi2.default)(subjectSlice, size));
+  } while ((0, _stringWidth2.default)(subjectSlice));
 
-        subjectSlice = (0, _trim3.default)((0, _sliceAnsi2.default)(subjectSlice, size));
-    } while ((0, _stringWidth2.default)(subjectSlice));
-
-    return chunks;
+  return chunks;
 };
 
-module.exports = exports['default'];
-//# sourceMappingURL=wrapString.js.map
+module.exports = exports['default'];

package/dist/wrapWord.js

@@ -1,12 +1,12 @@
 'use strict';
 
 Object.defineProperty(exports, "__esModule", {
-    value: true
+  value: true
 });
 
-var _trim2 = require('lodash/trim');
+var _lodash = require('lodash');
 
-var _trim3 = _interopRequireDefault(_trim2);
+var _lodash2 = _interopRequireDefault(_lodash);
 
 var _sliceAnsi = require('slice-ansi');
 
@@ -23,41 +23,36 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
  * @param {number} size
  * @returns {Array}
  */
+exports.default = (input, size) => {
+  let subject;
 
-exports.default = function (input, size) {
-    var chunk = void 0,
-        chunks = void 0,
-        re = void 0,
-        subject = void 0;
+  subject = input;
 
-    subject = input;
+  const chunks = [];
 
-    chunks = [];
+  // https://regex101.com/r/gY5kZ1/1
+  const re = new RegExp('(^.{1,' + size + '}(\\s+|$))|(^.{1,' + (size - 1) + '}(\\\\|/|_|\\.|,|;|-))');
 
-    // https://regex101.com/r/gY5kZ1/1
-    re = new RegExp('(^.{1,' + size + '}(\\s+|$))|(^.{1,' + (size - 1) + '}(\\\\|/|_|\\.|,|;|\-))');
+  do {
+    let chunk;
 
-    do {
-        chunk = subject.match(re);
+    chunk = subject.match(re);
 
-        // console.log('chunk', chunk, re);
+    if (chunk) {
+      chunk = chunk[0];
 
-        if (chunk) {
-            chunk = chunk[0];
+      subject = (0, _sliceAnsi2.default)(subject, (0, _stringWidth2.default)(chunk));
 
-            subject = (0, _sliceAnsi2.default)(subject, (0, _stringWidth2.default)(chunk));
+      chunk = _lodash2.default.trim(chunk);
+    } else {
+      chunk = (0, _sliceAnsi2.default)(subject, 0, size);
+      subject = (0, _sliceAnsi2.default)(subject, size);
+    }
 
-            chunk = (0, _trim3.default)(chunk);
-        } else {
-            chunk = (0, _sliceAnsi2.default)(subject, 0, size);
-            subject = (0, _sliceAnsi2.default)(subject, size);
-        }
+    chunks.push(chunk);
+  } while ((0, _stringWidth2.default)(subject));
 
-        chunks.push(chunk);
-    } while ((0, _stringWidth2.default)(subject));
-
-    return chunks;
+  return chunks;
 };
 
-module.exports = exports['default'];
-//# sourceMappingURL=wrapWord.js.map
+module.exports = exports['default'];

package/package.json

@@ -5,18 +5,30 @@
     "url": "http://gajus.com"
   },
   "dependencies": {
+    "ajv": "^4.7.0",
+    "ajv-keywords": "^1.0.0",
     "chalk": "^1.1.1",
     "lodash": "^4.0.0",
     "slice-ansi": "0.0.4",
-    "string-width": "^1.0.1",
-    "tv4": "^1.2.7"
+    "string-width": "^2.0.0"
   },
   "description": "Formats data into a string table.",
   "devDependencies": {
+    "ajv-cli": "^1.1.0",
+    "babel": "^6.5.2",
+    "babel-cli": "^6.14.0",
+    "babel-core": "^6.14.0",
+    "babel-plugin-add-module-exports": "^0.2.1",
+    "babel-plugin-istanbul": "^2.0.3",
+    "babel-preset-es2015-node4": "^2.1.0",
+    "babel-register": "^6.14.0",
     "chai": "^3.4.1",
+    "eslint": "^3.5.0",
+    "eslint-config-canonical": "^1.8.6",
     "gitdown": "^2.4.0",
-    "jsonlint": "^1.6.2",
-    "pragmatist": "^3.0.2",
+    "husky": "^0.11.7",
+    "mocha": "^3.0.2",
+    "nyc": "^8.3.1",
     "sinon": "^1.17.2"
   },
   "keywords": [
@@ -29,18 +41,29 @@
   "license": "BSD-3-Clause",
   "main": "./dist/index.js",
   "name": "table",
+  "nyc": {
+    "include": [
+      "src/*.js"
+    ],
+    "instrument": false,
+    "lines": 70,
+    "require": [
+      "babel-register"
+    ],
+    "sourceMap": false
+  },
   "repository": {
     "type": "git",
     "url": "https://github.com/gajus/table"
   },
   "scripts": {
-    "build": "npm run pragmatist build -- --es5",
-    "format-config": "npm run format-json ./package.json",
-    "format-json": "jsonlint --sort-keys --in-place --indent '    '",
-    "lint": "npm run pragmatist lint",
-    "pragmatist": "pragmatist",
-    "readme": "gitdown ./.README/README.md --output-file ./README.md",
-    "test": "npm run pragmatist test"
+    "build": "rm -fr ./dist && babel --copy-files ./src --out-dir ./dist && npm run make-validators",
+    "lint": "npm run build && eslint ./src ./tests",
+    "make-readme": "gitdown ./.README/README.md --output-file ./README.md",
+    "make-validators": "ajv compile --all-errors --inline-refs=false -s src/schemas/config -c ajv-keywords/keywords/typeof -o dist/validateConfig.js && ajv compile --all-errors --inline-refs=false -s src/schemas/streamConfig -c ajv-keywords/keywords/typeof -o dist/validateStreamConfig.js",
+    "precommit": "npm run lint && npm run test",
+    "prepublish": "NODE_ENV=production npm run build",
+    "test": "npm run build && nyc --check-coverage mocha"
   },
-  "version": "3.7.9"
+  "version": "3.8.3"
 }

package/test/README/usage/basic.js

@@ -0,0 +1,25 @@
+import table from './../../../src';
+import expectTable from './expectTable';
+
+describe('README.md usage/', () => {
+  it('basic', () => {
+    const data = [
+      ['0A', '0B', '0C'],
+      ['1A', '1B', '1C'],
+      ['2A', '2B', '2C']
+    ];
+
+    const output = table(data);
+
+    // eslint-disable-next-line no-restricted-syntax
+    expectTable(output, `
+╔════╤════╤════╗
+║ 0A │ 0B │ 0C ║
+╟────┼────┼────╢
+║ 1A │ 1B │ 1C ║
+╟────┼────┼────╢
+║ 2A │ 2B │ 2C ║
+╚════╧════╧════╝
+        `);
+  });
+});

package/test/README/usage/cell_content_alignment.js

@@ -0,0 +1,45 @@
+import table from './../../../src';
+import expectTable from './expectTable';
+
+describe('README.md usage/', () => {
+  it('cell_content_alignment', () => {
+    const data = [
+            ['0A', '0B', '0C'],
+            ['1A', '1B', '1C'],
+            ['2A', '2B', '2C']
+    ];
+
+    const config = {
+      columns: {
+        0: {
+          alignment: 'left',
+          width: 10
+        },
+        1: {
+          alignment: 'center',
+          width: 10
+        },
+        2: {
+          alignment: 'right',
+          width: 10
+        }
+      }
+    };
+
+    const output = table(data, config);
+
+        // console.log(output);
+
+        /* eslint-disable no-restricted-syntax */
+    expectTable(output, `
+╔════════════╤════════════╤════════════╗
+║ 0A         │     0B     │         0C ║
+╟────────────┼────────────┼────────────╢
+║ 1A         │     1B     │         1C ║
+╟────────────┼────────────┼────────────╢
+║ 2A         │     2B     │         2C ║
+╚════════════╧════════════╧════════════╝
+        `);
+        /* eslint-enable no-restricted-syntax */
+  });
+});

package/test/README/usage/column_width.js

@@ -0,0 +1,33 @@
+import table from './../../../src';
+import expectTable from './expectTable';
+
+describe('README.md usage/', () => {
+  it('column_width', () => {
+    const data = [
+      ['0A', '0B', '0C'],
+      ['1A', '1B', '1C'],
+      ['2A', '2B', '2C']
+    ];
+
+    const config = {
+      columns: {
+        1: {
+          width: 10
+        }
+      }
+    };
+
+    const output = table(data, config);
+
+    // eslint-disable-next-line no-restricted-syntax
+    expectTable(output, `
+╔════╤════════════╤════╗
+║ 0A │ 0B         │ 0C ║
+╟────┼────────────┼────╢
+║ 1A │ 1B         │ 1C ║
+╟────┼────────────┼────╢
+║ 2A │ 2B         │ 2C ║
+╚════╧════════════╧════╝
+    `);
+  });
+});

package/test/README/usage/custom_border.js

@@ -0,0 +1,50 @@
+import table from './../../../src';
+import expectTable from './expectTable';
+
+describe('README.md usage/', () => {
+  it('usage/custom_border', () => {
+    const data = [
+      ['0A', '0B', '0C'],
+      ['1A', '1B', '1C'],
+      ['2A', '2B', '2C']
+    ];
+
+    /* eslint-disable sort-keys */
+    const config = {
+      border: {
+        topBody: '─',
+        topJoin: '┬',
+        topLeft: '┌',
+        topRight: '┐',
+
+        bottomBody: '─',
+        bottomJoin: '┴',
+        bottomLeft: '└',
+        bottomRight: '┘',
+
+        bodyLeft: '│',
+        bodyRight: '│',
+        bodyJoin: '│',
+
+        joinBody: '─',
+        joinLeft: '├',
+        joinRight: '┤',
+        joinJoin: '┼'
+      }
+    };
+    /* eslint-enable */
+
+    const output = table(data, config);
+
+    // eslint-disable-next-line no-restricted-syntax
+    expectTable(output, `
+┌────┬────┬────┐
+│ 0A │ 0B │ 0C │
+├────┼────┼────┤
+│ 1A │ 1B │ 1C │
+├────┼────┼────┤
+│ 2A │ 2B │ 2C │
+└────┴────┴────┘
+        `);
+  });
+});

package/test/README/usage/draw_horizontal_line.js

@@ -0,0 +1,41 @@
+import table from './../../../src';
+import expectTable from './expectTable';
+
+describe('README.md usage/', () => {
+  it('usage/draw_horizontal_line', () => {
+    const data = [
+      ['0A', '0B', '0C'],
+      ['1A', '1B', '1C'],
+      ['2A', '2B', '2C'],
+      ['3A', '3B', '3C'],
+      ['4A', '4B', '4C']
+    ];
+
+    const options = {
+      /**
+       * @typedef {Function} drawJoin
+       * @param {number} index
+       * @param {number} size
+       * @returns {boolean}
+       */
+      drawHorizontalLine: (index, size) => {
+        return index === 0 || index === 1 || index === size - 1 || index === size;
+      }
+    };
+
+    const output = table(data, options);
+
+    // eslint-disable-next-line no-restricted-syntax
+    expectTable(output, `
+╔════╤════╤════╗
+║ 0A │ 0B │ 0C ║
+╟────┼────┼────╢
+║ 1A │ 1B │ 1C ║
+║ 2A │ 2B │ 2C ║
+║ 3A │ 3B │ 3C ║
+╟────┼────┼────╢
+║ 4A │ 4B │ 4C ║
+╚════╧════╧════╝
+        `);
+  });
+});

package/test/README/usage/expectTable.js

@@ -0,0 +1,13 @@
+import {
+  expect
+} from 'chai';
+import _ from 'lodash';
+
+/**
+ * @param {string} result
+ * @param {string} expectedResult
+ * @returns {undefined}
+ */
+export default (result, expectedResult) => {
+  expect(result).to.equal(_.trim(expectedResult) + '\n');
+};

package/test/README/usage/moon_mission.js

@@ -0,0 +1,67 @@
+import _ from 'lodash';
+import chalk from 'chalk';
+import table, {
+    getBorderCharacters
+} from './../../../src';
+
+describe('README.md usage/', () => {
+  it('moon_mission', () => {
+    const data = [
+      [
+        chalk.bold('Spacecraft'),
+        chalk.bold('Launch Date'),
+        chalk.bold('Operator'),
+        chalk.bold('Outcome'),
+        chalk.bold('Remarks')
+      ],
+      [
+        'Able I',
+        '17 August 1958',
+        'USAF',
+        chalk.white.bold.bgRed('Launch failure'),
+        'First attempted launch beyond Earth orbit; failed to orbit due to turbopump gearbox malfunction resulting in first stage explosion.[3] Reached apogee of 16 kilometres (9.9 mi)'
+      ],
+      [
+        'Luna 2',
+        '12 September 1959',
+        'OKB-1',
+        chalk.black.bgGreen('Successful'),
+        'Successful impact at 21:02 on 14 September 1959. First spacecraft to reach lunar surface'
+      ],
+      [
+        'Lunar Orbiter 1',
+        '10 August 1966',
+        'NASA',
+        chalk.black.bgYellow('Partial failure'),
+        'Orbital insertion at around 15:36 UTC on 14 August. Deorbited early due to lack of fuel and to avoid communications interference with the next mission, impacted the Moon at 13:30 UTC on 29 October 1966.'
+      ],
+      [
+        'Apollo 8',
+        '21 December 1968',
+        'NASA',
+        chalk.black.bgGreen('Successful'),
+        'First manned mission to the Moon; entered orbit around the Moon with four-minute burn beginning at 09:59:52 UTC on 24 December. Completed ten orbits of the Moon before returning to Earth with an engine burn at 06:10:16 UTC on 25 December. Landed in the Pacific Ocean at 15:51 UTC on 27 December.'
+      ],
+      [
+        'Apollo 11',
+        '16 July 1969',
+        'NASA',
+        chalk.black.bgGreen('Successful'),
+        'First manned landing on the Moon. LM landed at 20:17 UTC on 20 July 1969'
+      ]
+    ];
+
+    const tableBorder = _.mapValues(getBorderCharacters('honeywell'), (char) => {
+      return chalk.gray(char);
+    });
+
+    table(data, {
+      border: tableBorder,
+      columns: {
+        4: {
+          width: 50
+        }
+      }
+    });
+  });
+});

package/test/README/usage/padding_cell_content.js

@@ -0,0 +1,39 @@
+import table from './../../../src';
+import expectTable from './expectTable';
+
+describe('README.md usage/', () => {
+  it('usage/padding_cell_content', () => {
+    const data = [
+      ['0A', 'AABBCC', '0C'],
+      ['1A', '1B', '1C'],
+      ['2A', '2B', '2C']
+    ];
+
+    const config = {
+      columns: {
+        0: {
+          paddingLeft: 3
+        },
+        1: {
+          paddingRight: 3,
+          width: 2
+        }
+      }
+    };
+
+    const output = table(data, config);
+
+    // eslint-disable-next-line no-restricted-syntax
+    expectTable(output, `
+╔══════╤══════╤════╗
+║   0A │ AA   │ 0C ║
+║      │ BB   │    ║
+║      │ CC   │    ║
+╟──────┼──────┼────╢
+║   1A │ 1B   │ 1C ║
+╟──────┼──────┼────╢
+║   2A │ 2B   │ 2C ║
+╚══════╧══════╧════╝
+        `);
+  });
+});