stdlib-js / stdlib-js/stdlib

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

未关闭
#2,067 10 条评论 0 个 reaction 已指派 1 人 已被 @Snehil-Shah 认领 在 GitHub 查看
difficulty: 4 Enhancement JavaScript Needs Discussion priority: Normal REPL RFC
主要语言
JavaScript
星标
6k
派生
1.3k
平均合并
1 天 3 小时
30 天内合并 PR
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 摘要。