chore: separate extension and language id for vscode extension #217
Conversation
|
Note Other AI code review bot(s) detectedCodeRabbit has detected other AI code review bot(s) in this pull request and will avoid duplicating their findings in the review comments. This may lead to a less comprehensive review. Warning Rate limit exceeded@ymc9 has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 19 minutes and 18 seconds before requesting another review. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the 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. 📒 Files selected for processing (2)
WalkthroughThe VS Code extension is rebranded to ZenStack V3: language ID and activation changed from Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Possibly related PRs
Poem
✨ Finishing Touches
🧪 Generate unit tests
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:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
Status, Documentation and Community
|
|
Claude finished @ymc9's task —— View job Code Review: Separate Extension and Language ID for VS Code ExtensionI've analyzed all the changes in this PR. The modifications successfully separate the extension and language identifiers for the VS Code extension to avoid conflicts with the v2 extension. Here's my comprehensive review: Todo List:
✅ Code Quality & Best PracticesExcellent implementation with consistent naming:
✅ Security & PerformanceNo security concerns identified:
Performance impact: Neutral
|
There was a problem hiding this comment.
Pull Request Overview
This PR separates the VS Code extension for ZenStack v3 from the original v2 extension by creating distinct language identifiers and extension names. This allows both versions to coexist without conflicts.
- Changed language ID from
zmodeltozmodel-v3throughout the extension configuration - Updated extension name from
zenstacktozenstack-v3with corresponding display name changes - Excluded the VS Code package from automatic version bumping to maintain separate versioning
Reviewed Changes
Copilot reviewed 4 out of 5 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| scripts/bump-version.ts | Excludes VS Code extension package from automatic version bumping |
| packages/ide/vscode/src/extension/main.ts | Updates language client to use zmodel-v3 language ID |
| packages/ide/vscode/package.json | Changes extension name, language ID, and version configuration |
| packages/ide/vscode/README.md | Updates documentation to reflect v3 extension and coexistence setup |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
|
Claude finished @ymc9's task —— View job Code Review: Separate Extension and Language ID for VS Code ExtensionI've analyzed all the changes in this PR. The modifications successfully separate the extension and language identifiers for the VS Code extension to avoid conflicts with the v2 extension. Here's my comprehensive review: Todo List:
✅ Code Quality & Best PracticesExcellent implementation with consistent naming:
✅ Security & PerformanceNo security concerns identified:
Performance impact: Neutral
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🧹 Nitpick comments (3)
packages/ide/vscode/src/extension/main.ts (1)
50-51: Avoid shadowing the top-levelclientvariable.The local
const clientshadows the outerlet client. Minor readability nit.- const client = new LanguageClient('zmodel-v3', 'ZenStack Model V3', serverOptions, clientOptions); + const lc = new LanguageClient('zmodel-v3', 'ZenStack Model V3', serverOptions, clientOptions); - client.start(); - return client; + lc.start(); + return lc;packages/ide/vscode/README.md (1)
3-3: Grammar: “an type-safe” → “a type-safe”.-... an type-safe ORM with built-in access control, ... +... a type-safe ORM with built-in access control, ...packages/ide/vscode/package.json (1)
60-67: Consider adding an alias clarifying v3 branding.Optional: add “ZenStack Model V3” to
aliasesfor clarity in the Command Palette and language pickers."aliases": [ - "ZenStack Model", - "zmodel" + "ZenStack Model", + "ZenStack Model V3", + "zmodel" ],
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
⛔ Files ignored due to path filters (1)
packages/language/src/generated/module.tsis excluded by!**/generated/**
📒 Files selected for processing (4)
packages/ide/vscode/README.md(1 hunks)packages/ide/vscode/package.json(4 hunks)packages/ide/vscode/src/extension/main.ts(1 hunks)scripts/bump-version.ts(2 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
{packages,samples,tests}/**
📄 CodeRabbit inference engine (CLAUDE.md)
Packages are located in
packages/,samples/, andtests/
Files:
packages/ide/vscode/src/extension/main.tspackages/ide/vscode/README.mdpackages/ide/vscode/package.json
🪛 LanguageTool
packages/ide/vscode/README.md
[grammar] ~9-~9: There might be a mistake here.
Context: ...ide. ## Features - Syntax highlighting - Inline error reporting - Go-to definitio...
(QB_NEW_EN)
[grammar] ~10-~10: There might be a mistake here.
Context: ...ax highlighting - Inline error reporting - Go-to definition - Hover documentation -...
(QB_NEW_EN)
[grammar] ~11-~11: There might be a mistake here.
Context: ...nline error reporting - Go-to definition - Hover documentation - Code section foldi...
(QB_NEW_EN)
[grammar] ~12-~12: There might be a mistake here.
Context: ...- Go-to definition - Hover documentation - Code section folding ## Configuration ...
(QB_NEW_EN)
[grammar] ~55-~55: There might be a mistake here.
Context: ...k.zenstack-v3" }, ``` ## Links - Home - [Documentation](https://zenstack.dev/docs...
(QB_NEW_EN)
[grammar] ~56-~56: There might be a mistake here.
Context: ...ttps://zenstack.dev/v3) - Documentation - [Community chat](https://discord.gg/Ykhr7...
(QB_NEW_EN)
[grammar] ~57-~57: There might be a mistake here.
Context: ...zenstack.dev/docs/x.3) - Community chat - Twitter...
(QB_NEW_EN)
[grammar] ~58-~58: There might be a mistake here.
Context: ...ttps://discord.gg/Ykhr738dUe) - Twitter - Blog ## Com...
(QB_NEW_EN)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: build-test (20.x)
🔇 Additional comments (2)
packages/ide/vscode/README.md (1)
55-57: Verify the documentation URL path.“https://zenstack.dev/docs/x.3” looks off (likely “/v3” or “/3.x”). Please confirm the correct docs URL.
packages/ide/vscode/package.json (1)
50-53: Check VS Code engine/version alignment with language client.You’re using
vscode-languageclient^9.0.1, butengines.vscodeand@types/vscodeare pinned at 1.63.x. Ensure the minimum VS Code engine and typings satisfy the client’s requirements to avoid Marketplace or runtime issues.Suggested direction:
- Bump
"engines": { "vscode": ">=1.67.0" }(or whatever the client requires).- Align
@types/vscodeto the same or higher API version.
|
Claude finished @ymc9's task —— View job Code Review: Separate Extension and Language ID for VS Code ExtensionI've analyzed all the changes in this PR. The modifications successfully separate the extension and language identifiers for the VS Code extension to avoid conflicts with the v2 extension. Here's my comprehensive review: Todo List:
✅ Code Quality & Best PracticesExcellent implementation with consistent naming:
✅ Security & PerformanceNo security concerns identified:
Performance impact: Neutral
|
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (2)
packages/ide/vscode/README.md (2)
55-57: Confirm the v3 docs URL (3.x vs v3).Prior comment suggested using “/docs/v3”. Please verify the canonical path and adjust if needed.
-- [Documentation](https://zenstack.dev/docs/3.x) +- [Documentation](https://zenstack.dev/docs/v3)What is the canonical URL for ZenStack v3 documentation: /docs/3.x or /docs/v3?
47-51: Scope the default formatter to the new language id “[zmodel-v3]”.As previously noted, this should target zmodel-v3, not zmodel.
-"[zmodel]": { +"[zmodel-v3]": { "editor.defaultFormatter": "zenstack.zenstack-v3" },
🧹 Nitpick comments (1)
packages/ide/vscode/README.md (1)
67-67: Point License link to this repository (v3) instead of the v2 repo.Likely intended to reference zenstack-v3.
-[MIT](https://github.com/zenstackhq/zenstack/blob/main/LICENSE) +[MIT](https://github.com/zenstackhq/zenstack-v3/blob/main/LICENSE)
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (1)
packages/ide/vscode/README.md(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
{packages,samples,tests}/**
📄 CodeRabbit inference engine (CLAUDE.md)
Packages are located in
packages/,samples/, andtests/
Files:
packages/ide/vscode/README.md
🪛 LanguageTool
packages/ide/vscode/README.md
[grammar] ~9-~9: There might be a mistake here.
Context: ...ide. ## Features - Syntax highlighting - Inline error reporting - Go-to definitio...
(QB_NEW_EN)
[grammar] ~10-~10: There might be a mistake here.
Context: ...ax highlighting - Inline error reporting - Go-to definition - Hover documentation -...
(QB_NEW_EN)
[grammar] ~11-~11: There might be a mistake here.
Context: ...nline error reporting - Go-to definition - Hover documentation - Code section foldi...
(QB_NEW_EN)
[grammar] ~12-~12: There might be a mistake here.
Context: ...- Go-to definition - Hover documentation - Code section folding ## Configuration ...
(QB_NEW_EN)
[grammar] ~55-~55: There might be a mistake here.
Context: ...k.zenstack-v3" }, ``` ## Links - Home - [Documentation](https://zenstack.dev/docs...
(QB_NEW_EN)
[grammar] ~56-~56: There might be a mistake here.
Context: ...ttps://zenstack.dev/v3) - Documentation - [Community chat](https://discord.gg/Ykhr7...
(QB_NEW_EN)
[grammar] ~57-~57: There might be a mistake here.
Context: ...zenstack.dev/docs/3.x) - Community chat - Twitter...
(QB_NEW_EN)
[grammar] ~58-~58: There might be a mistake here.
Context: ...ttps://discord.gg/Ykhr738dUe) - Twitter - Blog ## Com...
(QB_NEW_EN)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: build-test (20.x)
|
Claude finished @ymc9's task —— View job Code Review: Separate Extension and Language ID for VS Code ExtensionI've analyzed all the changes in this PR. The modifications successfully separate the extension and language identifiers for the VS Code extension to avoid conflicts with the v2 extension. Here's my comprehensive review: Todo List:
✅ Code Quality & Best PracticesExcellent implementation with consistent naming:
✅ Security & PerformanceNo security concerns identified:
Performance impact: Neutral
|
Summary by CodeRabbit
Documentation
Chores