Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix issue148: Confirmation with [Y/n] should default to "yes" #147

Merged
merged 1 commit into from
May 8, 2024

Conversation

nao1215
Copy link
Owner

@nao1215 nao1215 commented May 8, 2024

Summary by CodeRabbit

  • Bug Fixes
    • Improved the handling of newline inputs in user interactions, ensuring more reliable responses when errors occur.

Copy link
Contributor

coderabbitai bot commented May 8, 2024

Walkthrough

The modification enhances the Question function within the internal/print package to better manage user inputs. Specifically, it now returns true when a specific error, related to an expected newline input, is encountered. This update improves the function's robustness in handling responses.

Changes

File Change Summary
.../print/print.go Updated Question function to return true on encountering specific newline input errors.

🐇✨
In the realm of code where logic plays,
A rabbit tweaked the function's ways.
"True" it returns, when newlines stray,
Making user prompts smarter today.
Hop, skip, a bug fix display! 🌟


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

github-actions bot commented May 8, 2024

HOTTEST report

PASS FAIL SKIP TOTAL DURATION
147 0 0 147 10.937084075s

Reported by hottest

Copy link
Contributor

github-actions bot commented May 8, 2024

Code Metrics Report

main (d398568) #147 (7f385c7) +/-
Coverage 77.7% 77.7% 0.0%
Test Execution Time 19s 17s -2s
Details
  |                     | main (d398568) | #147 (7f385c7) | +/-  |
  |---------------------|----------------|----------------|------|
  | Coverage            |          77.7% |          77.7% | 0.0% |
  |   Files             |             20 |             20 |    0 |
  |   Lines             |            772 |            772 |    0 |
  |   Covered           |            600 |            600 |    0 |
+ | Test Execution Time |            19s |            17s |  -2s |

Code coverage of files in pull request scope (100.0% → 100.0%)

Files Coverage +/-
internal/print/print.go 100.0% 0.0%

Reported by octocov

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

Out of diff range and nitpick comments (1)
internal/print/print.go (1)

Line range hint 78-78: Caution against potential infinite loops.

The default case in the switch statement recursively calls Question if the user's input does not match 'y', 'yes', 'n', or 'no'. This could potentially lead to an infinite loop if the user continues to enter unrecognized inputs. Consider adding a maximum recursion depth or an alternative method to handle repeated invalid inputs.

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between d398568 and 36a7cfb.
Files selected for processing (1)
  • internal/print/print.go (1 hunks)

Comment on lines +64 to +68
// If user input only enter, [Y/n] syntax is commonly used to denote that
// "yes" is the default.
// https://github.com/nao1215/gup/issues/146
if strings.Contains(err.Error(), "expected newline") {
return Question(ask)
return true
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Handle default response more robustly.

The current implementation relies on a specific error message to determine if the user has pressed enter without typing anything. This approach might not be robust as it depends on the error message string, which can change depending on the environment or updates to the Go language. Consider checking for an empty response string directly after trimming whitespace, which would be a more reliable method.

- if strings.Contains(err.Error(), "expected newline") {
+ if strings.TrimSpace(response) == "" {
+     return true
+ }

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
// If user input only enter, [Y/n] syntax is commonly used to denote that
// "yes" is the default.
// https://github.com/nao1215/gup/issues/146
if strings.Contains(err.Error(), "expected newline") {
return Question(ask)
return true
// If user input only enter, [Y/n] syntax is commonly used to denote that
// "yes" is the default.
// https://github.com/nao1215/gup/issues/146
if strings.TrimSpace(response) == "" {
return true

@nao1215 nao1215 merged commit 7dbeb57 into main May 8, 2024
11 checks passed
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.

1 participant