fix(lsp): get language server on par with v2

[ymc9]

Summary by CodeRabbit

• New Features

  • Enhanced IDE support: context-aware code completion, formatting, definition navigation, and semantic highlighting.
  • Quick fixes: automatic code actions to add missing relations.
  • Improved inline documentation and generated comments for models and fields.

• Bug Fixes

  • Error responses now include additional context for easier troubleshooting.

• Chores

  • VS Code extension version bumped.
  • Added language server dependency.

[coderabbitai]

Note

Other AI code review bot(s) detected

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

Walkthrough

Adds multiple LSP providers, a code action, completion logic, formatter and comment/documentation/semantic tooling to the language package; adjusts exports and imports for ZModelCodeGenerator, updates dependencies and TS config, bumps the VSCode extension version, tweaks validators, and enriches server RPC error payloads.

Changes

Cohort / File(s)	Summary
VSCode Extension Versioning packages/ide/vscode/package.json	Bumped extension version from 3.0.11 to 3.0.12.
Language package manifest & exports packages/language/package.json, packages/language/src/index.ts	Added dependency vscode-languageserver@^9.0.1; exported ZModelCodeGenerator from language entry.
LSP & Documentation Providers packages/language/src/zmodel-formatter.ts, packages/language/src/zmodel-definition.ts, packages/language/src/zmodel-completion-provider.ts, packages/language/src/zmodel-semantic.ts, packages/language/src/zmodel-comment-provider.ts, packages/language/src/zmodel-documentation-provider.ts, packages/language/src/zmodel-code-action.ts	Added Formatter, DefinitionProvider, CompletionProvider, SemanticTokenProvider, CommentProvider, DocumentationProvider, and CodeActionProvider implementations with formatting, navigation, completion, highlighting, comment generation, documentation resolution, and a quick-fix for missing opposite relations.
Module wiring & plugin loading packages/language/src/module.ts	Wired new providers into ZModelLanguageModule and changed plugin document loading to resolve URIs before creating/loading documents.
Validators packages/language/src/validators/attribute-application-validator.ts, packages/language/src/validators/function-invocation-validator.ts	Removed @ts-expect-error suppression comments above several private check methods; no runtime logic changes.
Codegen import adjustments packages/language/src/zmodel-code-generator.ts	Switched some imports to local ./ast and ./utils paths instead of external package paths.
SDK exports & imports packages/sdk/src/index.ts, packages/sdk/src/prisma/prisma-schema-generator.ts	Removed export * from './zmodel-code-generator' from SDK index; added explicit ZModelCodeGenerator import in Prisma schema generator.
TS Compiler options packages/language/tsconfig.json	Set compilerOptions.noUnusedLocals to false.
Server RPC error payload packages/server/src/api/rpc/index.ts	Added reason field to ORM error response payloads (populated from err.reason).

Estimated code review effort

🎯 4 (Complex) | ⏱️ ~45 minutes

• Pay extra attention to:
  • packages/language/src/zmodel-completion-provider.ts — dense logic for context-aware completions, hints, cross-reference filtering and documentation rendering.
  • packages/language/src/zmodel-code-action.ts — AST navigation and text-edit generation for the opposite-relation quick-fix (indentation, target ranges).
  • packages/language/src/module.ts — provider wiring and plugin document loading order/state.
  • packages/sdk/src/index.ts and packages/sdk/src/prisma/prisma-schema-generator.ts — ensure consumers of SDK exports are not broken by removed re-export and import path changes.

Possibly related PRs

• refactor: revised error system #377 — Related changes to server RPC error handling and ORM error response shaping.
• feat: many-to-many relations #15 — Related to SDK export/import adjustments for ZModelCodeGenerator and Prisma generator usage.
• feat: vscode extension #23 — Related to VSCode extension package.json changes (extension manifest/version).

Poem

🐰 I hopped through code with eager paws,

