manifoldco / manifoldco/torus-cli
Style guide - Tables and list
- Dominant language
- Go
- Stars
- 603
- Forks
- 30
- PR merge metrics
- No merged PRs in 30d
Description
On route to overhauling the UX and standardizing output we need to decide what shape our tables and lists take in various situations (empty, one column, multiple column, multi-line table, etc)
#### Talking points
- What do our tables look like?
- Do we use headers? What do they look like?
- Are lists just tables with one column?
- Do one column tables have headers?
- How do we handle lists with asterisks (technically two column)
- How do we handle list data which is multi-line (such as worklog)
- Git log inspired format?
- What is our default approach to sorting?
- Do we offer filtering?
- Graceful degradation (no rich formatting, removing headers etc) for scripts
- Rely on system tools as much as possible (awk, grep)
- How do we denote different table row states?
- Critical vs non-critical?
- Automate-able vs manual
Contributor guide
Research direction
No files or tests are named. Start by reviewing the current CLI table and list output, then use the listed talking points to document agreed rules for headers, columns, multiline data, sorting, filtering, script output, and row states. Done means the output style decisions are resolved and recorded.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- go
- Domain
- cli, design
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100