Skip to content

chore: add more checks in ts-support #728

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Mar 25, 2025
Merged

chore: add more checks in ts-support #728

merged 1 commit into from
Mar 25, 2025

Conversation

tbouffard
Copy link
Member

@tbouffard tbouffard commented Mar 25, 2025 •
edited by coderabbitai bot
Loading

Use RubberBandHandler and some methods of Graph provided by some Graph mixins.

In addition:

  • improve the JSDoc of RubberBandHandler
  • simplify types usage in ts-example and ts-example-without-defaults

Summary by CodeRabbit

  • New Features

    • Enhanced the interactive graph experience with refined selection behavior that delivers smoother visual feedback and improved configuration for connection management and editing.

  • Refactor

    • Streamlined element handling to ensure consistent performance and a more intuitive user interface experience.

@tbouffard
refactor: add more checks in ts-support
a541562 
Use `RubberBandHandler` and some methods of Graph provided by some Graph mixins.

In addition:
  - improve the JSDoc of `RubberBandHandler`
  - simplify types usage in ts-example and ts-example-without-defaults
@tbouffard tbouffard added the chore Build, CI/CD or repository tasks (issues/PR maintenance, environments, ...) label Mar 25, 2025
@coderabbitai coderabbitai
Copy link

coderabbitai bot commented Mar 25, 2025 •
edited
Loading

Walkthrough

This pull request refines documentation and type usage across multiple packages. The documentation in the RubberBandHandler class has been enhanced for clarity by updating comments and default value definitions. Additionally, explicit TypeScript type assertions have been removed from query selector calls in two example files in favor of non-null assertion operators. In the TS support package, the import statement is updated to include additional entities, and new configuration code has been added for the rubberBandHandler plugin on the graph.

Changes

File(s) Change Summary
packages/core/.../RubberBandHandler.ts Updated documentation comments for properties (defaultOpacity, enabled, fadeOut) and methods (e.g., setEnabled, mouseDown, mouseMove, etc.), including using @default and {@link update} syntax.
packages/ts-example(/without-defaults)/src/main.ts Removed explicit type casting on document.querySelector calls, replacing <HTMLElement> with the non-null assertion operator (!) to indicate non-null elements.
packages/ts-support/src/index.ts Expanded the import statement to include CellState and RubberBandHandler; replaced explicit type assertion for the container with the non-null operator; added rubberBandHandler instantiation and configuration along with additional graph method calls.

Sequence Diagram(s)

sequenceDiagram
    participant Main
    participant Document
    participant Graph
    participant RubberBandHandler

    Main->>Document: querySelector('#graph-container')!
    Main->>Graph: Instantiate Graph using container
    Graph->>Graph: getPlugin(RubberBandHandler)
    Graph->>RubberBandHandler: Configure (defaultOpacity = 50, fadeOut = true)
    Main->>Graph: Call getAllConnectionConstraints(new CellState, flag)
    Main->>Graph: Set cellsEditable = false
    Main->>Graph: Call getFoldingImage(new CellState)
Loading

Suggested labels

documentation, refactor

📜 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 997db4a and a541562.

📒 Files selected for processing (4)
  • packages/core/src/view/handler/RubberBandHandler.ts (10 hunks)
  • packages/ts-example-without-defaults/src/main.ts (1 hunks)
  • packages/ts-example/src/main.ts (1 hunks)
  • packages/ts-support/src/index.ts (1 hunks)
🧰 Additional context used
🧬 Code Definitions (2)
packages/ts-example/src/main.ts (2)
packages/js-example-without-defaults/src/index.js (2)
  • footer (106-106)
  • initializeGraph (27-103)
packages/js-example/src/index.js (2)
  • footer (76-76)
  • initializeGraph (59-73)
packages/ts-example-without-defaults/src/main.ts (2)
packages/js-example-without-defaults/src/index.js (2)
  • footer (106-106)
  • initializeGraph (27-103)
packages/js-example/src/index.js (2)
  • footer (76-76)
  • initializeGraph (59-73)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: build (windows-2022)
🔇 Additional comments (20)
packages/ts-example/src/main.ts (2)

117-117: Improved TypeScript syntax by using non-null assertion.

The change from explicit type casting <HTMLElement>document.querySelector('footer') to using the non-null assertion operator ! is a cleaner approach in modern TypeScript. It maintains the same type safety while being more concise.

