crashappsec / crashappsec/chalk

Chalk may incorrectly format a table's header and first row

Open
#167 0 comments 0 reactions 0 assignees View on GitHub
bug documentation
Dominant language
Nim
Stars
436
Forks
25
PR merge metrics
No merged PRs in 30d

Description

## Description

At some window and font size combinations, the formatting may be broken:

- at the end of a table header
- at the beginning and end of a table's first row

For example, from `chalk dump --help`:

![3](https://github.com/crashappsec/chalk/assets/45465154/ff7dcdf1-2717-42dd-9f68-333c45edd54a)

And from `chalk insert --help`:

![2](https://github.com/crashappsec/chalk/assets/45465154/ed4f8cad-3c17-4648-a842-4f7eb1203f46)

## Impact

Chalk table output may sometimes be harder to read.

~But it looks like this may be the same underlying issue that has blocked us from updating the docs on the marketing-site: https://github.com/crashappsec/marketing-site/pull/192~

Edit: that PR was created before this exact problem was introduced.

## Steps to Reproduce

Using the latest release (chalk v0.3.1), run a `help` command and scroll down. At some window size and font combinations, the table is formatted incorrectly.

I cannot reproduce this issue with the previous release, chalk v0.3.0. The commit that introduced the issue is https://github.com/crashappsec/chalk/commit/c238960a287f457e589f09e2f3b9df7db8584832.

## Other information

Maybe related: #143

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by reproducing the table rendering problem with the chalk help commands at different window sizes and font combinations. Compare the current release with v0.3.0, inspect commit c238960a, and review related issue #143; done means the header and first row render correctly across the reported combinations.

Written by the indexing model from the issue text.

Assessment

Tech stack
nim
Domain
cli
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.