ayonious / console-table-printer Goto Github PK

This needs to be reduced

Hi, thanks for great job.
Is it possible to reset, empty rows ?
For making a dynamic array.

Would be good if directly from commandline we could call this function and parse things on command line.

Example:

"[
{index: 1, talbe: "okay"},
{index: 2, talbe: "okay1"},
]" | printTable

┌───────┬───────┐
│ index │ talbe │
├───────┼───────┤
│ 1 │ okay │
│ 2 │ okay1 │
└───────┴───────┘

Currently all text shown in white color. I would like to keep different color for number.

Cell text with different colors are breaking (Cell colored with chalk)

Hi,

Thanks for writing this - we quite like it.

I noticed a bunch of new versions, but there isn't a changelog, nor tags on the repo mapping back to the NPM package.

Just some friendly feedback for users - it would be great if we could see a change log file or at least tags on the repo that match the npm artifacts. We actually use this in a cli app that we share with 50+ people so it would be nice to make the upgrade path a little easier.

I've found using commitizen and standard-version packages make this quite a nice experience - if you were looking for a suggestion.

Anyways, thanks again for publishing this!

Hi,
I am trying to implement a dotmatrix print functionality for invoice generated by web application in browser and by default browser send the HTML as bitmap to printer and dotmatrix printer are not good in bitmap/image printing.

As it is an invoice on pre-printed stationery and columns width is fixed, I need to provide min column width or you can say fixed width column.

Another enhancement is to print a table without column header.

Thanks.

See #57 for another report of similar bug.

If I do something like:

const p = new Table();
p.addRows(
  [
    { index: 3, text: chalk.red("text"), value: 100 },
    { index: 4, text: 'short', value: 300 },
  ],
);
p.printTable();

Then the spacing for the cell is off because it's width is incorrectly calculated.

I have objects I want to pass in as rows, but I don't want to use those keys as the column headers. I would like to specify a column header name directly instead.

Something like:

const p = new Table({
  columns: [
    { name: "index", title: 'Index', alignment: "left", color: "yellow" }, // column coloring
    { name: "text", title: chalk.blue('Description'), alignment: "right" },
  ],
});

Is this possible already?

The ability to change the header position to the bottom or the sides of the table.

Sometimes when the json input is too huge its better to be able to configure which columns I want to see. or which columns I dont want to see.

Could be something like this

new Table({
    hide_columns: ["col1"],
    show_colmumns: ["col2"]
});

Great job with this module.

When creating a computed column with a custom title, the column will still display the name as a title.

computedColumns: [{
    title: "my title",
    name: "col_name",
    function: row => "row value"
}]

Maybe createColumn could receive a title as well? Some pseudo-code:

export const createColum = (name: string, title: string): Column => ({ name, title: title ? title : name });

Coneverting the Repo to Typescript

color.
alignment

in a table if we can text wrap data.

The following code fails with the Invalid count value when no rows error.

import { printTable, Table } from 'console-table-printer';

const table = new Table({
  title: 'Project folders',
});
table.printTable();

It looks like the textWithPadding() function in the string-utils file does not handle situation when the size is invalid.

The use case is to print the table header even when there are no items to render.

In case of line being too long would be good this line to be splited based on max width of the column. Currently everything is printed in one line

If I have a very long path in my table, is it possible to also split after / character?

Example: /home/user/project/subproject/category/66623/contents/fd6873d67a3f3d67a3.jpg

Should be in the table (with maxLen) something like:

/home/user/project/subproject/
category/66623/contents/
fd6873d67a3f3d67a3.jpg

There is an error with this repository's Renovate configuration that needs to be fixed. As a precaution, Renovate will stop PRs until it is resolved.

Error type: undefined. Note: this is a nested preset so please contact the preset author if you are unable to fix it yourself.

Curently the addRows() method doesnt take color arguement. A common color for addRows method should be supported

Currently print function only prints the results on console.
It would be cool if it also returns the table as array.
This way user can also print it in some file or any other place he wants.

Would be good to give input a function that will generate a new column.

Example Problem: I would like to get % of each row (apple_percent) Where input columns are only
apple_amount, orange_amount

apple_amount  orange_amount apple_percent
1 1 50
2 1 33.3%

Hey!

I really appreciate your fantastic package!