Added hints, formatters, provider laws,
Definitions found and docs that sing,
Quick-fixes sprout on relation string,
A tiny hop—now LSP has wings. ✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title 'fix(lsp): get language server on par with v2' directly describes the main objective of this PR - bringing the language server (LSP) functionality up to feature parity with v2.
Docstring Coverage	✅ Passed	Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.

✨ Finishing touches

• 📝 Generate docstrings

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch fix/language-server

---

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

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[claude]

Claude finished @ymc9's task —— View job

---

PR Review: Language Server Improvements

I've completed my review of this pull request that brings the language server functionality up to par with v2. Here's my comprehensive feedback:

✅ Positive Aspects

1. Code Quality & Architecture

• Well-structured implementation: The new language server components follow solid architectural patterns with clear separation of concerns
• Consistent coding style: All new files follow established TypeScript/JavaScript conventions
• Good use of design patterns: Proper use of decorator patterns (@gen, @check, @func) for extensibility
• Type safety: Strong TypeScript usage throughout with proper interface definitions

2. Comprehensive Language Server Features

• Complete LSP implementation: Covers all major language server features (completion, formatting, semantic tokens, etc.)
• Smart completion: Context-aware completions with hint system and filtering
• Professional formatting: Alignment-based formatting for better code readability
• Rich semantic highlighting: Comprehensive token classification for syntax highlighting

3. Integration Quality

• Clean module integration: Well-organized dependency injection in module.ts
• Proper service lifecycle: Correct initialization and cleanup patterns
• VSCode extension compatibility: Proper package.json configuration for VSCode marketplace

⚠️ Areas of Concern

1. Error Handling & Robustness

• Silent failure in completion (zmodel-completion-provider.ts:48-54): Errors are logged but not surfaced to users
• File system sync operations (zmodel-completion-provider.ts:335-347): Uses synchronous file reading which could block the language server
• Missing null checks: Some areas could benefit from more defensive programming

2. Performance Considerations

• Sync file operations: fs.readFileSync in completion provider could cause UI freezing
• Large file handling: No pagination or limits for completion items in large schemas
• Memory usage: Complex completion logic might consume significant memory on large codebases

3. Test Coverage Gaps ⚠️

Critical Issue: No tests found for any of the new language server components:

• No tests for completion provider (397 LOC)
• No tests for formatter (114 LOC)
• No tests for semantic token provider (111 LOC)
• No tests for code action provider (169 LOC)

This is a significant concern for production readiness.

📋 Specific Code Issues

Security & Safety

• File path validation (zmodel-completion-provider.ts:336): Should validate file paths before reading
• Error information exposure: Consider sanitizing error messages in production

Code Quality Improvements

// zmodel-completion-provider.ts:48-54 - Consider user feedback on errors
override async getCompletion(document: LangiumDocument, params: CompletionParams) {
    try {
        return await super.getCompletion(document, params);
    } catch (e) {
        console.error('Completion error:', (e as Error).message);
        // Consider: Show user-friendly error or fallback completions
        return undefined;
    }
}

Minor Issues

• Typo in filename: zmodle-comment-provider.ts should be zmodel-comment-provider.ts (missing 'e')
• Unused tsconfig option: "noUnusedLocals": false in tsconfig.json might be intentional but should be documented

🔧 Recommendations

High Priority

1. Add comprehensive tests for all new language server components
2. Replace sync file operations with async alternatives
3. Add proper error boundaries and user-facing error messages
4. Fix filename typo for consistency

Medium Priority

1. Add performance monitoring for large file operations
2. Implement completion caching to improve responsiveness
3. Add configuration options for formatter behavior
4. Document plugin architecture for extensibility

Low Priority

1. Add JSDoc documentation to public APIs
2. Consider lazy loading for heavy language server features
3. Add telemetry for feature usage analytics

📊 Overall Assessment

Score: 7.5/10

