Hi, Using Polish characters( like ą,ć,ę etc) cause layout breakage. Output from echo -e "abc\nabć\nab한" | ./node_modules/.bin/tty-table is on this screenshot. Format.calculateLength assumes all unicode chars to be two-char width on display which isn't true. Imo correct way to implement it is to (re)use method from npm east-asian-width( see also links section at the bottom of project's page). Cheers

Problem Summary

Resize code has several issues

• Sometimes the table is too wide
• The table is often more narrow than it needs to be
• At very small sizes the formatting can be broken

Expected Result (screen shot if possible)

Formatting should always be correct and the table should always be the desired width

Actual Result (screen shot if possible)

See attached output of https://gist.github.com/mscalora/628b05731b7674a1993115752bafd1ee resize-table.txt

Environment Information

• OS: MacOS

• Terminal Emulator: iTerm

Steps to Reproduce

1. run: curl https://gist.githubusercontent.com/mscalora/628b05731b7674a1993115752bafd1ee/raw/41a1aab155d4235144513eebefe401fe10169456/resize-table.js | node -
2. examine output

Fixes

I would like to take on fixing these issues and enhancing the table resize functionality with some addition options to better control how resize works:

• Fix the proportional resize mode issue outline above
• Add a resize mode that works like CSS flex layout "shrink" mechanism so one can specify which columns should be resized irrespective of content
• Add a option for desired max output width that will override the terminal width (stdout.columns)
• Add minimum column width option that can be set on all or specific columns
• Maybe: Add an option to truncate the whole table if it can't fit in the max output width

Proposed new table options:

    maxTableWidth: "auto" (default) | "none" | number of char
    truncateTable: true (default, if > maxTableWidth) | false | # of char 
    minColWidth: number of char (4 default)
    resizeTable: "proportional" (default) | "shrink" (only used if natural width is > maxTableWidth)

Proposed new column (header) options:

    minWidth: number of char (default is global minColWidth)
    shrink: [optional] used to weight resizing in "shrink" resize mode

Notes:

• minWidth would be respected by both resize modes

Shrink Mode

  Columns are reduced using the weighting of  shrink / sum(all shrinks)
    Col  |  Shink  | Proportion of resize
     A   |    0    |  none
     A   |    1    |  1/5 or 20%
     A   |    4    |  4/5 or 80%

Discussion

I've actually already started and have most of the work done. I planned on submitting a pull request but wanted to start a discussion and get feedback while I'm still working on it. I understand it may be a a lot of complexity for the scope of this project so I am happy to fork if it is judged to be beyond the desired scope since I need something like this. Also, I can fix some of the issues listed at the top without the new features but it would be a significant amount of extra work to pull that out. I was trying to implement a "legacy" mode but these issues I ran into make that difficult, the broken formatting may only be fixable with some changes like minWidth or using a truncated truncation string.

Running code in examples/data/fake-stream.js with node process_name | tty-table --format=json

Output via console.log(JSON.stringify(array))

Throws undefined

Node v8.1.4

When using in browser with browserify, recent builds break with the message:

>> Error: Cannot find module 'spawn-sync' from './node_modules/cross-spawn'

The issue is, that there is no spawn-sync for browsers as spawning is not possible, I guess. So cross-spawn only works in node. I don't know if it was ever intended, but previous versions (until 2.2.x) worked great in the browsers console... From Version 2.3.0 until the most recent versions, it does not work anymore.

$ npm ls cross-spawn
analyzer
└─┬ [email protected]
  └─┬ [email protected]
    └─┬ [email protected]
      └─┬ [email protected]
        └── [email protected] 

For now I am sticking with version 2.2.5, as my module must work in node.js and browsers, using the table as debug output.

Problem Summary

Upgrading from 2.8.11 to 2.8.12 broke my application. After investigating, I noticed that chalk was replaced with kleur in version 2.8.12. I was using whiteBright as a header color, which is supported by chalk, but not kleur. This is a backwards compatibility break, and I think it should have caused in a major version bump.

