Conversation
|
Coverage after merging feat/tui-visual-overhaul-and-community-files into main will be
Coverage Report
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
shouze
force-pushed
the
feat/tui-visual-overhaul-and-community-files
branch
from
2170943 to
bee93ac
Compare
|
Coverage after merging feat/tui-visual-overhaul-and-community-files into main will be
Coverage Report
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Contributor
There was a problem hiding this comment.
Pull request overview
This PR refreshes the interactive TUI styling to better match the project’s branding, and adds several community/discoverability assets (policy docs, demo assets, social preview), along with README updates and a version bump for v1.4.0.
Changes:
- Updated TUI visuals (icons/colours) and introduced
termWidthforwarding to support right-aligned match counts. - Updated rendering tests for new fold/unfold arrow glyphs.
- Added community files (SECURITY / Code of Conduct), demo assets/instructions, social preview SVG, README improvements, and bumped package version + keywords.
Reviewed changes
Copilot reviewed 9 out of 11 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
| src/tui.ts | Forwards terminal width (process.stdout.columns) into render options. |
| src/render.ts | TUI visual overhaul (new glyphs/colours) and new right-aligned match count rendering using termWidth. |
| src/render.test.ts | Updates expectations for new fold/unfold arrow glyphs. |
| package.json | Bumps version to 1.4.0 and adds npm keywords. |
| docs/public/social-preview.svg | Adds GitHub social preview image asset. |
| demo/demo.tape | Adds VHS tape script to record the demo animation. |
| demo/README.md | Adds instructions to regenerate the demo GIF. |
| SECURITY.md | Adds vulnerability disclosure policy. |
| README.md | Embeds demo GIF and adds features/use-cases/comparison sections. |
| CODE_OF_CONDUCT.md | Adds Contributor Covenant Code of Conduct. |
- Replace blue cursor highlight with violet (magenta) for brand consistency - Replace ◉/○ checkboxes with ✓ (green) / space for a cleaner look - Right-align match counts to terminal edge (termWidth-aware) - Replace ▶/▼ fold arrows with ▸/▾ in brand violet - Add brand badge header (bgMagenta) in TUI title bar - Colour section separators with magenta - Pass process.stdout.columns to renderGroups via tui.ts - Add SECURITY.md (RSSI-approved vulnerability disclosure policy) - Add CODE_OF_CONDUCT.md (Contributor Covenant 2.1) - Add docs/public/social-preview.svg (1280×640 GitHub social image) - Add demo/demo.tape (VHS tape for animated demo GIF) - Add demo/demo.gif (recorded demo animation) - Add demo/README.md (regeneration instructions) - Add 18 keywords to package.json for npm/pkg discoverability - Expand README.md: Features, Use cases, Why not gh search code? sections Bump: 1.3.0 → 1.4.0 (minor)
shouze
force-pushed
the
feat/tui-visual-overhaul-and-community-files
branch
from
bee93ac to
b876222
Compare
|
Coverage after merging feat/tui-visual-overhaul-and-community-files into main will be
Coverage Report
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
- Remove parentheses from sticky repo header match count (visual consistency with repo rows) - Fix termWidth padding off-by-one: termWidth - leftLen - countLen (was subtracting an extra 1, leaving line one column short) - Add renderGroups unit test asserting right-aligned row fits termWidth - Fix README: 'organisation' → 'organization' (consistent American spelling) - Fix SECURITY.md: 'Reporting security vulnerability Issues' → 'Reporting security vulnerabilities' - Fix SECURITY.md: 'In any ways' → 'In any case' - Update docs/usage/interactive-mode.md: reflect new TUI glyphs (▸/▾ arrows, ✓/space checkboxes, right-aligned counts, brand badge)
|
Coverage after merging feat/tui-visual-overhaul-and-community-files into main will be
Coverage Report
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PR review fixes (3 new comments): - src/render.ts: fix padding overflow — use Math.max(0, ...) and omit space when pad=0 rather than forcing a minimum 1-space gap that could push lines past termWidth - README.md: align comparison table with docs/index.md (center alignment for ✓/✗ columns, :---:) - README.md: typo 'secrets patterns' → 'secret patterns' CONTRIBUTING.md: - Remove stale 'No linter is configured yet' sentence - Document actual tools: oxlint (bun run lint) and oxfmt (bun run format / bun run format:check) package.json: - Add repository, homepage, bugs fields for npmjs.com discoverability CHANGELOG.md: - Create minimal root CHANGELOG.md pointing to the VitePress blog for visitors expecting a standard changelog at the repo root
|
Coverage after merging feat/tui-visual-overhaul-and-community-files into main will be
Coverage Report
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Coverage after merging feat/tui-visual-overhaul-and-community-files into main will be
Coverage Report
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
shouze
force-pushed
the
feat/tui-visual-overhaul-and-community-files
branch
from
2bd7777 to
1dcccb1
Compare
|
Coverage after merging feat/tui-visual-overhaul-and-community-files into main will be
Coverage Report
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||
| lines.push(pc.bold(`GitHub Code Search: ${pc.cyan(query)} in ${pc.yellow(org)}`)); | ||
| lines.push( | ||
| `${pc.bgMagenta(pc.bold(" github-code-search "))} ${pc.bold(pc.cyan(query))} ${pc.dim("in")} ${pc.bold(pc.yellow(org))}`, |
There was a problem hiding this comment.
The header badge applies bgMagenta but doesn’t set a foreground colour, so on light-theme terminals (default black fg) the badge text can become hard to read. Consider forcing a contrasting foreground (e.g., white) for the badge text to ensure consistent readability across terminal themes.
Suggested change
| `${pc.bgMagenta(pc.bold(" github-code-search "))} ${pc.bold(pc.cyan(query))} ${pc.dim("in")} ${pc.bold(pc.yellow(org))}`, | |
| `${pc.bgMagenta(pc.white(pc.bold(" github-code-search ")))} ${pc.bold(pc.cyan(query))} ${pc.dim("in")} ${pc.bold(pc.yellow(org))}`, |
Comment on lines
+182
to
+185
| const leftPart = `${arrow} ${checkbox} ${repoName}`; | ||
| const leftLen = stripAnsi(leftPart).length; | ||
| const countLen = stripAnsi(count).length; | ||
| const pad = Math.max(0, termWidth - leftLen - countLen); |
There was a problem hiding this comment.
The right-alignment math uses stripAnsi(...).length, which counts UTF-16 code units rather than terminal column width. Repo/org/query strings containing emoji, CJK, or other full-width characters will misalign (and may overflow). Consider using a display-width calculation (e.g., a small width helper or a dependency like string-width) for padding calculations.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Visual refresh of the TUI to align with the brand illustration on the documentation site, plus all the community and discoverability files that were missing from the repository.
TUI visual changes (
src/render.ts,src/tui.ts)bgBlue) cursor highlightbgMagenta) — matches brand colour◉/○checkboxes✓(green) when selected, space when not — cleaner line▶/▼fold arrows (greydim)▸/▾in violet (magenta)GitHub Code Search:termWidth-aware)process.stdout.columnsis now forwarded fromtui.tstorenderGroupsvia thetermWidthoption.Tests updated for the new
▸/▾arrows.New files
SECURITY.mdCODE_OF_CONDUCT.mddocs/public/social-preview.svgdemo/demo.tapedemo/demo.gifdemo/README.mdREADME improvements
demo/demo.gifanimationgh search code? section with comparison tablepackage.jsonHow to verify
Then build and run the TUI to see the visual changes: