Skip to content

Terminal API new Event Types #1507

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

Merged
merged 2 commits into from
Jun 5, 2025
Merged

Terminal API new Event Types #1507

merged 2 commits into from
Jun 5, 2025

Conversation

gcatanese
Copy link
Contributor

Add new Event Types:

  • NetworkConnected
  • NetworkDisconnected

@gcatanese gcatanese requested a review from a team as a code owner June 4, 2025 14:30
Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Hello @gcatanese, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

Summary of Changes

Hello, this is gemini-code-assist providing a summary of this pull request. This PR, authored by gcatanese, introduces two new event types, NetworkConnected and NetworkDisconnected, to the Terminal API. The changes primarily involve updating the TypeScript type definitions to include these new events, ensuring that the API contract reflects the ability to notify about network connection status changes.

Highlights

  • New Event Types Added: This pull request adds two new event types, NetworkConnected and NetworkDisconnected, to the set of events that can be notified by the Terminal API.
  • TypeScript Typings Updated: The corresponding TypeScript type definitions for EventToNotifyType have been updated in both the NEXO typings and the specific terminal event typings to include the new network connection events.

Changelog

  • src/typings/nexo.ts
    • Added 'NetworkConnected' and 'NetworkDisconnected' to the EventToNotifyType union type.
  • src/typings/terminal/eventToNotifyType.ts
    • Added NetworkConnected and NetworkDisconnected members to the EventToNotifyType enum.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in issue comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.


Network status change,
Connected, then apart,
Events flow freely.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request introduces two new event types, NetworkConnected and NetworkDisconnected, to the Terminal API. The changes are clear and directly address the PR's objective. The addition to the EventToNotifyType enum in src/typings/terminal/eventToNotifyType.ts is well-placed alphabetically, which is great for maintainability.

I have one suggestion regarding the EventToNotifyType union type in src/typings/nexo.ts to improve long-term maintainability by ensuring all members are alphabetically sorted.

Summary of Findings

  • Maintainability: Alphabetical Sorting of Union Type Members: In src/typings/nexo.ts, the EventToNotifyType union type members are not alphabetically sorted. Adding new members to the end without sorting can make the type harder to read and maintain as it grows. It's recommended to sort all members alphabetically.

Merge Readiness

The pull request is a good step towards adding the new event types. However, there is one medium-severity suggestion regarding the alphabetical sorting of members in the EventToNotifyType union type in src/typings/nexo.ts for improved maintainability. I recommend addressing this suggestion before merging. As an AI code reviewer, I am not authorized to approve pull requests; please ensure further review and approval by authorized team members.

@gcatanese gcatanese enabled auto-merge June 5, 2025 12:28
gcatanese and others added 2 commits June 5, 2025 15:59
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
@gcatanese gcatanese force-pushed the terminal-new-event-types branch from 93c6703 to 4314f41 Compare June 5, 2025 13:59
@gcatanese gcatanese merged commit 00eec6f into main Jun 5, 2025
5 checks passed
@gcatanese gcatanese deleted the terminal-new-event-types branch June 5, 2025 14:03
Copy link

sonarqubecloud bot commented Jun 5, 2025

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