In addition to the BC break, it's no longer possible to use bright/bold colors in headers as far as I can tell. I think you'd need to introduce a header equivalent to the formatter option to restore that functionality.

Expected Result (screen shot if possible)

Using whiteBright as a header color should continue to work when upgrading from 2.8.11 to 2.8.12.

Actual Result (screen shot if possible)

Using whiteBright as a header color throws the following error:

TypeError: kleur[color] is not a function
    at /path/to/project/node_modules/tty-table/src/style.js:6:24
    at Array.reduce (<anonymous>:null:null)
    at Object.module.exports.color (/path/to/project/node_modules/tty-table/src/style.js:5:17)
    at Object.module.exports.colorizeCell (/path/to/project/node_modules/tty-table/src/style.js:28:19)
    at Object.module.exports.buildCell (/path/to/project/node_modules/tty-table/src/render.js:275:21)
    at Object.module.exports.buildRow (/path/to/project/node_modules/tty-table/src/render.js:177:21)
    at /path/to/project/node_modules/tty-table/src/render.js:45:24
    at Array.map (<anonymous>:null:null)
    at Object.module.exports.stringifyData (/path/to/project/node_modules/tty-table/src/render.js:44:45)
    at Array.Factory.tableObject.render (/path/to/project/node_modules/tty-table/src/factory.js:175:25)
    at outputSites (/path/to/project/node_modules/@codeworx/sparse-dev/src/server.js:112:34)
    at run (/path/to/project/node_modules/@codeworx/sparse-dev/src/server.js:69:15)
    at runMicrotasks (<anonymous>:null:null)
    at processTicksAndRejections (internal/process/task_queues.js:97:5)

Environment Information

• OS: N/A
• Terminal Emulator: N/A

Steps to Reproduce

Run this code using 2.8.11, then 2.8.12. Observe that the upgrade breaks BC:

const Table = require('tty-table')

const header = [
  {
    value: 'Heading',
    headerColor: 'whiteBright',
  },
]
const rows = [['Row']]
const table = new Table(header, rows)

console.log(table.render())

It it possible to get rid of excess new lines at the beginning of the table ? and around the heading ?

Also how to disable colors for the heading ?

