Skip to content

feat(type): allow optional for parameters of AbstractGraph.addCells #847

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
tbouffard merged 1 commit into from
Jun 12, 2025
Merged

feat(type): allow optional for parameters of AbstractGraph.addCells #847

tbouffard merged 1 commit into from
Jun 12, 2025

Conversation

@tbouffard
Copy link
Member

@tbouffard tbouffard commented Jun 12, 2025 •
edited by coderabbitai bot
Loading

The implementation provides default, so the types in the method signature have been adjusted accordingly.
This matches the mxGraph behavior.

Summary by CodeRabbit

  • Documentation
    • Improved documentation for the addCells method, clarifying parameter defaults and event naming.
  • Refactor
    • Updated method parameters to be optional, reflecting their default values more clearly in the interface.

@tbouffard
feat(type): allow optional for parameters of AbstractGraph.addCells
7bf5720 
The implementation provides default, so the types in the method signature have been adjusted accordingly.
This matches the mxGraph behavior.
@tbouffard tbouffard added the enhancement New feature or request label Jun 12, 2025
@coderabbitai
Copy link

coderabbitai bot commented Jun 12, 2025 •
edited
Loading

Walkthrough

The addCells method in the CellsMixin.type.ts file was updated to clarify parameter documentation and make several parameters optional in the method signature. The event reference in the documentation comment was also updated for accuracy. No core logic or return types were changed.

Changes

File Change Summary
packages/core/src/view/mixins/CellsMixin.type.ts Updated addCells method signature to make parameters optional and improved documentation comments.

Sequence Diagram(s)

sequenceDiagram
  participant Caller
  participant CellsMixin

  Caller->>CellsMixin: addCells(cells, parent?, index?, source?, target?, absolute?)
  CellsMixin-->>Caller: Cell[]
Loading

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

npm error Exit handler never called!
npm error This is an error with npm itself. Please report this error at:
npm error https://github.com/npm/cli/issues
npm error A complete log of this run can be found in: /.npm/_logs/2025-06-12T14_26_09_164Z-debug-0.log

✨ 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.

@sonarqubecloud
Copy link

sonarqubecloud bot commented Jun 12, 2025

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

coderabbitai[bot]
coderabbitai bot reviewed Jun 12, 2025
View reviewed changes
Copy link

@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 (2)
packages/core/src/view/mixins/CellsMixin.type.ts (2)

309-313: Keep event-name references consistent across docs

Great catch switching to InternalEvent.ADD_CELLS.
Right below (lines 331-333) the doc for cellsAdded still references {@link Event#CELLS_ADDED}. Consider updating that to InternalEvent.CELLS_ADDED for consistency with the new naming scheme.

315-318: Docs mention null defaults, but the signature now also allows undefined

By marking the parameters optional (?), TypeScript widens their type to Cell | null | undefined / number | null | undefined.
If you want callers to prefer null over undefined, add a short note such as “If omitted or explicitly set to null, …”.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 08ad1c0 and 7bf5720.

📒 Files selected for processing (1)
  • packages/core/src/view/mixins/CellsMixin.type.ts (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (4)
  • GitHub Check: build (ubuntu-22.04)
  • GitHub Check: build (macos-14)
  • GitHub Check: build
  • GitHub Check: build (windows-2022)
🔇 Additional comments (1)
packages/core/src/view/mixins/CellsMixin.type.ts (1)

323-327: Verify whether addCell should follow the same optional-parent pattern

addCells now correctly mirrors the implementation with an optional parent.
addCell (lines 300-306) still requires parent: Cell | null. If the runtime code also treats the parameter as optional, aligning the typings would avoid confusion:

-      parent: Cell | null,
+      parent?: Cell | null,

Please double-check the implementation before applying.

@tbouffard tbouffard merged commit 2f79cd8 into main Jun 12, 2025
7 checks passed
@tbouffard tbouffard deleted the feat/improve_signature_AbstractGraph.addCells branch June 12, 2025 14:40
@coderabbitai coderabbitai bot mentioned this pull request Jul 29, 2025
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

Assignees

No one assigned

Labels

enhancement New feature or request

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@tbouffard