This is a solid implementation that successfully brings language server capabilities to v3. The architecture is well-designed and the feature set is comprehensive. However, the lack of tests is a critical gap that should be addressed before production deployment.

Recommendation: Approve with conditions - address the test coverage and async file operations before merging.

The code quality is high and the implementation follows best practices, but production readiness requires better test coverage and error handling.

--- | Branch: fix/language-server

[Copilot]

Pull Request Overview

This PR adds comprehensive Language Server Protocol (LSP) support to the ZModel language, enabling enhanced IDE features such as code completion, formatting, semantic highlighting, and quick fixes. The changes also refactor the code generator organization by moving ZModelCodeGenerator from the sdk package to the language package where it's more appropriately placed alongside other language infrastructure.

Key Changes:

• Addition of LSP providers for completion, formatting, semantic tokens, documentation, definitions, and code actions
• Migration of ZModelCodeGenerator from @zenstackhq/sdk to @zenstackhq/language package
• Addition of vscode-languageserver dependency for LSP type definitions
• Improved plugin document loading logic to avoid reloading already-loaded plugins

Reviewed Changes

Copilot reviewed 18 out of 19 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
pnpm-lock.yaml	Adds vscode-languageserver@9.0.1 dependency
packages/server/src/api/rpc/index.ts	Adds reason field to ORM error responses for better error handling
packages/sdk/src/prisma/prisma-schema-generator.ts	Updates import path for ZModelCodeGenerator after its move to language package
packages/sdk/src/index.ts	Removes re-export of ZModelCodeGenerator after migration
packages/language/tsconfig.json	Disables noUnusedLocals to accommodate decorator parameters and method overrides
packages/language/src/zmodle-comment-provider.ts	New file providing default comments for language elements (filename has typo)
packages/language/src/zmodel-semantic.ts	New provider for semantic token highlighting
packages/language/src/zmodel-formatter.ts	New provider for document formatting with custom ZModel rules
packages/language/src/zmodel-documentation-provider.ts	New provider supporting triple-slash and JSDoc comments
packages/language/src/zmodel-definition.ts	New provider for go-to-definition support including import resolution
packages/language/src/zmodel-completion-provider.ts	New comprehensive completion provider with context-aware suggestions
packages/language/src/zmodel-code-generator.ts	Updates imports after file relocation from sdk package
packages/language/src/zmodel-code-action.ts	New provider for quick fixes, including missing opposite relation fix
packages/language/src/validators/function-invocation-validator.ts	Removes obsolete @ts-expect-error comments
packages/language/src/validators/attribute-application-validator.ts	Removes obsolete @ts-expect-error comments
packages/language/src/module.ts	Registers new LSP providers and improves plugin document loading logic
packages/language/src/index.ts	Exports ZModelCodeGenerator for external use
packages/language/package.json	Adds vscode-languageserver dependency
packages/ide/vscode/package.json	Version bump to 3.0.12

Files not reviewed (1)

• pnpm-lock.yaml: Language not supported

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[claude]

Claude finished @ymc9's task —— View job

---

📋 PR Review: Language Server Improvements

I've completed a comprehensive review of this pull request that brings the language server functionality up to par with v2. Here's my detailed analysis:

✅ Positive Aspects

Code Quality & Architecture

• Well-structured implementation: The new language server components follow solid architectural patterns with clear separation of concerns
• Consistent coding style: All new files follow established TypeScript conventions
• Good use of design patterns: Proper use of decorator patterns (@gen, @check, @func) for extensibility
• Type safety: Strong TypeScript usage throughout with proper interface definitions

Comprehensive Language Server Features

• Complete LSP implementation: Covers all major language server features (completion, formatting, semantic tokens, etc.)
• Smart completion: Context-aware completions with hint system and filtering
• Professional formatting: Alignment-based formatting for better code readability
• Rich semantic highlighting: Comprehensive token classification for syntax highlighting

Integration Quality

