Skip to content

chore: clarify --filter flag description for CSV/JSON and benchmarks#146

Merged
fahimfaisaal merged 2 commits into
mainfrom
chore/update-filter-docs
Jun 24, 2026
Merged

chore: clarify --filter flag description for CSV/JSON and benchmarks#146
fahimfaisaal merged 2 commits into
mainfrom
chore/update-filter-docs

Conversation

@fahimfaisaal

@fahimfaisaal fahimfaisaal commented Jun 24, 2026

Copy link
Copy Markdown
Member

Summary

This PR clarifies the --filter flag documentation and ships related UI polish for 3D charts, plus a fix for embedded UI sync verification.

--filter flag description

Updates the --filter / -f flag description across CLI help, docs, and the GitHub Action so it matches actual behavior:

  • CSV/JSON: filters rows by the joined --group label
  • Benchmark parsers: filters by benchmark/task name

Replaces the previous wording ("data labels / series names"), which implied column/series filtering for tabular data.

New description:

Regex to include only matching rows (CSV/JSON: --group label) or benchmark names

Files:

  • cmd/cli/options.go
  • docs/src/content/docs/commands/root.mdx
  • docs/src/content/docs/commands/charts.mdx
  • docs/src/content/docs/ci-cd/github-action.mdx
  • docs/src/content/docs/features.mdx
  • action.yml

3D chart UI

Fixes grid3D.axisPointer styling so hover crosshairs are visible in both themes (ECharts GL defaults to near-black lines/labels).

  • Pointer lines: use theme axisColor at full opacity (width: 2)
  • Pointer labels: use theme textColor instead of ECharts GL’s default white label text
  • Grid split lines: softened globally (opacity dark 0.15, light 0.4) with an extra ×0.75 fade in 3D grids so the box reads less bright while the pointer stays readable

Files:

  • ui/src/composables/charts/shared/3d.ts
  • ui/src/composables/charts/shared/chartConfig.ts
  • ui/src/composables/charts/shared/3d.test.ts
  • pkg/template/vizb-ui.gen.go (regenerated embedded UI assets)

vizb-ui.gen.go sync test fix

verify-gen-sync.test.ts previously hardcoded a Vite chunk hash (e.g. axisAlignTicks-lwmJPqWv). That broke whenever the UI was rebuilt and chunk names changed.

  • Extracted gen.go parsing/compare logic into ui/embed-build/gen-go-parse.ts
  • Slimmed verify-gen-sync.ts to a CLI wrapper around the shared module
  • Tests now sample any chunk from VizbChunks at runtime and locate lines by key (handles padded alignment in generated Go)

This keeps sync verification stable across UI rebuilds without manually updating chunk hashes in tests.

@codecov-commenter

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@fahimfaisaal
fahimfaisaal merged commit 291e471 into main Jun 24, 2026
12 checks passed
@fahimfaisaal
fahimfaisaal deleted the chore/update-filter-docs branch June 24, 2026 12:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants