refactor(type)!: make DIRECTION_MASK read-only #803

tbouffard · 2025-05-03T19:48:29Z

Notes

Covers #378

Summary by CodeRabbit

Documentation
- Updated the changelog to note that the direction mask constant is now read-only at the type level.
Refactor
- Made the direction mask constant read-only, ensuring its values cannot be modified.

coderabbitai · 2025-05-03T19:48:35Z

Warning

Rate limit exceeded

@tbouffard has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 4 minutes and 47 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between ff45d6e and ba2201f.

📒 Files selected for processing (1)

packages/core/src/view/style/edge/Orthogonal.ts (1 hunks)

Walkthrough

The changes update the DIRECTION_MASK constant in the codebase to be a readonly constant object at the type level by applying a TypeScript as const assertion. Additionally, the changelog is updated to document this as a breaking change under the "Unreleased" section. No other code logic or public API changes are introduced.

Changes

File(s)	Change Summary
packages/core/src/util/Constants.ts	Added TypeScript `as const` assertion to `DIRECTION_MASK`, making it a readonly constant object.
CHANGELOG.md	Updated to document the breaking change for `constants.DIRECTION_MASK` being readonly.

Sequence Diagram(s)

No sequence diagram is generated as the changes are limited to type-level immutability and documentation updates.

✨ 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.

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.

coderabbitai

Actionable comments posted: 0

🧹 Nitpick comments (2)

packages/core/src/util/Constants.ts (1)
416-425: Proper Immutability at Type Level Achieved
The addition of as const correctly enforces literal types and readonly properties for DIRECTION_MASK at compile time.

Consider also applying Object.freeze at runtime if you need to enforce immutability during execution:
-export const DIRECTION_MASK = {
+export const DIRECTION_MASK = Object.freeze({
   /** No direction. */
   NONE: 0,
   WEST: 1,
   NORTH: 2,
   SOUTH: 4,
   EAST: 8,
   /** All directions. */
   ALL: 15,
-} as const;
+} as const);
CHANGELOG.md (1)
26-26: Link Changelog Entry to Issue for Traceability
The new breaking change for constants.DIRECTION_MASK is correctly documented. For better traceability, consider linking it to the related issue:
- - `constants.DIRECTION_MASK` is now read-only (types only).
+ - `constants.DIRECTION_MASK` is now read-only (types only). See [#378](https://github.com/maxGraph/maxGraph/issues/378).

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 7b2efb4 and ff45d6e.

📒 Files selected for processing (2)

CHANGELOG.md (1 hunks)
packages/core/src/util/Constants.ts (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (1)

GitHub Check: build (windows-2022)

sonarqubecloud · 2025-05-03T20:05:14Z

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

refactor(type)!: make DIRECTION_MASK read-only

ff45d6e

tbouffard added the refactor Code refactoring label May 3, 2025

tbouffard mentioned this pull request May 3, 2025

Review the list of declared enums and check if alternatives can be used instead #378

Closed

coderabbitai bot reviewed May 3, 2025

View reviewed changes

fix tsc error in Orthogonal.ts

ba2201f

tbouffard merged commit 6d99b3a into main May 3, 2025
7 checks passed

tbouffard deleted the refactor/378-DIRECTION_MASK_read-only branch May 3, 2025 20:10

tbouffard mentioned this pull request May 4, 2025

feat!: make various cursors configurable #806

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

refactor(type)!: make DIRECTION_MASK read-only #803

refactor(type)!: make DIRECTION_MASK read-only #803

Uh oh!

tbouffard commented May 3, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented May 3, 2025 •

edited

Loading

Rate limit exceeded

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Uh oh!

sonarqubecloud bot commented May 3, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

refactor(type)!: make DIRECTION_MASK read-only #803

refactor(type)!: make DIRECTION_MASK read-only #803

Uh oh!

Conversation

tbouffard commented May 3, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Notes

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented May 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Rate limit exceeded

Walkthrough

Changes

Sequence Diagram(s)

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

sonarqubecloud bot commented May 3, 2025

Quality Gate passed

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

tbouffard commented May 3, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented May 3, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)