121-121: Improved TypeScript syntax by using non-null assertion.

Similarly, the change to use the non-null assertion operator on the graph container selector follows the same pattern as the footer element. This approach is more idiomatic in modern TypeScript.

packages/ts-example-without-defaults/src/main.ts (2)

106-106: Improved TypeScript syntax by using non-null assertion.

The change from explicit type casting to using the non-null assertion operator ! is a cleaner approach in modern TypeScript. This matches the changes made in the other example file, maintaining consistency across the codebase.

110-110: Improved TypeScript syntax by using non-null assertion.

Using the non-null assertion operator for the graph container element follows the same pattern as in the other files. This consistent approach simplifies the codebase by standardizing on a single pattern for DOM element selection.

packages/ts-support/src/index.ts (3)

17-23: Added necessary imports for enhanced RubberBandHandler functionality.

The imports for CellState and RubberBandHandler have been added to support the new functionality implemented below. This is in line with the PR objective of adding more checks in the TS support package.

28-28: Improved TypeScript syntax by using non-null assertion.

The change from explicit type casting to using the non-null assertion operator ! on the container element is consistent with the changes made in the other TypeScript files. This ensures a uniform approach throughout the codebase.

35-42: Added RubberBandHandler configuration and Graph mixin method calls.

This addition serves two purposes:

  1. Configures the RubberBandHandler plugin with specific settings
  2. Calls methods defined in Graph mixins to ensure that TypeScript interface augmentation is correctly defined

These changes directly address the PR objective of adding more checks for TypeScript support and demonstrating the use of RubberBandHandler along with Graph mixin methods.

packages/core/src/view/handler/RubberBandHandler.ts (13)

116-119: Enhanced documentation for defaultOpacity property.

The documentation has been improved by clearly specifying the valid value range (0-100) and explicitly marking the default value using the @default tag. This makes the API more user-friendly and self-documenting.

123-125: Added default value documentation for enabled property.

The @default true annotation has been added to explicitly document the default value of the enabled property, improving the clarity of the API documentation.

139-140: Improved method reference using JSDoc link syntax.

Changed from using <update> to the more standard {@link update} syntax, improving the consistency of the documentation and enabling better IDE integration and documentation generation.

144-145: Improved method reference using JSDoc link syntax.

Similar to the previous change, updated the reference to use {@link update} for better documentation consistency.

149-151: Added default value documentation for fadeOut property.

Added the @default false annotation to explicitly document the default value of the fadeOut property, enhancing the API documentation clarity.

162-163: Improved method documentation clarity.

The documentation for setEnabled has been clarified to better describe what the method does, making it more straightforward for users to understand its purpose.

177-179: Enhanced mouseDown method documentation.

The description has been improved to better explain the purpose and behavior of the method, particularly how it handles event consumption and initiates rubberband selection.

241-242: Improved mouseMove method documentation.

Simplified the description to clearly state the method's purpose of updating the rubberband selection.

298-299: Enhanced mouseUp method documentation with proper link.

Updated the documentation to use the proper JSDoc link syntax {@link Graph#selectRegion} to reference the related method, improving cross-referencing in the documentation.

311-313: Improved execute method documentation.

Enhanced the description to better explain what the method does, specifically its role in resetting the handler state and selecting the current region.

353-354: Updated property references and improved documentation link.

Changed references to <currentX> and <currentY> to use the proper JSDoc link syntax {@link repaint}, improving documentation consistency.

363-365: Improved repaint method documentation.

The documentation has been updated to more precisely describe what the method does, specifically mentioning that it updates the style of the div.

386-388: Enhanced onDestroy method documentation.

The documentation has been improved to better explain the purpose of the method and to note that it doesn't typically need to be called manually as it's handled automatically on window unload.

✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai plan to trigger planning for file edits and PR creation.
  • @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.

@sonarqubecloud SonarQubeCloud
Copy link

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

@tbouffard tbouffard merged commit fcf0c7f into main Mar 25, 2025
7 checks passed
@tbouffard tbouffard deleted the refactor/ts-support_check_more_features branch March 25, 2025 16:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

chore Build, CI/CD or repository tasks (issues/PR maintenance, environments, ...)

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@tbouffard