I use render() to get a string but it has come with ANSI escape codes like [37m. Is there any way to get the raw text?

I want to use the output in a Telegram message so I need the raw text.

P.S. I can create a pull request if it's approved! Something like render(raw: boolean) => string with the false default value for raw to have backward compatibility

This is a feature request to add support for center aligning columns. Right now, it only supports left and right.

I can't find any way to make the columns appear in the table in a certain order.
In particular, they don't follow the order in the columns, or enabledColumns attribute fed to the table constructor.

I have an array that have some Dates props,

Can we print the table with a specific date format? Any configuration ?

Thanks, the fact that I'm able to print the table is already awesome, thank you guys!

any way to fix it or making the column bigger than the text?

Sometimes you want to show a text as a banner that is wrapped up with box.

const { printTable } = require('./dist');

//Create a table
const testCases = [
  { index: 3, text: 'I would like some gelb bananen bitte', value: 100 },
  { index: 4, text: 'I hope batch update is working', value: 300 },
  { index: 4, text: 'Unicode.... \uD83C\uDD9E', value: 300 },
];

//print
printTable(testCases);

This might be of interest: https://stackoverflow.com/questions/54369513/how-to-count-the-correct-length-of-a-string-with-emojis-in-javascript

Though the fix likely is [...str].length. Example:

let str = `Unicode.... \uD83C\uDD9E`
console.log(str.length) // 14
console.log([...str].length) // 13

Example:

const p = new Table();
p.addRows([{ col1: 'col1', col2: `col\n2`, col3: 'col3' }]);
p.printTable();

produce:

┌──────┬──────┬──────┐
│ col1 │ col2 │ col3 │
├──────┼──────┼──────┤
│ col1 │ col
2 │ col3 │
└──────┴──────┴──────┘

expect:

┌──────┬──────┬──────┐
│ col1 │ col2 │ col3 │
├──────┼──────┼──────┤
│ col1 │ col2 │ col3 │
│      │ 2    │      │
└──────┴──────┴──────┘

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Awaiting Schedule

These updates are awaiting their schedule. Click on a checkbox to get an update now.

• chore(deps): update all dependencies (cimg/node, typescript)

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

• chore(deps): lock file maintenance

Detected dependencies

• Check this box to trigger a request for Renovate to run again on this repository

Thanks for this library. I really appreciate how easy it was to quickly understand and apply. Nice job on the docs and API design!

I found myself printing a couple narrow tables, where they could have fit side-by-side in my terminal. Something like this:

       Table One               Table Two 
┌───────┬──────┬──────┐ ┌───────┬──────┬──────┐
│ Foo   │ Bar  │ Baz  │ │ Foo   │ Bar  │ Baz  │
├───────┼──────┼──────┤ ├───────┼──────┼──────┤
│ aaa   │   13 │    8 │ │ aaa   │   43 │    8 │
│ bbb   │   99 │   10 │ │ bbb   │   12 │   10 │
│ ccc   │   91 │    9 │ │ ccc   │   12 │    9 │
│ ddd   │   45 │    6 │ │ ddd   │   75 │    6 │
│ eee   │   32 │    4 │ │ eee   │   62 │    4 │
│ fff   │   31 │    4 │ │ fff   │   61 │    4 │
│ ggg   │   26 │    3 │ │ ggg   │   56 │    3 │
│ hhh   │   12 │    7 │ └───────┴──────┴──────┘
│ iii   │   21 │    7 │ 
└───────┴──────┴──────┘ 

Would you be open to a PR that adds something like this? I'm thinking the API could be something like:

import { printTables } from "console-table-printer";
// ...
printTables(table1,table2);

console-table-printer v2.9.0

const bundle = new Table({
  title: 'Bundle (BUNDLENAME)',
  columns: [
    { name: 'Weapon' },
    { name: 'Chroma' },
    { name: 'Quality' },
    { name: 'Price' },
  ],
})

bundle.addRows([
  {
    Weapon: '👍🏻',
    Chroma: '✅',
    Quality: 'Deluxe',
    Price: '1 775 VP',
  },
])

bundle.printTable()

Result:

示例代码：
const { Table } = require('console-table-printer');
const p = new Table();
let MAP = {
'libVersion': '小程序SDK版本库',
'es6': 'ES6转ES5',
'enhance': '增强编译',
'nodeModules': '使用npm模块',
'minified': '上传代码自动压缩混淆'
};
for (let keyName in MAP) {
p.addRow({ '选项': MAP[keyName], '设置的值': resourceValue, '参考值': targetValue });
}
p.printTable();

输入结果：

Willing to take a crack at this myself, just let me know if this is wanted.

I think it would be useful for the Table constructor or a static from method accepts a object and automatically generates a table. Similar to console.table but also allows a config parameter to change column size and the like.

Let me know!

I don't understand how the charLength works when combined with text.

https://console-table.netlify.app/docs/doc-emojis-special-chars

See this example:

import { Table } from "console-table-printer";

const table = new Table({
  rows: [
    {
      file: "All files",
      "% score": 87.87,
      "✅ killed": 158,
      "⏳ timeout": 4,
      "👽 survived": 15,
      "🙈 no cov": 8,
      "💥 error": 0,
    },
  ],
  charLength: { "⏳": 3, "✅": 2, "👽": 2, "🙈": 2, "💥": 2 },
});

table.printTable();

This outputs:

┌───────────┬─────────┬───────────┬─────────────┬─────────────┬───────────┬──────────┐
│      file │ % score │  ✅ killed │   ⏳ timeout │ 👽 survived │ 🙈 no cov │ 💥 error │
├───────────┼─────────┼───────────┼─────────────┼─────────────┼───────────┼──────────┤
│ All files │   87.87 │       158 │           4 │          15 │         8 │        0 │
└───────────┴─────────┴───────────┴─────────────┴─────────────┴───────────┴──────────┘

But AFAIK I used the correct char lengths for the emojis. What exactly should the value of a charLength be?

Currently if there are multiple line column (width limited column), it looks hard to detect separate rows.

Would be good to have a way to put a separator between each row in this case to figure out each row.

Something like this would be nice:

• Customer border decoration
• Border coloring ability

Originally reported by @rylanzhou

I've found that if the text to be displayed contains special characters, e.g., chinese, which actually takes up two spaces for one character, it will cause alignment problems. Here's an example:

┌────────────────────────────────────────────────────────────┬─────────────┐
│ SUMMARY                                                    │         KEY │
├────────────────────────────────────────────────────────────┼─────────────┤
│ Some Descriptions and Summary 这里是中文这里是中文这里是中文                │ ISSUE-19150 │
│ Some Summary 这里是中文这里是中文                │ ISSUE-18072 │
│ Description 这里是中文                │ ISSUE-17787 │
└────────────────────────────────────────────────────────────┴─────────────┘

By doing some research, I figured out that this is because the original str.length does not output the correct unicode length of a special character.

'char'.length; // Outputs 4, correct
'中'.length; // Outputs 1, but it actually contains 2 unicodes

The same problem also occurs when calling str.padEnd() and str.padStart().

Hoping to fix this for better compatibility, I've installed a dependency called wcwidth. This dependency would correctly return the unicode length of any special character.

At end of each table we can print the av/sum of a column.

For example, if I want to color a particular cell if the user has a score >x and different when the score is <x.

Adding a title at the top of the table would be awesome!

Thanks for the package!

Thanks for the library.

Can you add a feature where the table is sorted by column names and enable passing in something like 'ASC' or 'DESC' and also by defined column header names I pass?

Originally started from this:
#361

Im trying to find the best way to allow this.
How would the input in this case look like? Should it be array or arrays of string?

Need to add code coverage tools

When I try to use it in Heroku (A PaaS that works using Ubuntu), tables doesn't display as should be

Is it possible to render a table to string instead of the console? I'd like to render the table to string and send it over the wire to be rendered somewhere else.

Hi.
In this case:
const p = new Table();
p.addRows([{index:0, value:0}, {index:1, value:1}]);
p.printTable();

this is the result (node.js v10.16.0)
╔═══════╦═══════╗
║ index ║ value ║
╟═══════╬═══════╢
║ ║ ║
║ 1 ║ 1 ║
╚═══════╩═══════╝

where did the zeros go?

Yo,

Nice tool! I've been using it to spice up some performance testing output, and it seems to work well.

It'd be great if there was a convenience method that matches the API of console.table, so instead of having to do...

  const t = new Table()
  t.addRows(TEST_CASES)
  t.printTable()

You could just do...

Table.printTable(TEST_CASES)

It would be a nice feature if one could control alignment (left/right/center) of data within the cells - by column, say.

The image shows it quite clearly.
It looks like horizontal lines are drawn in the default color and vertical lines are drawn in white.
That looks a bit weird imho.