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

install special new handlers for Cmd+N and Cmd+T when no windows are open #1839

Merged
merged 1 commit into from
Jan 24, 2025

Conversation

sawka
Copy link
Member

@sawka sawka commented Jan 24, 2025

No description provided.

Copy link
Contributor

coderabbitai bot commented Jan 24, 2025

Walkthrough

The pull request introduces a new event management system for tracking window state changes across the application. A new GlobalEventEmitter class is created in emain/emain-events.ts to provide a type-safe event emitter specifically for window-related events. The emain/emain-window.ts file is modified to emit a "windows-updated" event when windows are closed or added.

The emain/emain.ts file adds an event listener to track changes in the number of wave windows, which triggers menu updates. Correspondingly, the emain/menu.ts file is updated to handle dynamic menu generation based on the number of open windows, including special handling for scenarios with zero windows open.

These changes enhance the application's ability to dynamically respond to window state changes and provide more flexible menu management.

✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

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>, 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. (Beta)
  • @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.

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

🧹 Nitpick comments (6)
emain/emain-events.ts (1)

6-8: Define events with more extensibility in mind.
Currently, GlobalEvents only tracks "windows-updated". If future events are expected, consider grouping them semantically or adding parameters to convey relevant data (e.g. number of windows).

emain/menu.ts (3)

71-75: Document or rename the new parameter.
numWaveWindows is meaningful to you now but might be non-obvious to future maintainers. Adding JSDoc or renaming it to waveWindowCount (for clarity) may help.


323-325: Check for consistent naming between APIs.
Ensure that “instantiateAppMenu(numWindows)” and “getAppMenu(numWaveWindows)” consistently describe the same concept, so the APIs remain intuitive.


336-337: Ensure consistency with global event usage.
wwCount = getAllWaveWindows().length; is fine, but if further window-state logic evolves, consider centralizing this in the “windows-updated” callback rather than recalculating here.

emain/emain.ts (1)

576-586: Robust "windows-updated" event handling.
This logic effectively synchronizes the menu with real-time window counts. As a future improvement, consider debouncing if many windows open/close rapidly, to prevent repetitive menu builds.

emain/emain-window.ts (1)

297-297: Emitting "windows-updated" twice.
At lines 297 (on close) and 314 (on creation) you emit after a 50ms delay. Consider centralizing logic in a helper to avoid duplicating code, and optionally pass parameters to differentiate “window created” vs. “window destroyed.”

Also applies to: 314-314

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 7bad4b3 and 70bde91.

📒 Files selected for processing (4)
  • emain/emain-events.ts (1 hunks)
  • emain/emain-window.ts (3 hunks)
  • emain/emain.ts (2 hunks)
  • emain/menu.ts (6 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: Analyze (javascript-typescript)
  • GitHub Check: Analyze (go)
  • GitHub Check: Build for TestDriver.ai
🔇 Additional comments (6)
emain/emain-events.ts (2)

10-26: Good use of a strongly-typed event emitter.
Leveraging generics for type-safe method overrides helps avoid runtime errors. The current approach ensures compile-time protection of event names and parameter types.


28-30: Single instance pattern is clear.
Exporting a single globalEvents instance follows a simple, centralized approach for app-wide event management.

emain/menu.ts (2)

91-106: Invisible menu items meet the PR objective.
This approach effectively binds “Cmd+N” or “Cmd+T” accelerators when no windows exist. The logic is straightforward and well-encapsulated.


377-381: Fallback to default app menu is handled well.
Conditionally instantiating the app menu when menuDefArr is absent is a good approach. Just confirm that the hidden accelerators also apply in this context if numWaveWindows is 0.

emain/emain.ts (1)

6-6: Import usage is straightforward.
You are cleanly introducing the globalEvents import, aligning with the new event-based architecture.

emain/emain-window.ts (1)

8-8: Import is consistent with the new globalEvents design.
No issues identified.

@sawka sawka merged commit 038ba8e into main Jan 24, 2025
8 checks passed
@sawka sawka deleted the sawka/no-window-accels branch January 24, 2025 22:24
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