FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

refactor!: move `VERSION` to `constants` by tbouffard · Pull Request #680 · maxGraph/maxGraph · GitHub

/ maxGraph Public
forked from jgraph/mxgraph

refactor!: move VERSION to constants - #680

Merged
tbouffard merged 4 commits into
mainfrom
refactor/move_VERSION_to_constants
Feb 17, 2025
ConversationCommits (4)ChecksFiles changed
Merged

refactor!: move VERSION to constants#680
tbouffard merged 4 commits into
mainfrom
refactor/move_VERSION_to_constants

Conversation

tbouffard commented Feb 17, 2025 •
edited
Loading

Copy link
Copy Markdown
Member

BREAKING CHANGES: Client.VERSION moved to constants.VERSION. VERSION is supposed to be immutable as it represents the actual version of maxGraph.
When it was stored in Client, it was a static property that could be modified.
Moving it to the constants module ensures that it cannot be modified.

Summary by CodeRabbit

  • Refactor
    • Centralized version management now ensures a consistent and immutable display of maxGraph’s version across the application and example projects.
    • Legacy utility methods and browser support checks have been removed in favor of modern language features, streamlining the codebase and dependencies.

refactor!: move VERSION to constants
a125341 
BREAKING CHANGES: `Client.VERSION` moved to `constants.VERSION`.
`VERSION` is supposed to be immutable as it represents the actual version of maxGraph.
When it was stored in Client, it was a static property that could be modified. Moving it to "constants" ensure that it cannot be modified.
tbouffard added the refactor Code refactoring label Feb 17, 2025

coderabbitai Bot commented Feb 17, 2025 •
edited
Loading

Copy link
Copy Markdown

Warning

Rate limit exceeded

@tbouffard has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 8 minutes and 49 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 6765f88 and 82ebcef.

📒 Files selected for processing (2)
  • CHANGELOG.md (1 hunks)
  • packages/core/src/util/Constants.ts (1 hunks)

Walkthrough

This pull request refactors version management and internal utility functions in the codebase. The static version property has been removed from the Client class and replaced with an immutable version constant in the Constants module. References to version information have been updated across UI and example files to use the new constant, and obsolete utility functions have been either removed or made private. Additionally, the update script has been adjusted to work with the new file and declaration format.

Changes

Files Change Summary
CHANGELOG.md Documented breaking changes: internal utilities (utils.isNullish, utils.isNotNullish) made private; removal of internal functions (utils.getValue, stringUtils.getColor, etc.) and Client.isBrowserSupported; migration of version from Client to constants for immutability.
packages/core/src/{Client.ts, gui/MaxLog.ts, util/Constants.ts} Removed static VERSION from Client.ts; added new immutable VERSION constant in Constants.ts; updated MaxLog.ts to import and use constants.VERSION instead of Client.VERSION.
packages/{js-example-without-defaults,js-example,ts-example-without-defaults,ts-example,ts-support}/src/* Replaced references to Client.VERSION with constants.VERSION; removed unnecessary Client import to streamline dependency management in UI footer and version assignments.
scripts/update-versions.mjs Updated the target file path from Client.ts to util/Constants.ts and modified the regex pattern from matching a static to a constant declaration for version updates.

Possibly related PRs

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.

tbouffard marked this pull request as ready for review February 17, 2025 06:38
coderabbitai Bot reviewed Feb 17, 2025
View reviewed changes

coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Actionable comments posted: 1

🧹 Nitpick comments (2)
packages/core/src/util/Constants.ts (1)

22-23: Use single quotes for consistency with other comments.

The comment uses backticks for the script path which is inconsistent with the comment style in the rest of the file.

-// WARN: this constant is updated at release time by the script located at `scripts/update-versions.mjs`.
+// WARN: this constant is updated at release time by the script located at 'scripts/update-versions.mjs'.
CHANGELOG.md (1)

25-26: Ensure Clarity and Correct Grammar for the Version Relocation Entry

The changelog now notes that Client.VERSION has been moved to constants.VERSION to enforce immutability. For better readability and grammatical correctness, consider rephrasing the second sentence. For instance, you might update it to:

Moving it to the constants module ensures that it cannot be modified.

This change enhances clarity while aligning with the breaking change introduced by this PR.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 42c1c0b and 6765f88.

📒 Files selected for processing (10)
  • CHANGELOG.md (1 hunks)
  • packages/core/src/Client.ts (0 hunks)
  • packages/core/src/gui/MaxLog.ts (2 hunks)
  • packages/core/src/util/Constants.ts (1 hunks)
  • packages/js-example-without-defaults/src/index.js (1 hunks)
  • packages/js-example/src/index.js (2 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)
  • scripts/update-versions.mjs (1 hunks)
💤 Files with no reviewable changes (1)
  • packages/core/src/Client.ts
🧰 Additional context used 🪛 ESLint scripts/update-versions.mjs

[error] 50-50: Unexpected console statement.

(no-console)

🔇 Additional comments (7)
packages/ts-support/src/index.ts (1)

17-17: LGTM! Changes align with the version refactoring.

The import statement and version reference have been correctly updated to use constants.VERSION instead of Client.VERSION.

Also applies to: 19-19

packages/js-example-without-defaults/src/index.js (1)

107-107: LGTM! Version display updated correctly.

The version display has been properly updated to use constants.VERSION.

packages/js-example/src/index.js (1)

20-20: LGTM! Version display updated correctly.

The import statement and version display have been properly updated to use constants.VERSION.

Also applies to: 77-77

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

107-107: LGTM!

The version reference has been correctly updated to use constants.VERSION.

packages/ts-example/src/main.ts (1)

118-118: LGTM!

The version reference has been correctly updated to use constants.VERSION.

packages/core/src/gui/MaxLog.ts (1)

27-27: LGTM!

The version reference has been correctly updated:

  • Import statement added for VERSION from Constants module
  • Usage updated to reference the imported VERSION constant

Also applies to: 44-44

packages/core/src/util/Constants.ts (1)

19-21: LGTM!

The VERSION constant has been correctly added with proper documentation.

Also applies to: 24-24

Comment thread scripts/update-versions.mjs

sonarqubecloud Bot commented Feb 17, 2025

Copy link
Copy Markdown

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 merged commit 5678abf into main Feb 17, 2025
tbouffard deleted the refactor/move_VERSION_to_constants branch February 17, 2025 06:50
This was referenced Feb 17, 2025
Merged
Merged
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

coderabbitai[bot] coderabbitai[bot] left review comments

Assignees

No one assigned

Labels

refactor Code refactoring

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

Back | FazBrowse Home | New Git URL