• Clean module integration: Well-organized dependency injection in module.ts
• Proper service lifecycle: Correct initialization and cleanup patterns
• VSCode extension compatibility: Proper package.json configuration for VSCode marketplace

⚠️ Areas of Concern

1. Error Handling & Robustness

• Silent failure in completion (zmodel-completion-provider.ts:48-54): Errors are logged but not surfaced to users
• File system sync operations (zmodel-completion-provider.ts:335-347): Uses synchronous file reading which could block the language server
• Missing null checks: Some areas could benefit from more defensive programming

2. Performance Considerations

• Sync file operations: fs.readFileSync in completion provider could cause UI freezing
• Large file handling: No pagination or limits for completion items in large schemas
• Memory usage: Complex completion logic might consume significant memory on large codebases

3. Critical Test Coverage Gap ⚠️

Major Issue: No tests found for any of the new language server components:

• No tests for completion provider (397 LOC)
• No tests for formatter (114 LOC)
• No tests for semantic token provider (111 LOC)
• No tests for code action provider (169 LOC)

This is a significant concern for production readiness.

🔧 Specific Issues Found

Security & Safety

• File path validation (zmodel-completion-provider.ts:336): Should validate file paths before reading
• Error information exposure: Consider sanitizing error messages in production

Minor Issues

• Typo in filename: The import reference should be ./zmodel-comment-provider not ./zmodle-comment-provider
• Unused tsconfig option: "noUnusedLocals": false in tsconfig.json might be intentional but should be documented

📊 Code Quality Score: 7.5/10

Breakdown:

• Architecture: 9/10 (Excellent design patterns and structure)
• Implementation: 8/10 (High-quality code with good practices)
• Error Handling: 6/10 (Some improvements needed)
• Performance: 7/10 (Mostly good but sync operations concern)
• Test Coverage: 3/10 ⚠️ (Critical gap)
• Documentation: 8/10 (Good inline docs and comments)

🎯 Recommendations

High Priority (Before Merge)

1. Fix filename typo: Rename zmodle-comment-provider.ts to zmodel-comment-provider.ts
2. Add basic test coverage for at least the completion provider
3. Replace sync file operations with async alternatives

Medium Priority (Next Release)

1. Comprehensive test suite for all LSP providers
2. Add performance monitoring for large file operations
3. Implement error boundaries with user-facing error messages
4. Add configuration options for formatter behavior

Low Priority

1. Add JSDoc documentation to public APIs
2. Consider lazy loading for heavy language server features
3. Add telemetry for feature usage analytics

🏁 Final Assessment

This is a solid implementation that successfully brings comprehensive language server capabilities to v3. The architecture is well-designed and the feature set is complete.

Recommendation: Approve with conditions - The implementation quality is high, but the lack of tests is a critical gap that should be addressed for production readiness.

The code demonstrates professional development practices and follows established patterns. Once test coverage is improved, this will be a significant enhancement to the developer experience.

✅ Completed Review Tasks

• Read and analyze all changed files
• Review LSP provider implementations for code quality
• Check for potential bugs and security issues
• Evaluate performance considerations
• Assess test coverage for new components
• Review architecture and code organization
• Compile comprehensive feedback

---

| Branch: fix/language-server

[ymc9]

fixes #313

[coderabbitai]

Actionable comments posted: 2

🧹 Nitpick comments (3)

packages/language/tsconfig.json (1)

4-6: Consider keeping strict noUnusedLocals checks with alternative approaches.

Disabling noUnusedLocals masks potential dead code or incomplete implementations. Rather than relaxing the check globally, prefer to:

• Use the _ prefix convention for intentionally unused variables (e.g., _unused)
• Remove actual unused code if it's not needed
• Clearly document if there's a temporary reason for the permissive setting

This is particularly important given the large surface area of new LSP features in this PR.

packages/server/src/api/rpc/index.ts (1)

192-194: Good addition - improves error response context.

Adding the reason field to the error payload allows API consumers to programmatically handle different error types without parsing error messages.

