feat: [#849] Add table support to the console context#1380
feat: [#849] Add table support to the console context#1380krishankumar01 merged 9 commits intomasterfrom
Conversation
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #1380 +/- ##
==========================================
- Coverage 68.80% 68.79% -0.02%
==========================================
Files 286 287 +1
Lines 18040 18118 +78
==========================================
+ Hits 12413 12464 +51
- Misses 5101 5116 +15
- Partials 526 538 +12 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
@coderabbitai review |
✅ Actions performedReview triggered.
|
📝 WalkthroughWalkthroughThis pull request adds a comprehensive table rendering feature to the console context, introducing a new Changes
Sequence Diagram(s)sequenceDiagram
participant Client
participant CliContext
participant TableRenderer as lipgloss/table
participant Output
Client->>CliContext: Table(headers, rows, options...)
CliContext->>CliContext: Merge user options with defaults
CliContext->>TableRenderer: Create table with headers and rows
CliContext->>TableRenderer: Apply border configuration
CliContext->>TableRenderer: Apply styling (BorderStyle, StyleFunc)
CliContext->>TableRenderer: Set dimensions (Width, Height)
TableRenderer->>TableRenderer: Render formatted table
CliContext->>Output: Write rendered table via Line()
Output->>Client: Display formatted table
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches
🧪 Generate unit tests (beta)
Tip Issue Planner is now in beta. Read the docs and try it out! Share your feedback on Discord. Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (2)
contracts/console/command.go (1)
7-8: Public contract leaks lipgloss types, coupling consumers to a specific rendering library.
TableOptionexposeslipgloss.Border,lipgloss.Style,table.StyleFunc, andmap[int]lipgloss.Styledirectly. Sincecontracts/console/command.gois the public interface that downstream consumers (and mocks) depend on, this forces every consumer to importlipglossandlipgloss/table, even if they never render a table.If the rendering library is ever swapped, this becomes a breaking change to the contract. Consider wrapping these types behind framework-owned abstractions or moving the lipgloss-specific types to the implementation layer. That said, this is a design trade-off — the direct exposure does provide maximum flexibility for users wanting to style tables.
Also applies to: 256-286
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@contracts/console/command.go` around lines 7 - 8, The public contract currently leaks lipgloss types via TableOption (exposing lipgloss.Border, lipgloss.Style, table.StyleFunc and map[int]lipgloss.Style) — remove direct references to lipgloss/table from contracts/console/command.go by introducing framework-level abstraction types (e.g., ConsoleBorder, ConsoleStyle, ConsoleTableStyleFunc or simple interfaces) and use those in the TableOption API and any other exposed signatures (including the region noted at lines ~256-286); move the actual lipgloss/table imports and conversions into the implementation package that builds renderers so consumers and mocks depend only on the new lightweight abstractions rather than lipgloss types.console/cli_context.go (1)
23-54: Shared*boolpointers betweenDefaultTableOptionand local copies.
opt := DefaultTableOption(Line 597) performs a shallow struct copy, so the*boolfields (e.g.,BorderTop) in bothoptandDefaultTableOptionpoint to the same underlyingbool. Currently safe because the code only reassigns pointers (never mutates*opt.BorderTop), but a future refactor could accidentally corrupt the global default.Consider either documenting this invariant or doing a deep copy of the pointer fields when cloning.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@console/cli_context.go` around lines 23 - 54, DefaultTableOption currently holds several *bool pointer fields (BorderTop, BorderBottom, BorderLeft, BorderRight, BorderHeader, BorderColumn, BorderRow) created with convert.Pointer(...) which means shallow copies like opt := DefaultTableOption will share underlying bools; add a proper deep-clone so callers don't accidentally share mutable pointers: implement a CloneTableOption (or a Clone method on console.TableOption) that copies the struct and allocates new bools for each pointer field (copying their values) and update callers that do opt := DefaultTableOption to call the clone helper (e.g., opt := DefaultTableOption.Clone()) so each copy has independent *bool instances.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@console/cli_context.go`:
- Around line 594-675: The Table method in CliContext ignores
TableOption.ColumnStyles so per-column styles are never applied; update the
option-merging block in CliContext.Table to copy userOpt.ColumnStyles into
opt.ColumnStyles, and then replace or wrap the final StyleFunc (opt.StyleFunc /
DefaultTableStyleFunc) with a wrapper that consults opt.ColumnStyles for the
current column and falls back to the base StyleFunc (i.e., create a new
StyleFunc that takes (col, row, cell) -> if opt.ColumnStyles[col] != nil use
that style(cell) else call base StyleFunc), and set t.StyleFunc to this wrapped
function before calling r.Line(t.Render()). Ensure you reference
TableOption.ColumnStyles, CliContext.Table, opt.StyleFunc,
DefaultTableStyleFunc, and t.StyleFunc when making the change.
---
Nitpick comments:
In `@console/cli_context.go`:
- Around line 23-54: DefaultTableOption currently holds several *bool pointer
fields (BorderTop, BorderBottom, BorderLeft, BorderRight, BorderHeader,
BorderColumn, BorderRow) created with convert.Pointer(...) which means shallow
copies like opt := DefaultTableOption will share underlying bools; add a proper
deep-clone so callers don't accidentally share mutable pointers: implement a
CloneTableOption (or a Clone method on console.TableOption) that copies the
struct and allocates new bools for each pointer field (copying their values) and
update callers that do opt := DefaultTableOption to call the clone helper (e.g.,
opt := DefaultTableOption.Clone()) so each copy has independent *bool instances.
In `@contracts/console/command.go`:
- Around line 7-8: The public contract currently leaks lipgloss types via
TableOption (exposing lipgloss.Border, lipgloss.Style, table.StyleFunc and
map[int]lipgloss.Style) — remove direct references to lipgloss/table from
contracts/console/command.go by introducing framework-level abstraction types
(e.g., ConsoleBorder, ConsoleStyle, ConsoleTableStyleFunc or simple interfaces)
and use those in the TableOption API and any other exposed signatures (including
the region noted at lines ~256-286); move the actual lipgloss/table imports and
conversions into the implementation package that builds renderers so consumers
and mocks depend only on the new lightweight abstractions rather than lipgloss
types.
console/cli_context.go
Outdated
| var ( | ||
| BrandColor = lipgloss.CompleteColor{TrueColor: "#3D8C8D", ANSI256: "30", ANSI: "6"} | ||
| MutedColor = lipgloss.CompleteColor{TrueColor: "#4a4a4a", ANSI256: "240", ANSI: "8"} | ||
|
|
||
| DefaultTableHeaderColor = BrandColor | ||
| DefaultTableBorderColor = MutedColor | ||
|
|
||
| DefaultTableHeaderStyle = lipgloss.NewStyle().Foreground(DefaultTableHeaderColor).Bold(true).Padding(0, 1) | ||
| DefaultTableCellStyle = lipgloss.NewStyle().Padding(0, 1) | ||
|
|
||
| DefaultTableStyleFunc = func(row, col int) lipgloss.Style { | ||
| if row == table.HeaderRow { | ||
| return DefaultTableHeaderStyle | ||
| } | ||
| return DefaultTableCellStyle | ||
| } | ||
|
|
||
| DefaultTableOption = console.TableOption{ | ||
| Border: lipgloss.RoundedBorder(), | ||
|
|
||
| BorderStyle: lipgloss.NewStyle().Foreground(DefaultTableBorderColor), | ||
|
|
||
| StyleFunc: DefaultTableStyleFunc, | ||
|
|
||
| BorderTop: convert.Pointer(true), | ||
| BorderBottom: convert.Pointer(true), | ||
| BorderLeft: convert.Pointer(true), | ||
| BorderRight: convert.Pointer(true), | ||
| BorderHeader: convert.Pointer(true), | ||
| BorderColumn: convert.Pointer(true), | ||
| BorderRow: convert.Pointer(false), | ||
| } | ||
| ) |
There was a problem hiding this comment.
Is it better to move these code to an independent file?
| } | ||
|
|
||
| err := input.Value(&answer).Run() | ||
| err := input.Value(&answer).WithTheme(GlobalHuhTheme).Run() |
There was a problem hiding this comment.
Could you add a screenshot for the theme?
* chore: Update upgrade DB packages (#1374) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * Internalize file rotation logic from goravel/file-rotatelogs (#1375) * Initial plan * Implement internal file rotation to replace goravel/file-rotatelogs Co-authored-by: hwbrzzl <24771476+hwbrzzl@users.noreply.github.com> * Improve cleanup logic with glob pattern matching and add comprehensive tests Co-authored-by: hwbrzzl <24771476+hwbrzzl@users.noreply.github.com> * Address code review feedback: fix trailing whitespace, add cleanup wait, and make tests deterministic Co-authored-by: hwbrzzl <24771476+hwbrzzl@users.noreply.github.com> * optimize --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: hwbrzzl <24771476+hwbrzzl@users.noreply.github.com> Co-authored-by: Bowen <hwbrzzl@gmail.com> * chore: Update non-major dependencies (#1373) * chore: Update non-major dependencies * optimize * optimize * renovate/non-major-dependencies * optimize --------- Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: Bowen <hwbrzzl@gmail.com> * feat: [#726] Add HTTP server and client telemetry instrumentation [5] (#1326) * add http middleware * add http transport * optimise http telemetry package * add test cases for Telemetry middleware * add auto instrumentation configs * add config to enable Telemetry for http clients * add docs for config facade * add ConfigFacade nil warning * disable default telemetry * optimise transport * add kill switch for instrumentation * update the stubs * remove unnecessary handler * optimise log instrumentation * move route registration in the end * lazily initialize middleware and transport to work with new application_builder * optimise channel test * optimise channel test * accept telemetry facade as an input instead of using global instance * use a callback to resolve the telemetry facade instance * optimise grpc handler to remove usage of telemetry and config facade * optimise the grpc handler * use telemetry transport if enabled * optimise http auto instrumentation * optimize log test cases * optimise * optimise * optimise * optimise * revert PR#1357 * fix log test cases * revert GRPC changes * optimise middleware * remove zipkin trace driver * correct GRPC enable condition * correct http transport enable condition * correct log channel enable condition * update go mod * fix test cases * fix test cases * fix test cases * fix tests --------- Co-authored-by: Bowen <hwbrzzl@gmail.com> * chore: optimize runner tests for Windows (#1377) Co-authored-by: Bowen <hwbrzzl@github.com> * chore: Update non-major dependencies (#1378) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * fix: runner stuck (#1381) * fix: runner stuck * optimize * optimize * optimize * optimize * optimize * chore: Update non-major dependencies (#1382) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * feat: [#849] Add table support to the console context (#1380) * add table function in cli * add test cases for new method Table * update mocks * add column level styles * fix lint error * move style vars to new file * add GlobalHuhTheme * update go mod tidy * feat: [#546] artisan command up and down to set website Maintenance mode (#1198) * Add up and down command * Use file helper to create files and add unit tests * Fix the foundation.App dependency * Use support/path instead of foundation.App * Add unit test case * Add some missing checks * Add more missing checks * One more * Fix tmpfile path * Use T.TempDir instead of os.TempDir in tests * Add reason to the down command * Add option to the tests * Change the maintenance file name * close created file handles * Defer abort * Fix the linter issue * Add more options to the down command * Use options * Check for maintenance mode respond * Fix down_command_test * Add more unit test cases * Fix more lint issues * Fix lint issue * fix tests * fix tests * fix tests * fix tests * Address PR comments * Fix check_for_maintenance_test * Check Aborts in check_for_maintenance * Rename check_for_maintenance_mode * Fix and Write more unit tests for check_for_maintenance_mode middleware * fix down command * Fix down_command_test * Fix up_command --------- Co-authored-by: Bowen <hwbrzzl@gmail.com> * feat: Laravel-style Collection library (#1134) Merges comprehensive Collection library with 100+ methods for data manipulation. Implements both eager (Collection) and lazy (LazyCollection) evaluation strategies. Closes goravel/goravel#566 Follow-up improvements tracked in: goravel/goravel#883 * Increase route module coverage for factory, provider, and runner wiring paths (#1384) * Initial plan * test(route): cover route factory and service provider paths Co-authored-by: hwbrzzl <24771476+hwbrzzl@users.noreply.github.com> * optimize * optimize --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: hwbrzzl <24771476+hwbrzzl@users.noreply.github.com> Co-authored-by: Bowen <hwbrzzl@gmail.com> * chore: optimize interface (#1389) * Increase crypt module coverage by exercising AES key validation and failure paths (#1385) * Initial plan * test: add crypt AES edge-case coverage Co-authored-by: hwbrzzl <24771476+hwbrzzl@users.noreply.github.com> * test: improve readability of crypt key-length cases Co-authored-by: hwbrzzl <24771476+hwbrzzl@users.noreply.github.com> * test: address crypt PR feedback and simplify test structure Co-authored-by: hwbrzzl <24771476+hwbrzzl@users.noreply.github.com> * test: use configmock EXPECT style in TestNewAES Co-authored-by: hwbrzzl <24771476+hwbrzzl@users.noreply.github.com> * test: standardize config mock setup across aes tests Co-authored-by: hwbrzzl <24771476+hwbrzzl@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: hwbrzzl <24771476+hwbrzzl@users.noreply.github.com> * Increase filesystem module test coverage for storage, service provider, and file facade paths (#1387) * Initial plan * Add filesystem application and provider coverage tests Co-authored-by: hwbrzzl <24771476+hwbrzzl@users.noreply.github.com> * Polish filesystem coverage tests after review feedback Co-authored-by: hwbrzzl <24771476+hwbrzzl@users.noreply.github.com> * Refine filesystem tests based on review feedback Co-authored-by: hwbrzzl <24771476+hwbrzzl@users.noreply.github.com> * Apply review style suggestions in filesystem tests Co-authored-by: hwbrzzl <24771476+hwbrzzl@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: hwbrzzl <24771476+hwbrzzl@users.noreply.github.com> * Increase mail module test coverage to 70%+ with focused unit tests (#1386) * Initial plan * test(mail): add focused unit coverage for application, options, and service provider Co-authored-by: hwbrzzl <24771476+hwbrzzl@users.noreply.github.com> * test(mail): address review feedback on test specificity and readability Co-authored-by: hwbrzzl <24771476+hwbrzzl@users.noreply.github.com> * test(mail): merge application unit tests and remove untyped mock matchers Co-authored-by: hwbrzzl <24771476+hwbrzzl@users.noreply.github.com> * test(mail): deduplicate matchers and tighten queue job assertion Co-authored-by: hwbrzzl <24771476+hwbrzzl@users.noreply.github.com> * test(mail): use AnythingOfType and any in application tests Co-authored-by: hwbrzzl <24771476+hwbrzzl@users.noreply.github.com> * test(mail): derive bind callback type string from any signature Co-authored-by: hwbrzzl <24771476+hwbrzzl@users.noreply.github.com> * test(mail): simplify bind callback type matcher Co-authored-by: hwbrzzl <24771476+hwbrzzl@users.noreply.github.com> * test(mail): use AnythingOfType for template render expectations Co-authored-by: hwbrzzl <24771476+hwbrzzl@users.noreply.github.com> * test(mail): restore specific MatchedBy assertions per review clarification Co-authored-by: hwbrzzl <24771476+hwbrzzl@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: hwbrzzl <24771476+hwbrzzl@users.noreply.github.com> * Increase hash module coverage with targeted tests for driver selection and service provider paths (#1388) * Initial plan * test: increase hash module coverage for driver and provider paths Co-authored-by: hwbrzzl <24771476+hwbrzzl@users.noreply.github.com> * test: cover hash provider and driver selection paths Co-authored-by: hwbrzzl <24771476+hwbrzzl@users.noreply.github.com> * test: address hash module review feedback Co-authored-by: hwbrzzl <24771476+hwbrzzl@users.noreply.github.com> * test: merge hash module tests into application_test Co-authored-by: hwbrzzl <24771476+hwbrzzl@users.noreply.github.com> * test: use EXPECT API in hash service provider test Co-authored-by: hwbrzzl <24771476+hwbrzzl@users.noreply.github.com> * test: use any alias in hash singleton callback test Co-authored-by: hwbrzzl <24771476+hwbrzzl@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: hwbrzzl <24771476+hwbrzzl@users.noreply.github.com> * chore: add AI instructions file (#1393) * Increase core framework coverage via targeted service provider and builder-path tests (#1391) * Initial plan * Add service provider coverage tests for core modules Co-authored-by: hwbrzzl <24771476+hwbrzzl@users.noreply.github.com> * Expand core module coverage tests and validate suite Co-authored-by: hwbrzzl <24771476+hwbrzzl@users.noreply.github.com> * Revert unintended test module dependency drift Co-authored-by: hwbrzzl <24771476+hwbrzzl@users.noreply.github.com> * Address actionable PR review suggestions in coverage tests Co-authored-by: hwbrzzl <24771476+hwbrzzl@users.noreply.github.com> * Finalize review feedback handling Co-authored-by: hwbrzzl <24771476+hwbrzzl@users.noreply.github.com> * Revert unintended tests module dependency updates Co-authored-by: hwbrzzl <24771476+hwbrzzl@users.noreply.github.com> * Tighten provider test matchers per review feedback Co-authored-by: hwbrzzl <24771476+hwbrzzl@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: hwbrzzl <24771476+hwbrzzl@users.noreply.github.com> * Increase infrastructure module coverage by adding Process/Packages/Log/Schedule tests and fixing errors.As target forwarding (#1392) * Initial plan * test(errors): cover As/Unwrap/Ignore/Join edge cases Co-authored-by: hwbrzzl <24771476+hwbrzzl@users.noreply.github.com> * test(errors): use wrapped error in As coverage test Co-authored-by: hwbrzzl <24771476+hwbrzzl@users.noreply.github.com> * chore: revert unintended tests module file changes Co-authored-by: hwbrzzl <24771476+hwbrzzl@users.noreply.github.com> * test: add coverage for process packages log schedule modules Co-authored-by: hwbrzzl <24771476+hwbrzzl@users.noreply.github.com> * test: refine schedule coverage tests per review Co-authored-by: hwbrzzl <24771476+hwbrzzl@users.noreply.github.com> * chore: revert unintended tests module dependency updates Co-authored-by: hwbrzzl <24771476+hwbrzzl@users.noreply.github.com> * test: assert boot no-panic in log and process providers Co-authored-by: hwbrzzl <24771476+hwbrzzl@users.noreply.github.com> * chore: finalize review feedback responses for boot test assertions Co-authored-by: hwbrzzl <24771476+hwbrzzl@users.noreply.github.com> * chore: revert unintended tests module file changes Co-authored-by: hwbrzzl <24771476+hwbrzzl@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: hwbrzzl <24771476+hwbrzzl@users.noreply.github.com> * test: expand service-layer coverage across Event, Queue, gRPC, Cache, and Console (#1390) * Initial plan * test(event): cover service provider and queued listener dispatch paths Co-authored-by: hwbrzzl <24771476+hwbrzzl@users.noreply.github.com> * chore: finalize event coverage validation Co-authored-by: hwbrzzl <24771476+hwbrzzl@users.noreply.github.com> * chore: revert unintended tests module dependency updates Co-authored-by: hwbrzzl <24771476+hwbrzzl@users.noreply.github.com> * test(event): address review suggestions for robust command matching and queue error path Co-authored-by: hwbrzzl <24771476+hwbrzzl@users.noreply.github.com> * chore: finalize PR feedback follow-up Co-authored-by: hwbrzzl <24771476+hwbrzzl@users.noreply.github.com> * chore: revert unintended tests module file updates Co-authored-by: hwbrzzl <24771476+hwbrzzl@users.noreply.github.com> * test: add focused coverage cases for queue grpc cache console Co-authored-by: hwbrzzl <24771476+hwbrzzl@users.noreply.github.com> * test: clarify queue nil args in empty chain test Co-authored-by: hwbrzzl <24771476+hwbrzzl@users.noreply.github.com> * chore: revert unintended tests module dependency updates Co-authored-by: hwbrzzl <24771476+hwbrzzl@users.noreply.github.com> * test: avoid nil context in console usage-error test Co-authored-by: hwbrzzl <24771476+hwbrzzl@users.noreply.github.com> * chore: finalize lint ci fix validation Co-authored-by: hwbrzzl <24771476+hwbrzzl@users.noreply.github.com> * chore: revert unintended tests module dependency drift Co-authored-by: hwbrzzl <24771476+hwbrzzl@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: hwbrzzl <24771476+hwbrzzl@users.noreply.github.com> * chore: Update non-major dependencies (#1399) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * chore: add generate flag to artisan build command (#1402) * feat: [#911] add query context accessor (#1401) * chore: optimize agents (#1396) * chore: optimize agents * optimize * address comments * Initial plan * fix: backport migrate rollback default handling to v1.17.x Co-authored-by: hwbrzzl <24771476+hwbrzzl@users.noreply.github.com> * chore: align branch tree with v1.17.x before backporting rollback fix Co-authored-by: hwbrzzl <24771476+hwbrzzl@users.noreply.github.com> * optimize * optimize --------- Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: Bowen <hwbrzzl@gmail.com> Co-authored-by: Copilot <198982749+Copilot@users.noreply.github.com> Co-authored-by: hwbrzzl <24771476+hwbrzzl@users.noreply.github.com> Co-authored-by: krishan kumar <84431594+krishankumar01@users.noreply.github.com> Co-authored-by: Bowen <hwbrzzl@github.com> Co-authored-by: Mohan Raj <praem1990@gmail.com> Co-authored-by: Ahmed M. Ammar <ahmed3mar@outlook.com> Co-authored-by: 耗子 <haozi@loli.email> Co-authored-by: ALMAS <almas.cc@icloud.com>




📑 Description
Closes goravel/goravel#849
This PR adds a Table method to render data in a tabular format. The function accepts headers and rows, along with an optional third parameter,
console.TableOption, to configure the table style.Example
TableOptionScreenShot
✅ Checks
Summary by CodeRabbit
Release Notes
New Features
Tests