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

EAGLE-1331: Fix bug where QuickActions with no keyboard shortcut would still display "[]" #761

Merged
merged 1 commit into from
Nov 7, 2024

Conversation

james-strauss-uwa
Copy link
Collaborator

@james-strauss-uwa james-strauss-uwa commented Nov 7, 2024

Removed 'empty' keys from QuickAction helper functions.
Updated KeyboardShortcut.getText() to return empty string if no shortcut.

Summary by Sourcery

Improve the KeyboardShortcut class by removing unnecessary 'empty' keys from QuickAction helper functions and updating getText() to return an empty string when no shortcuts are defined.

Bug Fixes:

  • Fix KeyboardShortcut.getText() to return an empty string instead of '[]' when no key texts are produced.

Enhancements:

  • Remove 'empty' keys from QuickAction helper functions to streamline the creation of keyboard shortcuts.

…ardShortcut.getText() to return empty string if no shortcut
Copy link
Contributor

sourcery-ai bot commented Nov 7, 2024

Reviewer's Guide by Sourcery

This PR modifies the KeyboardShortcut class to improve how empty shortcuts are handled. The changes include updating the getText() method to return an empty string instead of "[]" when there are no shortcuts, and modifying QuickAction helper functions to use an empty array instead of an array with an empty key.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Modified getText() method to handle empty shortcuts more gracefully
  • Added a check for empty texts array
  • Returns empty string instead of "[]" when no shortcuts exist
src/KeyboardShortcut.ts
Updated QuickAction helper functions to use empty key arrays
  • Replaced [new Key("")] with [] in QUICK_ACTION function
  • Replaced [new Key("")] with [] in QUICK_ACTION_DOCS function
src/KeyboardShortcut.ts

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time. You can also use
    this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@james-strauss-uwa james-strauss-uwa self-assigned this Nov 7, 2024
Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @james-strauss-uwa - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@james-strauss-uwa james-strauss-uwa changed the title Removed 'empty' keys from QuickAction helper functions. Updated Keybo… EAGLE-1331: Fix bug where QuickActions with no keyboard shortcut would still display "[]" Nov 7, 2024
Copy link
Collaborator

@M-Wicenec M-Wicenec left a comment

Choose a reason for hiding this comment

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

nice catch

@james-strauss-uwa james-strauss-uwa merged commit 7b81a7a into master Nov 7, 2024
1 check passed
@james-strauss-uwa james-strauss-uwa deleted the eagle-1331 branch November 7, 2024 08:40
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