v1 Requirements

[grega]

Should:

• New website
• Add demo (tape) generation to release script
• Test more “non-web” project READMEs
• Benchmark rendering interactive picker (not just README parsing)
• Tighten copy (particularly the root README)
• Bug: if hdi output is larger than height of terminal, the viewport shows the bottom of the output rather than the top (where the cursor is located)
  • The terminal does not scroll with the position of the cursor (so tab / arrows can take the cursor offscreen)
  • Manually test a larger array of terminal window sizes (add to test suite also?)
• Contributors section of README
• Add comment in README about AI tool usage, eg.
  • Researching common README formats across a large array of project types
  • Creating fixtures from these findings
  • Converting use of sed, awk etc into Bash natives (ie. the v0.10.0 performance release)
• If hdi returns No README found in ., prompt to run hdi --help
• Fix formatting of help output (--json)
• Mark hdi c / hdi check as being experimental
• Theming
  • Provide NO_COLOR support
  • How does hdi render by default in terminals with various themes? dark? light?
  • Does it need to be theme-able, or can / should it pick up on current theme defaults?
    • Both already handled, using ANSI codes
• Homebrew package should only include the built hdi script and LICENSE file
  • Done: https://github.com/grega/hdi/releases/tag/v0.19.0
• Consistent error message format, with hints

Could:

• Bash and Zsh completions
• man hdi support: Add manpage + build step #5
• Per-repo .hdirc file for configuration (initially, README sections / titles to ignore)

[grega]

Some polish to the interface would be good too. The web simulator is more refined (particularly the selected item / arrow), eg:

vs.

A lot of this is going to be down to the chosen font (and to some extent, theme) in the user's terminal though...