Skip to content

fix(window.create_native_float_win): ensure grabbing footer text keymap from config#75

Merged
y3owk1n merged 1 commit intomainfrom
footer_text
Apr 29, 2025
Merged

fix(window.create_native_float_win): ensure grabbing footer text keymap from config#75
y3owk1n merged 1 commit intomainfrom
footer_text

Conversation

@mtraworld
Copy link
Contributor

@mtraworld mtraworld commented Apr 29, 2025

Summary by CodeRabbit

  • Enhancements
    • The footer in the floating window now displays the actual configured keybinding for closing, instead of always showing "Press q to exit". If no custom keybinding is set, it will still default to "q".

@coderabbitai
Copy link

coderabbitai bot commented Apr 29, 2025

Walkthrough

The change updates the footer text in a floating window generated by the M.create_native_float_win function. Instead of displaying a static message instructing users to press "q" to exit, the footer now dynamically reflects the actual keybinding configured for closing the window, as specified in time-machine.config.keymaps.close. If no custom keybinding is set, it defaults to "q". No changes were made to the function's signature or any exported entities.

Changes

File(s) Change Summary
lua/time-machine/window.lua Updated footer text in floating window to dynamically use configured close keybinding or default "q".

Poem

In windows that float, a footer once said,
"Press q to exit," but now it’s ahead!
It checks your config for keys you adore,
So leaving the window is never a chore.
Rabbits approve—custom keys are neat,
Hopping along, our work is complete! 🐇


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 7fd8482 and 574c8bb.

📒 Files selected for processing (1)
  • lua/time-machine/window.lua (2 hunks)
🔇 Additional comments (2)
lua/time-machine/window.lua (2)

24-28: Good improvement to make the footer text reflect user's configured keymap.

This change enhances the UX by dynamically displaying the user's configured close keymap in the footer instead of hardcoding "q". The fallback to "q" when no custom keymap is configured is also well implemented.


37-37: LGTM - Correctly applies the dynamic footer text.

The footer text is properly applied to the window configuration.

✨ Finishing Touches
  • 📝 Generate Docstrings

🪧 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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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 using 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 generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration 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.

@y3owk1n y3owk1n merged commit 6bdaa91 into main Apr 29, 2025
4 checks passed
@y3owk1n y3owk1n deleted the footer_text branch April 29, 2025 03:36
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