fix unreachable, unused & deprecated diagnostic severity levels not w…

…orking wqhen set in the language server config
DetachHead · Aug 15, 2024 · b3a5d68 · b3a5d68
1 parent 7b616d6
commit b3a5d68
Show file tree

Hide file tree

Showing 4 changed files with 29 additions and 4 deletions.
diff --git a/packages/pyright-internal/src/common/commandLineOptions.ts b/packages/pyright-internal/src/common/commandLineOptions.ts
@@ -18,6 +18,9 @@ export const enum DiagnosticSeverityOverrides {
     Warning = 'warning',
     Information = 'information',
     None = 'none',
+    Unused = 'unused',
+    Unreachable = 'unreachable',
+    Deprecated = 'deprecated',
 }
 
 export function getDiagnosticSeverityOverrides() {
@@ -26,6 +29,9 @@ export function getDiagnosticSeverityOverrides() {
         DiagnosticSeverityOverrides.Warning,
         DiagnosticSeverityOverrides.Information,
         DiagnosticSeverityOverrides.None,
+        DiagnosticSeverityOverrides.Unused,
+        DiagnosticSeverityOverrides.Unreachable,
+        DiagnosticSeverityOverrides.Deprecated,
     ];
 }
 

diff --git a/packages/pyright-internal/src/common/configOptions.ts b/packages/pyright-internal/src/common/configOptions.ts
@@ -1901,6 +1901,15 @@ export function parseDiagLevel(value: string | boolean): DiagnosticSeverityOverr
         case 'information':
             return DiagnosticSeverityOverrides.Information;
 
+        case 'unused':
+            return DiagnosticSeverityOverrides.Unused;
+
+        case 'unreachable':
+            return DiagnosticSeverityOverrides.Unreachable;
+
+        case 'deprecated':
+            return DiagnosticSeverityOverrides.Deprecated;
+
         default:
             return undefined;
     }

diff --git a/packages/pyright-internal/src/languageServerBase.ts b/packages/pyright-internal/src/languageServerBase.ts
@@ -489,6 +489,8 @@ export abstract class LanguageServerBase implements LanguageServerInterface, Dis
 
     protected getSeverityOverrides(value: string | boolean): DiagnosticSeverityOverrides | undefined {
         const enumValue = parseDiagLevel(value);
+        // TODO: this allows additional diagnostic severity levels (unreachable, unused & deprecated) on all rules
+        // in the lsp config. it should use the same logic as ConfigOptions._convertDiagnosticLevel instead
         if (!enumValue) {
             return undefined;
         }

diff --git a/packages/pyright-internal/src/tests/languageServer.test.ts b/packages/pyright-internal/src/tests/languageServer.test.ts
@@ -11,6 +11,7 @@ import {
     CancellationToken,
     CompletionRequest,
     ConfigurationItem,
+    DiagnosticSeverity,
     InitializedNotification,
     InitializeRequest,
     MarkupContent,
@@ -197,7 +198,7 @@ describe(`Basic language server tests`, () => {
     test('Diagnostic severity overrides test', async () => {
         const code = `
 // @filename: test.py
-//// def test([|/*marker*/x|]): ...
+//// def _test([|/*marker*/x|]): ...
 //// 
 // @filename: pyproject.toml
 //// 
@@ -211,6 +212,7 @@ describe(`Basic language server tests`, () => {
                 value: {
                     diagnosticSeverityOverrides: {
                         reportUnknownParameterType: 'warning',
+                        reportUnusedFunction: 'unused',
                     },
                 },
             },
@@ -230,11 +232,17 @@ describe(`Basic language server tests`, () => {
 
         // Wait for the diagnostics to publish
         const diagnostics = await waitForDiagnostics(info);
-        const diagnostic = diagnostics.find((d) => d.uri.includes('test.py'));
-        assert(diagnostic);
+        const file = diagnostics.find((d) => d.uri.includes('test.py'));
+        assert(file);
 
         // Make sure the error has a special rule
-        assert.equal(diagnostic.diagnostics[0].code, 'reportUnknownParameterType');
+        assert.equal(file.diagnostics[0].code, 'reportUnknownParameterType');
+
+        // make sure additional diagnostic severities work
+        assert.equal(
+            file.diagnostics.find((diagnostic) => diagnostic.code === 'reportUnusedFunction')?.severity,
+            DiagnosticSeverity.Hint // TODO: hint? how do we differentiate between unused/unreachable/deprecated?
+        );
     });
     describe('module/package renaming', () => {
         describe('import statement', () => {