Optional: Consider adding an explicit type for the error payload.

The any type for the error object reduces type safety. Consider defining an interface for the error response structure:

interface ErrorResponse {
  message: string;
  reason: ORMErrorReason;
  model?: string;
  rejectedByValidation?: boolean;
  rejectedByPolicy?: boolean;
  rejectReason?: string;
  dbErrorCode?: string;
}

Then replace line 194:

-const error: any = { message: err.message, reason: err.reason };
+const error: ErrorResponse = { message: err.message, reason: err.reason };

packages/language/src/zmodel-semantic.ts (1)

65-78: Use type tokens for referenced field types

When a field type resolves through node.reference, it still represents a type (model/enum/typedef), but we classify it as a macro. That causes those identifiers to be colored differently from other type references. Please switch this branch to emit SemanticTokenTypes.type for consistency with intrinsic types and data model declarations.

Apply this diff:

-        } else if (isDataFieldType(node)) {
-            if (node.type) {
-                acceptor({
-                    node,
-                    property: 'type',
-                    type: SemanticTokenTypes.type,
-                });
-            } else {
-                acceptor({
-                    node,
-                    property: 'reference',
-                    type: SemanticTokenTypes.macro,
-                });
-            }
+        } else if (isDataFieldType(node)) {
+            if (node.type) {
+                acceptor({
+                    node,
+                    property: 'type',
+                    type: SemanticTokenTypes.type,
+                });
+            } else {
+                acceptor({
+                    node,
+                    property: 'reference',
+                    type: SemanticTokenTypes.type,
+                });
+            }

📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between ff0808d and 88082e6.

⛔ Files ignored due to path filters (1)

• pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml

📒 Files selected for processing (18)

• packages/ide/vscode/package.json (1 hunks)
• packages/language/package.json (1 hunks)
• packages/language/src/index.ts (1 hunks)
• packages/language/src/module.ts (3 hunks)
• packages/language/src/validators/attribute-application-validator.ts (0 hunks)
• packages/language/src/validators/function-invocation-validator.ts (0 hunks)
• packages/language/src/zmodel-code-action.ts (1 hunks)
• packages/language/src/zmodel-code-generator.ts (1 hunks)
• packages/language/src/zmodel-completion-provider.ts (1 hunks)
• packages/language/src/zmodel-definition.ts (1 hunks)
• packages/language/src/zmodel-documentation-provider.ts (1 hunks)
• packages/language/src/zmodel-formatter.ts (1 hunks)
• packages/language/src/zmodel-semantic.ts (1 hunks)
• packages/language/src/zmodle-comment-provider.ts (1 hunks)
• packages/language/tsconfig.json (1 hunks)
• packages/sdk/src/index.ts (0 hunks)
• packages/sdk/src/prisma/prisma-schema-generator.ts (2 hunks)
• packages/server/src/api/rpc/index.ts (1 hunks)

💤 Files with no reviewable changes (3)

• packages/sdk/src/index.ts
• packages/language/src/validators/function-invocation-validator.ts
• packages/language/src/validators/attribute-application-validator.ts

🧰 Additional context used

🧬 Code graph analysis (6)

packages/language/src/zmodel-definition.ts (2)

packages/language/src/generated/ast.ts (1)

• isModelImport (579-581)

packages/language/src/utils.ts (1)

• resolveImport (398-416)

packages/language/src/zmodle-comment-provider.ts (1)

packages/language/src/generated/ast.ts (5)

• isDataModel (391-393)
• isTypeDef (737-739)
• isEnumField (446-448)
• isDataField (344-346)
• isFunctionDecl (475-477)

packages/language/src/zmodel-semantic.ts (1)

packages/language/src/generated/ast.ts (19)

• isDataModel (391-393)
• isDataSource (417-419)
• isGeneratorDecl (516-518)
• isPlugin (628-630)
• isTypeDef (737-739)
• isDataField (344-346)
• isConfigField (303-305)
• isAttributeArg (221-223)
• isPluginField (641-643)
• isEnumField (446-448)
• isDataFieldType (373-375)
• isDataModelAttribute (404-406)
• isDataFieldAttribute (357-359)
• isInternalAttribute (529-531)
• isInvocationExpr (542-544)
• isFunctionDecl (475-477)
• isAttribute (208-210)
• isReferenceExpr (697-699)
• isMemberAccessExpr (555-557)

packages/language/src/module.ts (6)

packages/language/src/zmodel-formatter.ts (1)

• ZModelFormatter (7-114)

packages/language/src/zmodel-definition.ts (1)

• ZModelDefinitionProvider (7-37)

packages/language/src/zmodel-completion-provider.ts (1)

• ZModelCompletionProvider (35-397)

packages/language/src/zmodel-semantic.ts (1)

• ZModelSemanticTokenProvider (27-111)

packages/language/src/zmodle-comment-provider.ts (1)

• ZModelCommentProvider (5-21)

packages/language/src/zmodel-documentation-provider.ts (1)

• ZModelDocumentationProvider (6-15)

packages/language/src/zmodel-code-action.ts (4)

packages/language/src/zmodel-formatter.ts (1)

• ZModelFormatter (7-114)

packages/language/src/validators/datamodel-validator.ts (1)

• MissingOppositeRelationData (494-503)

packages/language/src/generated/ast.ts (1)

• isDataModel (391-393)

packages/language/src/utils.ts (2)

• getAllFields (511-536)
• getDocument (570-577)

packages/language/src/zmodel-completion-provider.ts (3)

packages/language/src/generated/ast.ts (11)

• isDataModelAttribute (404-406)
• isDataFieldAttribute (357-359)
• isArrayExpr (193-195)
• isMemberAccessExpr (555-557)
• isEnumField (446-448)
• isInvocationExpr (542-544)
• isFunctionDecl (475-477)
• isDataField (344-346)
• isDataModel (391-393)
• isTypeDef (737-739)
• isAttribute (208-210)

packages/language/src/utils.ts (1)

• isEnumFieldReference (136-138)

packages/language/src/zmodel-code-generator.ts (1)

• ZModelCodeGenerator (72-389)

⏰ 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). (4)

