feat!: improve tree-shaking of Perimeter
#785
Merged
Conversation
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
Previously, `Perimeter` was a value object. So, most bundlers included the whole object even if only some values was used in the application (i.e. the only perimeters registered in StyleRegistry). Notice that some bundlers, like Rollup, was able to only keep the values effectively used by the application. `Perimeter` is no longer an object, but a namespace, so all bundlers should now able to only keep the perimeters really used by the application. BREAKING CHANGES: `Perimeter` has been changed from a value object to a namespace. This has minimal impact for most applications that only read perimeter values. The only breaking change affects applications that modify Perimeter properties (add/update/remove values): this is no longer possible. Instead, create your own perimeter implementation and register it.
WalkthroughThis set of changes refactors how the Changes
Sequence Diagram(s)sequenceDiagram
participant UserApp
participant PerimeterNamespace
participant PerimeterFunctions
UserApp->>PerimeterNamespace: Import Perimeter as namespace
PerimeterNamespace->>PerimeterFunctions: Expose RectanglePerimeter, EllipsePerimeter, etc.
UserApp->>PerimeterNamespace: Use Perimeter.RectanglePerimeter (read-only)
Possibly related issues
Possibly related PRs
Suggested labels
✨ Finishing Touches
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (2)
CHANGELOG.md (1)
12-15: Ensure proper Markdown list indentation
The continuation line under the bullet should be indented by at least four spaces for consistency with CommonMark:@@ - - `Perimeter` has been changed from a value object to a namespace. This has minimal impact for most applications that only read perimeter values. - The only breaking change affects applications that modify Perimeter properties (add/update/remove values): this is no longer possible. Instead, create your own perimeter implementation and register it. + - `Perimeter` has been changed from a value object to a namespace. This has minimal impact for most applications that only read perimeter values. + The only breaking change affects applications that modify Perimeter properties (add/update/remove values): this is no longer possible. Instead, create your own perimeter implementation and register it.packages/core/src/view/style/builtin-style-elements.ts (1)
19-24: Add @SInCE tag to the Perimeter namespace JSDoc
Other namespace exports (e.g.,EdgeMarker) include a@sincetag; adding it here improves consistency and helps consumers track when this breaking change was introduced./** * Provides various perimeter functions to be used in a style as the value of {@link CellStateStyle.perimeter}. * + * @since 0.18.0 * @category Perimeter */ export * as Perimeter from './perimeter';
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (5)
CHANGELOG.md(1 hunks)packages/core/src/view/style/builtin-style-elements.ts(1 hunks)packages/core/src/view/style/perimeter/index.ts(1 hunks)packages/core/src/view/style/register.ts(1 hunks)packages/ts-example-selected-features/vite.config.js(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (4)
- GitHub Check: build
- GitHub Check: build (windows-2022)
- GitHub Check: build (macos-14)
- GitHub Check: build (ubuntu-22.04)
🔇 Additional comments (2)
packages/ts-example-selected-features/vite.config.js (1)
30-30: Approve bump of chunkSizeWarningLimit
Raising thechunkSizeWarningLimitto 382 for the@maxgraph/corechunk aligns with the recent increase in bundle size and avoids superfluous warnings.packages/core/src/view/style/perimeter/index.ts (1)
19-23: Tree-shaking is improved via direct named exports
Breaking out each perimeter function as its own named export eliminates the old aggregate object and ensures unused implementations are dropped by bundlers.
This was referenced Jul 23, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Previously,
Perimeterwas a value object. So, most bundlers included the whole object even if only some values wasused in the application (i.e. the only perimeters registered in StyleRegistry).
Notice that some bundlers, like Rollup, was able to only keep the values effectively used by the application.
Perimeteris no longer an object, but a namespace, so all bundlers should now able to only keep the perimeters reallyused by the application.
BREAKING CHANGES:
Perimeterhas been changed from a value object to a namespace. This has minimal impact for most applications that only read perimeter values.The only breaking change affects applications that modify Perimeter properties (add/update/remove values): this is no longer possible.
Instead, create your own perimeter implementation and register it.
Notes
Covers #759
Impact on application size
Note
JS examples use Webpack, TS examples use Vite (Vite/Rollup does better tree-shaking!)
Analysis
In the examples "without-default", this PR has no impact because Perimeter is not used, so it was already tree-shaked.
The PR has no impact on "ts-example-selected-features".
Vite uses rollup to bundle and it was already shrinking the unused properties of the Perimeter value object.
This has been confirmed on the rollup example of the https://github.com/maxGraph/maxGraph-integration-examples/ repository.
Here is what rollup bundled with the former implementation (when disabling minification to make the code readable):
Summary by CodeRabbit