Skip to content

Add a @table formatter with optional headings #3334

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Draft
wants to merge 27 commits into
base: master
Choose a base branch
from
Draft

Add a @table formatter with optional headings #3334

wants to merge 27 commits into from

Conversation

@yertto
Copy link

@yertto yertto commented Jun 1, 2025 •
edited
Loading

Overview

This PR introduces a new @table string output formatter to jq.

Examples

(Nb. using -n / --null-input, -r / --raw-output)

  •  jq -nr '[["one","two","three"],[1,2,3]] | @table'

    ┌───┬───┬─────┐
│one│two│three│
│1  │2  │3    │
└───┴───┴─────┘

  •  jq -nr '{"headings":["one","two","three"],"rows":[[1,2],["unicycle","","tricycle"]]} | @table'

    ┌────────┬───┬────────┐
│one     │two│three   │
├────────┼───┼────────┤
│1       │2  │        │
│unicycle│   │tricycle│
└────────┴───┴────────┘

@yertto yertto marked this pull request as draft June 1, 2025 09:17
@yertto yertto force-pushed the yertto/table branch 13 times, most recently from 8c1485a to 29b63d6 Compare June 5, 2025 12:12
yertto added 16 commits June 5, 2025 22:17
@yertto
Add table_format stub
16c55cd
@yertto
table with quoted strings
8c8025f
@yertto
here1
2551a58 
❯ echo '[["foo", "bar", "baz"], ["a", "b", "c"], [1, null, 3]]' | ./jq --raw-output '@table'
┌───┬────┬───┐
│foo│bar │baz│
├───┼────┼───┤
│a  │b   │c  │
│1  │null│3  │
└───┴────┴───┘
@yertto
here2
bfb0ec2 
❯ echo '{"headings": ["foo", "bar", "baz"], "rows": [["a", "b", "c"], [1, null, 3]]}' | ./jq --raw-output '@table'
┌───┬────┬───┐
│foo│bar │baz│
├───┼────┼───┤
│a  │b   │c  │
│1  │null│3  │
└───┴────┴───┘

❯ echo '[["foo", "bar", "baz"], ["a", "b", "c"], [1, null, 3]]' | ./jq --raw-output '@table'
┌───┬────┬───┐
│foo│bar │baz│
│a  │b   │c  │
│1  │null│3  │
└───┴────┴───┘
@yertto
feat: optional headings
2a87537 
❯ echo '{"rows": [["a", "b", "c"], [1, null, 3]]}' | ./jq --raw-output '@table'
┌─┬────┬─┐
│a│b   │c│
│1│null│3│
└─┴────┴─┘
@yertto
feat: colorize_words
dd04aac
@yertto
feat: accept arrays of json
7ebc603 
❯ ./jq --raw-output '@table' <<-EOF
[
  {"false":"true", "bartrue":"false", "baz":"TRUE"},
  {"false":1, "bartrue":null, "baz":0},
  {"false":"true false", "bartrue":"FALSE TRUE", "baz":"falsetrue"}
]
EOF
┌──────────┬─────────┬──────────┐
│bartrue   │baz      │false     │
├──────────┼─────────┼──────────┤
│false     │TRUE     │true      │
│null      │0        │1         │
│FALSE TRUE│falsetrue│true false│
└──────────┴─────────┴──────────┘
@yertto
feat: dont sort columns
c15c933 
❯ ./jq --raw-output '@table' <<-EOF
[
  {"false":"true", "bartrue":"false", "baz":"TRUE"},
  {"false":1, "bartrue":null, "baz":0},
  {"false":"true false", "bartrue":"FALSE TRUE", "baz":"falsetrue"}
]
EOF
┌──────────┬──────────┬─────────┐
│false     │bartrue   │baz      │
├──────────┼──────────┼─────────┤
│true      │false     │TRUE     │
│1         │null      │0        │
│true false│FALSE TRUE│falsetrue│
└──────────┴──────────┴─────────┘
@yertto
feat: accept headings for object arrays
0dffa29 
❯ ./jq --raw-output '@table' <<-EOF
{
  "headings": ["baz", "bartrue"],
  "rows": [
    {"false":"true", "bartrue":"false", "baz":"TRUE"},
    {"false":1, "bartrue":null, "baz":0},
    {"false":"true false", "bartrue":"FALSE TRUE", "baz":"falsetrue"}
  ],
  "color_words": ["(no|NO|false|FALSE)", "(yes|YES|true|TRUE)", "null"]
}
EOF
┌─────────┬──────────┐
│baz      │bartrue   │
├─────────┼──────────┤
│TRUE     │false     │
│0        │null      │
│falsetrue│FALSE TRUE│
└─────────┴──────────┘
@yertto
refactor: split into format_table* files
df0444f
@yertto
fix: use oniguruma insted of posix regex library
cccf3cf
@yertto
fix: when compiling _without_ Oniguruma
1bf80c4
@yertto
test: add table tests
2c84263
@yertto
fix: running tests with Oniguruma enabled/disabled
2623a8c
@yertto
try this
12217e8
@yertto
try this 2
b3bf9f8
@yertto yertto force-pushed the yertto/table branch 5 times, most recently from b8429b3 to 3cc7244 Compare June 5, 2025 12:39
@yertto yertto changed the title Add a @table formatter with object/array row handling Add a @table formatter with optional headings Jun 5, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@yertto