allow overriding output dir for tui and scan #91
Conversation
There was a problem hiding this comment.
Summary of Changes
Hello @dhth, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request enhances the application's flexibility by providing users with explicit control over where scanned and TUI-persisted Kafka messages are saved. It introduces a dedicated command-line flag for specifying the output directory, making data management more customizable while maintaining a sensible default.
Highlights
- New Output Directory Flag: Introduced a new
--output-dirflag for both thetuiandscancommands, allowing users to specify a custom directory for persisting Kafka messages. - Default Output Path: The default output directory for persisted messages remains
$HOME/.kplay, but this path is now explicitly defined and can be easily overridden via the new flag. - Internal Code Refactoring: Refactored internal components within
internal/scanandinternal/tuito consistently use the newoutputDirparameter instead ofhomeDirfor all message persistence operations, ensuring a unified approach.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
There was a problem hiding this comment.
Code Review
This pull request introduces a new scan command and makes the output directory configurable for both the tui and scan commands. The changes are well-implemented, replacing the hardcoded use of the home directory with a new outputDir variable that can be set via the --output-dir / -O flag. The refactoring is consistent across the codebase, and error handling for file system operations is robust. The changelog has been updated accordingly. Overall, this is a solid contribution that improves the tool's flexibility.
|
/gemini review |
There was a problem hiding this comment.
Code Review
This pull request introduces a new --output-dir flag for the tui and scan commands, allowing users to override the default directory ($HOME/.kplay) for persisting messages. The changes are well-implemented across the codebase, replacing the previously hardcoded home directory logic with the new configurable output directory. My review includes a suggestion to improve consistency in the debug output formatting across different commands.
| config.AuthenticationDisplay(), | ||
| config.EncodingDisplay(), | ||
| config.Brokers, | ||
| strings.Join(config.Brokers, "\n "), |
There was a problem hiding this comment.
This change improves readability for multiple brokers. However, it introduces a couple of inconsistencies:
- The value passed is now a
string, but the format specifier forbrokerson line 266 is still%v. It should be changed to%sfor correctness. - This improved formatting is only applied to the
scancommand. For a consistent user experience, please consider applying the same formatting to the debug output of thetui(line 126) andserve(line 178) commands.
No description provided.