• GitHub Check: Agent
• GitHub Check: build-test (20.x, sqlite)
• GitHub Check: build-test (20.x, postgresql)
• GitHub Check: claude-review

🔇 Additional comments (1)

packages/ide/vscode/package.json (1)

4-4: Version bump is appropriate for LSP improvements.

The patch version increment (3.0.11 → 3.0.12) correctly reflects the bug-fix nature of the LSP enhancements. Since the extension depends on @zenstackhq/language via workspace:*, it will automatically pick up the new language server providers (formatter, completion, definition, semantic tokens, etc.) from the language package.

[claude]

Claude finished @ymc9's task —— View job

---

📋 PR Review: Language Server Improvements

I've completed a comprehensive review of this pull request that brings the language server functionality up to par with v2. Here's my detailed analysis:

Review Checklist:

• Read and analyze all changed files
• Review LSP provider implementations for code quality
• Check for potential bugs and security issues
• Evaluate performance considerations
• Assess test coverage for new components
• Review architecture and code organization
• Compile comprehensive feedback

✅ Positive Aspects

Code Quality & Architecture

• Well-structured implementation: The new language server components follow solid architectural patterns with clear separation of concerns
• Consistent coding style: All new files follow established TypeScript conventions
• Good use of design patterns: Proper use of decorator patterns (@gen, @check, @func) for extensibility
• Type safety: Strong TypeScript usage throughout with proper interface definitions

Comprehensive Language Server Features

• Complete LSP implementation: Covers all major language server features (completion, formatting, semantic tokens, etc.)
• Smart completion: Context-aware completions with hint system and filtering
• Professional formatting: Alignment-based formatting for better code readability
• Rich semantic highlighting: Comprehensive token classification for syntax highlighting

