stdlib-js / stdlib-js/stdlib

[RFC]: add support for pretty printing tabular data in the REPL

オープン
#2,067 コメント 10 件 リアクション 0 件 担当者 1 名 @Snehil-Shah が担当を希望しています GitHub で見る
difficulty: 4 Enhancement JavaScript Needs Discussion priority: Normal REPL RFC
主要言語
JavaScript
スター
6k
フォーク
1.3k
平均マージ
1日 3時間
マージ済み PR(30日)
611

説明

### Description

This RFC proposes adding support for displaying tabular data in the REPL. Possible signature:

```
table( data[, n] )
```

It could work in a manner similar to `head`/`tail`, where, if `n > 0`, show the first `n` rows, and, if `n < 0`, show the last `n` rows.

The function could also support options, such as maximum cell width (e.g., to enforce showing abbreviated cell contents (such as truncating long strings)).

If `data` is an array of objects, could use keys as headers. Otherwise, if array of arrays, could support providing a list of headers.

### Related Issues

No.

### Questions

- Generating ASCII tables is likely to be applicable beyond just the REPL. So one question is whether the implementation for ASCII tables should live outside the REPL (e.g., in `@stdlib/plot/ascii/table` or similar) and then the REPL would just use that package for displaying tabular data? This probably makes sense, and we'd just need to define the API surface of the ASCII table package.
- We should also support `ndarray` data.

### Other

ASCII tables are fairly common, so prior art should be relatively easy to find. For example,

- https://github.com/tecfu/tty-table
- https://github.com/sorensen/ascii-table

### Checklist

- [X] I have read and understood the [Code of Conduct](https://github.com/stdlib-js/stdlib/blob/develop/CODE_OF_CONDUCT.md).
- [X] Searched for existing issues and pull requests.
- [X] The issue name begins with `RFC:`.

コントリビューションガイド

コントリビューションガイドを開く

評価

この issue はまだ評価されていません。

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。