• OS: Windows 10 (Creator's Update)

• Terminal Emulator: ConEmu

Thanks

Problem Summary

The merge module is slow, the cli that i'm building depend on it to render few lines, i'm seing a ~4x difference between Object.assign and merge : Object.assign:

/home/vmarchaud/****/bin/pmp.js status  0,48s user 0,04s system 40% cpu 1,276 total

Merge:

/home/vmarchaud/****/bin/pmp.js status  2,06s user 0,06s system 78% cpu 2,696 total

Expected Result (screen shot if possible)

Actual Result (screen shot if possible)

Environment Information

• OS: Uubuntu 17.10

• Terminal Emulator: Vscode (xterm.js)

Steps to Reproduce

1. Have a CLI using tty-table
2. Replace Merge here by Object.assign
3. Profit

Conclusion

Would it be possible to use Object.assign when available ? I dont mind making a PR if needed

Problem Summary

Version 2.5.6 introduce the following issue: It is not possible to have multiple tables with a different number of columns. Version 2.5.5. is ok.

Consider this code:

import table from 'tty-table';

const header = [
  { value: 'col1' },
  { value: 'col2' }
];

const rows = [[1, 2]];
console.log(table(header, rows).render());

const header2 = [
  { value: 'col1' },
  { value: 'col2' },
  { value: 'col3' }
];

const rows2 = [[1, 2, 3]];
console.log(table(header2, rows2).render());

Expected Result

Actual Result

Environment Information

• OS: macOS High Sierra
• Terminal: iTerm2

Hi, I'm using truncate: "..." and global parameter for my table and I'm trying to prevent truncation on a single cell. I Had no luck with truncate: false (default value) which sets the cell content to "false" (bug?)

Any idea? Thanks!

I have csv file with line number of 365.

When i remove line 363. It still throw the error until my csv total line become 362.

I think the only line it can read is 363?

Command i use to read is. cat filename.csv | tty-table

environment: osx 10.12.6 node: v6.10.3

Problem Summary

Projects using tty-table such as the popular changesets cli output deprecation warning related to smartwrap:

Expected Result (screen shot if possible)

No deprecation warning

Actual Result (screen shot if possible)

See screenshot above.

Environment Information

• OS: GNU/Linux 5.15.11-3-t2

• Terminal Emulator: Alacritty

• Node Version: 17.x

Steps to Reproduce

1. Clone https://codeberg.org/vhs/oathqr
2. Install dependencies with pnpm i
3. Run pnpm up to observe warning message

Problem Summary

If any column width is evaluated to float, RangeError will be thrown on that line:

let emptySpace = columnWidth - lineLength
const padRemainder = emptySpace % 2
...
Array(padBoth + 1 + padRemainder).join(" ")

Array constructor doesn't accept float as a parameter, therefore that exception is thrown:

RangeError: Invalid array length

Expected Result (screen shot if possible)

No exception is thrown. Column widths are always coerced to ints.

Actual Result (screen shot if possible)

Column widths can be floats, exception is thrown

Environment Information

• OS: all

• Node Version: reproduced on 8.x and 16.x

Steps to Reproduce

1. Set headers with percentage widths not divisible by total table width and not exceeding the table width when summed up
2. Try to create a table

Example affected headers:

const baseHeaders = [
  { alias: "Fixed header", width: "25%" },
  { alias: "Auto header" }
]

Error is not present when columns exceed viewport width, because in that case widths are coerced in Format.getColumnWidths, more specifically:

  if (totalWidth > availableWidth || config.FIXED_WIDTH) {
    // proportion wont be exact fit, but this method keeps us safe
    const proportion = (availableWidth / totalWidth).toFixed(2) - 0.01
    const relativeWidths = widths.map(value => Math.max(2, Math.floor(proportion * value)))
    if (config.FIXED_WIDTH) return relativeWidths

    // when proportion < 0 column cant be resized and totalWidth must overflow viewport
    if (proportion > 0) {
      const totalRelativeWidths = relativeWidths.reduce((prev, current) => prev + current)
      widths = (totalRelativeWidths < totalWidth) ? relativeWidths : widths
    }
  }

Problem Summary

I am trying to align a footer cell to right.

Expected Result (screen shot if possible)

Actual Result (screen shot if possible)

Environment Information

• OS: latest public macOS

• Terminal Emulator: iTerm2 with zsh and zprezto plugin

• Node Version: LTS

Steps to Reproduce

  const header = [
    {
      value: 'Test',
      align: 'left',
      headerAlign: 'left',
      footerAlign: 'right',
    },
    {
      value: 'Score',
      align: 'left',
      headerAlign: 'left',
      footerAlign: 'left',
      formatter: (cellValue) => {
        return cellValue > 60 ? green(cellValue) : red(cellValue)
      },
    },
  ]
  const rows = [
    ['Performance', 64],
    ['Accessibility', 70],
    ['Best Practices', 30],
    ['SEO', 60],
    ['PWA', 100],
  ]
  const footer = [
    'Total',
    (cellValue, columnIndex, rowIndex, rowData) => {
      const total = Math.round(rowData.map((i) => i[1]).reduce((p, c) => p + c) / 5)
      return italic(total)
    },
  ]
  const renderedTable = Table(header, rows, footer).render()
  console.log(renderedTable)

Problem Summary

I'm using a formatter function to add 'USD' to a money amount. The automatic column width is determined by the value before the formatter instead of the string returned by the formatter.

Expected Result (screen shot if possible)

Automatic column width should be wider.

Actual Result (screen shot if possible)

It's the width based on the original value before the formatter.

Steps to Reproduce

1. Basic table code without specifying column widths
2. formatter: (cellValue) => { return cellValue + ' USD' }
3. Column is not wide enough.