Integration Quality

• Clean module integration: Well-organized dependency injection in module.ts
• Proper service lifecycle: Correct initialization and cleanup patterns
• VSCode extension compatibility: Proper package.json configuration for VSCode marketplace

⚠️ Areas of Concern

1. Error Handling & Robustness

• Silent failure in completion (zmodel-completion-provider.ts:48-54): Errors are logged but not surfaced to users
• File system sync operations (zmodel-completion-provider.ts:335-347): Uses synchronous file reading which could block the language server
• Missing null checks: Some areas could benefit from more defensive programming

2. Performance Considerations

• Sync file operations: fs.readFileSync in completion provider could cause UI freezing
• Large file handling: No pagination or limits for completion items in large schemas
• Memory usage: Complex completion logic might consume significant memory on large codebases

3. Critical Test Coverage Gap ⚠️

Major Issue: No tests found for any of the new language server components:

• No tests for completion provider (397 LOC)
• No tests for formatter (114 LOC)
• No tests for semantic token provider (111 LOC)
• No tests for code action provider (169 LOC)

This is a significant concern for production readiness.

🔧 Specific Issues Found

Security & Safety

• File path validation (zmodel-completion-provider.ts:336): Should validate file paths before reading
• Error information exposure: Consider sanitizing error messages in production

Minor Issues

• Typo in filename: The import reference should be ./zmodel-comment-provider not ./zmodle-comment-provider
• Unused tsconfig option: "noUnusedLocals": false in tsconfig.json might be intentional but should be documented

📊 Code Quality Score: 7.5/10

Breakdown:

• Architecture: 9/10 (Excellent design patterns and structure)
• Implementation: 8/10 (High-quality code with good practices)
• Error Handling: 6/10 (Some improvements needed)
• Performance: 7/10 (Mostly good but sync operations concern)
• Test Coverage: 3/10 ⚠️ (Critical gap)
• Documentation: 8/10 (Good inline docs and comments)

🎯 Recommendations

High Priority (Before Merge)

1. Fix filename typo: Rename zmodle-comment-provider.ts to zmodel-comment-provider.ts
2. Add basic test coverage for at least the completion provider
3. Replace sync file operations with async alternatives

Medium Priority (Next Release)

1. Comprehensive test suite for all LSP providers
2. Add performance monitoring for large file operations
3. Implement error boundaries with user-facing error messages
4. Add configuration options for formatter behavior

Low Priority

1. Add JSDoc documentation to public APIs
2. Consider lazy loading for heavy language server features
3. Add telemetry for feature usage analytics

🏁 Final Assessment

This is a solid implementation that successfully brings comprehensive language server capabilities to v3. The architecture is well-designed and the feature set is complete.

Recommendation: Approve with conditions - The implementation quality is high, but the lack of tests is a critical gap that should be addressed for production readiness.

The code demonstrates professional development practices and follows established patterns. Once test coverage is improved, this will be a significant enhancement to the developer experience.

✅ Completed Review Tasks

• Read and analyze all changed files
• Review LSP provider implementations for code quality
• Check for potential bugs and security issues
• Evaluate performance considerations
• Assess test coverage for new components
• Review architecture and code organization
• Compile comprehensive feedback

---

| Branch: fix/language-server

[coderabbitai]

Actionable comments posted: 1

📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 85c41de and c59f505.

📒 Files selected for processing (1)

• packages/language/src/zmodel-formatter.ts (1 hunks)

🧰 Additional context used

🧬 Code graph analysis (1)

packages/language/src/zmodel-formatter.ts (1)

packages/language/src/module.ts (1)

• ZModelLanguageMetaData (27-27)

⏰ 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). (3)

• GitHub Check: build-test (20.x, sqlite)
• GitHub Check: claude-review
• GitHub Check: build-test (20.x, postgresql)