refactor: rename OrthConnectorConfig to OrthogonalConnectorConfig
#685
Conversation
The old name was used to match the current name of `OrthConnector`, but as it's more readable not to use abbreviated names, it will be renamed to `OrthogonalConnector` in the future. So, rename the configuration object now to limit future breaks (it's not included in any version yet).
WalkthroughThis pull request introduces breaking changes to the maxGraph library. Several internal utility functions have been removed or marked as private, and the browser compatibility check ( Changes
Possibly related PRs
✨ Finishing Touches
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? 🪧 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: 0
🧹 Nitpick comments (2)
packages/website/docs/usage/global-configuration.md (2)
25-25: Correct list item indentation for the renamed configuration object.
The unordered list item forOrthogonalConnectorConfigis indented by 4 spaces, while markdownlint expects 2 spaces at this nesting level.Proposed diff:
- - `OrthogonalConnectorConfig` (since 0.16.0): for `OrthConnector`. + - `OrthogonalConnectorConfig` (since 0.16.0): for `OrthConnector`.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
25-25: Unordered list indentation
Expected: 2; Actual: 4(MD007, ul-indent)
36-36: Correct list item indentation for the reset function entry.
The list entry forresetOrthogonalConnectorConfigis indented by 4 spaces, but should use 2 spaces to comply with the markdownlint MD007 recommendation.Proposed diff:
- - `resetOrthogonalConnectorConfig` (since 0.16.0) + - `resetOrthogonalConnectorConfig` (since 0.16.0)🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
36-36: Unordered list indentation
Expected: 2; Actual: 4(MD007, ul-indent)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (7)
CHANGELOG.md(1 hunks)packages/core/__tests__/view/style/config.test.ts(1 hunks)packages/core/src/types.ts(1 hunks)packages/core/src/view/style/config.ts(2 hunks)packages/core/src/view/style/edge/Orthogonal.ts(3 hunks)packages/html/.storybook/preview.ts(2 hunks)packages/website/docs/usage/global-configuration.md(2 hunks)
✅ Files skipped from review due to trivial changes (1)
- packages/core/src/types.ts
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
packages/website/docs/usage/global-configuration.md
25-25: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
36-36: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
⏰ 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 (6)
packages/html/.storybook/preview.ts (1)
9-9: LGTM!The import and usage of the renamed function are correctly updated.
Also applies to: 28-28
packages/core/__tests__/view/style/config.test.ts (1)
20-20: LGTM!The test case and its dependencies are correctly updated to use the new naming convention.
Also applies to: 22-22, 26-26
packages/core/src/view/style/config.ts (1)
56-56: LGTM!The configuration object and its dependencies are correctly updated to use the new naming convention.
Also applies to: 74-74, 82-83
packages/core/src/view/style/edge/Orthogonal.ts (1)
27-27: LGTM!The import and usage of the renamed configuration are correctly updated.
Also applies to: 122-122, 207-207
packages/website/docs/usage/global-configuration.md (1)
25-36: Approved renaming update and enhanced clarity.
The changes correctly update the configuration object’s name fromOrthConnectorConfigtoOrthogonalConnectorConfig(and similarly update the reset function). This improves clarity and aligns with upcoming naming conventions.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
25-25: Unordered list indentation
Expected: 2; Actual: 4(MD007, ul-indent)
29-29: Unordered list indentation
Expected: 0; Actual: 2(MD007, ul-indent)
30-30: Unordered list indentation
Expected: 0; Actual: 2(MD007, ul-indent)
31-31: Unordered list indentation
Expected: 0; Actual: 2(MD007, ul-indent)
32-32: Unordered list indentation
Expected: 0; Actual: 2(MD007, ul-indent)
33-33: Unordered list indentation
Expected: 0; Actual: 2(MD007, ul-indent)
34-34: Unordered list indentation
Expected: 2; Actual: 4(MD007, ul-indent)
35-35: Unordered list indentation
Expected: 2; Actual: 4(MD007, ul-indent)
36-36: Unordered list indentation
Expected: 2; Actual: 4(MD007, ul-indent)
CHANGELOG.md (1)
34-35: Clear renaming documentation in changelog.
The changelog now states:
"-OrthConnectoris now configured with the globalOrthogonalConnectorConfigobject."
and explains that properties previously onEdgeStylehave been moved accordingly. This entry clearly documents the renaming update and is consistent with the overall objective.
1 participant
The old name was used to match the current name of
OrthConnector, but as it's more readable not to use abbreviated names, it will be renamed toOrthogonalConnectorin the future.So, rename the configuration object now to limit future breaks (it's not included in any version yet).
Summary by CodeRabbit
Refactor
Documentation
Tests