Allow user to set diagnostic severity in lsp init options #181
Conversation
There was a problem hiding this comment.
Pull request overview
This PR adds a configurable diagnosticSeverity field to the LSP initialization options, allowing users to control the severity level of spelling diagnostics. Previously, all diagnostics were hardcoded to INFORMATION level, making typos difficult to see in some editors like Zed.
Key Changes:
- Added configurable diagnostic severity with support for "error", "warning", "information", and "hint" levels
- Implemented custom deserializer with fallback to default when invalid values are provided
- Updated test suite to verify JSON deserialization of the new field
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| crates/codebook-lsp/src/lsp.rs | Replaced hardcoded DiagnosticSeverity::INFORMATION with configurable option from initialization settings |
| crates/codebook-lsp/src/init_options.rs | Added diagnostic_severity field with custom deserializer, default function, and test coverage |
| README.md | Updated example initialization options payload to include the new diagnosticSeverity field |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| fn test_json() { | ||
| let json = r#"{"logLevel": "debug", "checkWhileTyping": false}"#; | ||
| let json = | ||
| r#"{"logLevel": "debug", "checkWhileTyping": false, "diagnosticSeverity": "warning"}"#; | ||
| let options: ClientInitializationOptions = serde_json::from_str(json).unwrap(); | ||
| assert_eq!(options.log_level, LevelFilter::Debug); | ||
| assert!(!options.check_while_typing); | ||
| assert_eq!(options.diagnostic_severity, DiagnosticSeverity::WARNING); | ||
| } |
There was a problem hiding this comment.
Consider adding test cases for additional scenarios: 1) testing that invalid/unknown values fall back to the default severity (e.g., "invalid_value"), 2) testing that missing the field uses the default value, and 3) testing all four severity levels (error, warning, information, hint). This would provide more comprehensive coverage of the deserialize_diagnostic_severity function.
1 participant
In zed, it is often quite hard to see where I have typos, since the default diagnostic type is
INFORMATION. I think it is useful for users to be able to set this themselves.Added a test to test json deserializion.
Not sure where else I can add tests.
Thanks!