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(spinner): use global config for show_notification #175

Merged
merged 1 commit into from
Jun 25, 2024

Conversation

agriffis
Copy link
Contributor

@agriffis agriffis commented Jun 25, 2024

WHAT

spinner didn't honor show_notification

WHY

to avoid "Done!" message

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • Linter
  • Tests
  • Review comments
  • Security

Summary by CodeRabbit

  • Bug Fixes
    • Improved notification handling by centralizing the show_notification configuration.

Copy link

codesandbox bot commented Jun 25, 2024

Review or Edit in CodeSandbox

Open the branch in Web EditorVS CodeInsiders

Open Preview

Copy link

changeset-bot bot commented Jun 25, 2024

⚠️ No Changeset found

Latest commit: 2cb2e79

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link

coderabbitai bot commented Jun 25, 2024

Walkthrough

The recent changes streamline the configuration handling of the spinner logic by removing the show_notification field from the local config table and instead relying on the global configuration _HURL_GLOBAL_CONFIG.show_notification. This simplifies condition checks within the M.hide function, ensuring that the notification setting is consistently sourced from the global configuration.

Changes

File Change Summary
lua/hurl/spinner.lua Removed the show_notification field from the config table and updated the M.hide function to use _HURL_GLOBAL_CONFIG.show_notification instead.

Poem

In the code where spinners spin,
Configurations now run thin.
Global settings take the stage,
Gone is the redundant page.
Simplified, refined, oh what a win!
Our spinner hides with a global grin.


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.
    • @coderabbitai help me debug CodeRabbit configuration file.

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 an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @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

@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: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between d5cce0b and 2cb2e79.

Files selected for processing (1)
  • lua/hurl/spinner.lua (2 hunks)
Additional comments not posted (1)
lua/hurl/spinner.lua (1)

84-84: Ensure global configuration is defined and accessible.

The change to use _HURL_GLOBAL_CONFIG.show_notification for controlling notification visibility is noted. However, it's crucial to ensure that _HURL_GLOBAL_CONFIG is defined and accessible before this line of code is executed. This helps in avoiding runtime errors due to undefined variables.

Verification successful

Ensure global configuration is defined and accessible.

The _HURL_GLOBAL_CONFIG variable is indeed defined and initialized in lua/hurl/init.lua, and it is accessible in lua/hurl/spinner.lua. This ensures that the code snippet using _HURL_GLOBAL_CONFIG.show_notification will not encounter runtime errors due to an undefined variable.

  • _HURL_GLOBAL_CONFIG is defined and initialized in lua/hurl/init.lua.
  • _HURL_GLOBAL_CONFIG is used in lua/hurl/spinner.lua.
Scripts executed

The following scripts were executed for the analysis:


Script:

#!/bin/bash
# Description: Verify the definition and accessibility of `_HURL_GLOBAL_CONFIG`.

# Test: Search for the definition and initialization of `_HURL_GLOBAL_CONFIG`.
rg --type lua $'_HURL_GLOBAL_CONFIG ='

Length of output: 208



Script:

#!/bin/bash
# Description: Verify the accessibility of `_HURL_GLOBAL_CONFIG` in `lua/hurl/spinner.lua`.

# Test: Search for `_HURL_GLOBAL_CONFIG` usage in `lua/hurl/spinner.lua`.
rg --type lua '_HURL_GLOBAL_CONFIG' lua/hurl/spinner.lua

Length of output: 118

@jellydn
Copy link
Owner

jellydn commented Jun 25, 2024

Thanks @agriffis LGTM!

@jellydn jellydn merged commit e54b5a4 into jellydn:main Jun 25, 2024
6 checks passed
@jellydn
Copy link
Owner

jellydn commented Jun 25, 2024

@all-contributors add @agriffis for code.

Copy link
Contributor

@jellydn

I've put up a pull request to add @agriffis! 🎉

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