Change 'undeclared variable' diagnostic severity from warning to hint

Author: desplesda

CHANGELOG.md

@@ -21,6 +21,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 - Language Server: `<<set>>` statements now offer variable names in their code completions.
 - Language Server: hovering smart variables now shows their definition.
 - Language Server: Make compilation asynchronous
+- Language Server: 'Undeclared variable' warnings have had their severity reduced to "hint".
 
 ### Removed
 

YarnSpinner.LanguageServer/src/Server/Diagnostics/Hints.cs

@@ -0,0 +1,50 @@
+
+using MoreLinq;
+using Newtonsoft.Json.Linq;
+using OmniSharp.Extensions.LanguageServer.Protocol.Models;
+using System.Collections.Generic;
+using System.Linq;
+using Range = OmniSharp.Extensions.LanguageServer.Protocol.Models.Range;
+
+namespace YarnLanguageServer.Diagnostics
+{
+    internal static class Hints
+    {
+        public static IEnumerable<Diagnostic> GetHints(YarnFileData yarnFile, Configuration? configuration)
+        {
+            var results = Enumerable.Empty<Diagnostic>();
+
+            results = results.Concat(UndeclaredVariables(yarnFile));
+
+            return results;
+        }
+        private static IEnumerable<Diagnostic> UndeclaredVariables(YarnFileData yarnFile)
+        {
+            var project = yarnFile.Project;
+
+            if (project == null)
+            {
+                // No project, so no diagnostics we can produce
+                return Enumerable.Empty<Diagnostic>();
+            }
+
+            // Find all variable references in this file where the declaration,
+            // if any, is an implicit one. If it is, then we should suggest that
+            // the user create a declaration for it.
+            var undeclaredVariables = yarnFile.VariableReferences
+                .Where(@ref => project.FindVariables(@ref.Text)
+                    .FirstOrDefault()?
+                    .IsImplicit ?? false
+                );
+
+            return undeclaredVariables.Select(v => new Diagnostic
+            {
+                Message = "Variable should be declared",
+                Severity = DiagnosticSeverity.Hint,
+                Range = PositionHelper.GetRange(yarnFile.LineStarts, v),
+                Code = nameof(YarnDiagnosticCode.YRNMsngVarDec),
+                Data = JToken.FromObject(v.Text),
+            });
+        }
+    }
+}

YarnSpinner.LanguageServer/src/Server/Diagnostics/Warnings.cs

@@ -15,7 +15,6 @@ public static IEnumerable<Diagnostic> GetWarnings(YarnFileData yarnFile, Configu
 
             results = results.Concat(UnknownCommands(yarnFile));
             results = results.Concat(UndefinedFunctions(yarnFile, configuration));
-            results = results.Concat(UndeclaredVariables(yarnFile));
             results = results.Concat(UndefinedJumpDestination(yarnFile));
 
             return results;
@@ -82,34 +81,7 @@ private static IEnumerable<Diagnostic> UndefinedFunctions(YarnFileData yarnFile,
             }
         }
 
-        private static IEnumerable<Diagnostic> UndeclaredVariables(YarnFileData yarnFile)
-        {
-            var project = yarnFile.Project;
-
-            if (project == null)
-            {
-                // No project, so no diagnostics we can produce
-                return Enumerable.Empty<Diagnostic>();
-            }
-
-            // Find all variable references in this file where the declaration,
-            // if any, is an implicit one. If it is, then we should suggest that
-            // the user create a declaration for it.
-            var undeclaredVariables = yarnFile.VariableReferences
-                .Where(@ref => project.FindVariables(@ref.Text)
-                    .FirstOrDefault()?
-                    .IsImplicit ?? false
-                );
 
-            return undeclaredVariables.Select(v => new Diagnostic
-            {
-                Message = "Variable should be declared",
-                Severity = DiagnosticSeverity.Warning,
-                Range = PositionHelper.GetRange(yarnFile.LineStarts, v),
-                Code = nameof(YarnDiagnosticCode.YRNMsngVarDec),
-                Data = JToken.FromObject(v.Text),
-            });
-        }
 
         private static IEnumerable<Diagnostic> UndefinedJumpDestination(YarnFileData yarnFile)
         {

YarnSpinner.LanguageServer/src/Server/Workspace/Workspace.cs

@@ -316,6 +316,9 @@ internal Dictionary<Uri, IEnumerable<Diagnostic>> GetDiagnostics()
                 // Add warnings for this file
                 diags = diags.Concat(Warnings.GetWarnings(file, this.Configuration));
 
+                // Add hints for this file
+                diags = diags.Concat(Hints.GetHints(file, this.Configuration));
+
                 // Add the resulting list to the dictionary.
                 result[uri] = diags;
             }