tty-table 4.2.3 → 5.0.0

package/README.md

@@ -1,4 +1,4 @@
-# tty-table 端子台
+# tty-table
 
 [![NPM version](https://badge.fury.io/js/tty-table.svg)](http://badge.fury.io/js/tty-table) [![Coverage Status](https://coveralls.io/repos/github/tecfu/tty-table/badge.svg?branch=master)](https://coveralls.io/github/tecfu/tty-table?branch=master)
 ---
@@ -178,7 +178,7 @@ const footer = [
 | color | <code>string</code> | default: terminal default color |
 | compact | <code>boolean</code> | default: false <br/> Removes horizontal borders when true. |
 | defaultErrorValue | <code>mixed</code> | default: '�' |
-| defaultValue | <code>mixed</code> | default: '?' |
+| defaultValue | <code>mixed</code> | default: '""' |
 | errorOnNull | <code>boolean</code> | default: false |
 | truncate | <code>mixed</code> | default: false <br/> When this property is set to a string, cell contents will be truncated by that string instead of wrapped when they extend beyond of the width of the cell.  <br/> For example if: <br/> <code>"truncate":"..."</code> <br/> the cell will be truncated with "..." <br/> Note: tty-table wraps overflowing cell text into multiple lines by default, so you would likely only utilize `truncate` for extremely long values. |
 | width | <code>string</code> | default: "100%" <br/> Width of the table. Can be a percentage of i.e. "50%" or a fixed number of columns in the terminal viewport i.e. "100". <br/> Note: When you use a percentage, your table will be "responsive".|

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tty-table",
-  "version": "4.2.3",
+  "version": "5.0.0",
   "description": "Node cli table",
   "main": "src/main.js",
   "types": "src/factory.d.ts",
@@ -25,7 +25,7 @@
     "save-tests": "node npm_scripts/run-examples.js save",
     "view-examples": "node npm_scripts/run-examples.js view",
     "lint": "npx eslint adapters/*.js src/*.js",
-    "lint-fix": "npx eslint adapters/*.js src/*.js --fix",
+    "lint-fix": "npx eslint adapters/*.js src/*.js examples/*.js --fix",
     "lint-examples": "npx eslint examples/",
     "lint-fix-examples": "npx eslint examples/ --fix",
     "prepublishOnly": "npm run dist",

package/src/defaults.js

@@ -29,8 +29,7 @@ const defaults = {
   COLUMNS: 80, // if !process.stdout.columns assume redirecting to write stream 80 columns is VT200 standard
   compact: false,
   defaultErrorValue: "�",
-  // defaultValue: "\u001b[31m?\u001b[39m",
-  defaultValue: " ?",
+  defaultValue: "",
   errorOnNull: false,
   FIXED_WIDTH: false,
   footerAlign: "center",

package/src/render.js

@@ -1,5 +1,6 @@
 const Style = require("./style.js")
 const Format = require("./format.js")
+const stripAnsi = require("strip-ansi")
 
 /**
  * Converts arrays of data into arrays of cell strings
@@ -31,7 +32,12 @@ module.exports.stringifyData = (config, inputData) => {
   if (global.columnWidths[config.tableId]) {
     config.table.columnWidths = global.columnWidths[config.tableId]
   } else {
-    global.columnWidths[config.tableId] = config.table.columnWidths = Format.getColumnWidths(config, rows)
+    const formattedRows = rows.map((row, rowIndex) => {
+      return row.map((cell, cellIndex) => {
+        return exports.buildCell(config, cell, cellIndex, "body", rowIndex, rows, inputData, true)
+      })
+    })
+    global.columnWidths[config.tableId] = config.table.columnWidths = Format.getColumnWidths(config, formattedRows)
   }
 
   // stringify header cells
@@ -207,13 +213,13 @@ module.exports.buildRow = (config, row, rowType, rowIndex, rowData, inputData) =
   return linedRow
 }
 
-module.exports.buildCell = (config, elem, columnIndex, rowType, rowIndex, rowData, inputData) => {
+module.exports.buildCell = (config, elem, columnIndex, rowType, rowIndex, rowData, inputData, dryRun = false) => {
   let cellValue = null
 
   const cellOptions = Object.assign(
     { reset: false },
     config,
-    (rowType === "body") ? config.columnSettings[columnIndex] : {}, // ignore columnSettings for footer
+    (rowType !== "header") ? config.columnSettings[columnIndex] : {},
     (typeof elem === "object") ? elem : {}
   )
 
@@ -226,6 +232,9 @@ module.exports.buildCell = (config, elem, columnIndex, rowType, rowIndex, rowDat
       case (typeof elem === "undefined" || elem === null):
         // replace undefined/null elem values with placeholder
         cellValue = (config.errorOnNull) ? config.defaultErrorValue : config.defaultValue
+        if (!Style.isColorEnabled()) {
+          cellValue = stripAnsi(cellValue)
+        }
         // @TODO add to elem defaults
         cellOptions.isNull = true
         break
@@ -242,7 +251,7 @@ module.exports.buildCell = (config, elem, columnIndex, rowType, rowIndex, rowDat
           style: Style.style,
           resetStyle: Style.resetStyle
         })(
-          (!cellOptions.isNull) ? cellValue : "",
+          cellValue,
           columnIndex,
           rowIndex,
           rowData,
@@ -256,7 +265,7 @@ module.exports.buildCell = (config, elem, columnIndex, rowType, rowIndex, rowDat
     }
 
     // run formatter
-    if (typeof cellOptions.formatter === "function") {
+    if (rowType === "body" && typeof cellOptions.formatter === "function") {
       cellValue = cellOptions.formatter
         .bind({
           configure: function (object) {
@@ -265,13 +274,17 @@ module.exports.buildCell = (config, elem, columnIndex, rowType, rowIndex, rowDat
           style: Style.style,
           resetStyle: Style.resetStyle
         })(
-          (!cellOptions.isNull) ? cellValue : "",
+          cellValue,
           columnIndex,
           rowIndex,
           rowData,
           inputData
         )
     }
+
+    if (dryRun) {
+      return cellValue
+    }
   }
 
   // colorize cellValue

package/src/style.js

@@ -56,3 +56,7 @@ module.exports.colorizeCell = (str, cellOptions, rowType) => {
 
   return str
 }
+
+module.exports.isColorEnabled = () => {
+  return (process && process.stdout) ? colorLib.level > 0 : colorLib.enabled
+}