Add NodeInfo.ContainsExternalJumps

Author: desplesda

CHANGELOG.md

@@ -13,6 +13,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 - When the `tags:` header on a node is blank, `Node.Tags` now returns an empty collection, instead of a collection containing a single empty string.
 - Fixed an issue that would cause testplans with syntax errors to incorrectly pass.
 - Fixed an issue where using `visited()` or `visited_count()` would not correctly track visiting node groups.
+- Language Server: NodeInfo objects now indicate whether a node contains any jumps to nodes in a different file.
 
 ### Removed
 

YarnSpinner.LanguageServer.Tests/TestData/TestWorkspace/JumpsAndDetours/ExternalFile.yarn

@@ -0,0 +1,4 @@
+title: NodeInAnotherFile
+---
+This node is in a different file.
+===

YarnSpinner.LanguageServer.Tests/TestData/TestWorkspace/JumpsAndDetours/JumpsAndDetours.yarn

@@ -1,6 +1,7 @@
 title: Node1
 ---
 <<jump Node2>>
+<<jump NodeInAnotherFile>>
 ===
 title: Node2
 ---

YarnSpinner.LanguageServer.Tests/WorkspaceTests.cs

@@ -14,6 +14,7 @@ public class WorkspaceTests
         private static string Project2Path = Path.Combine(TestUtility.PathToTestWorkspace, "Project2", "Project2.yarnproject");
         private static string NoProjectPath = Path.Combine(TestUtility.PathToTestWorkspace, "FilesWithNoProject");
         private static string MultipleDefsPath = Path.Combine(TestUtility.PathToTestWorkspace, "ProjectWithMultipleDefinitionsFiles");
+        private static string JumpsAndDetoursPath = Path.Combine(TestUtility.PathToTestWorkspace, "JumpsAndDetours");
 
         [Fact]
         public void Projects_CanOpen()
@@ -163,5 +164,21 @@ public void Workspace_WithMultipleDefinitionsFiles_UsesMultipleFiles()
             relativeToWorkspaceProject.Functions.Should().Contain(c => c.YarnName == "custom_function_2");
 
         }
+
+        [Fact]
+        public void Workspace_WithJumpsBetweenFiles_IdentifiesJumpsToOtherFiles()
+        {
+            var workspace = new Workspace();
+            workspace.Root = JumpsAndDetoursPath;
+            workspace.Initialize();
+
+            var project = workspace.Projects.Single();
+            var file = project.Files.Single(f => f.Uri.AbsolutePath.EndsWith("JumpsAndDetours.yarn"));
+            var node1 = file.NodeInfos.Single(n => n.UniqueTitle == "Node1");
+            var node2 = file.NodeInfos.Single(n => n.UniqueTitle == "Node2");
+
+            node1.ContainsExternalJumps.Should().BeTrue();
+            node2.ContainsExternalJumps.Should().BeFalse();
+        }
     }
 }

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

@@ -2,6 +2,7 @@
 using Newtonsoft.Json;
 using OmniSharp.Extensions.LanguageServer.Protocol.Models;
 using System.Collections.Generic;
+using System.Linq;
 
 namespace YarnLanguageServer;
 
@@ -81,6 +82,9 @@ public record NodeInfo
     internal List<IToken> VariableReferences { get; init; } = new();
     internal List<(string name, int lineIndex)> CharacterNames { get; init; } = new();
 
+    [JsonProperty("containsExternalJumps")]
+    public bool ContainsExternalJumps => this.Jumps.Any(j => this.File != null && j.DestinationFile != null && j.DestinationFile.Uri != this.File.Uri);
+
     /// <summary>
     /// Gets the computed complexity for this node.
     /// </summary>

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

@@ -21,6 +21,11 @@ public NodeJump(string destinationTitle, IToken destinationToken, JumpType jumpT
     [JsonProperty("type")]
     public JumpType Type { get; init; }
 
+    internal YarnFileData? DestinationFile { get; set; }
+
+    [JsonProperty("destinationFileUri")]
+    internal System.Uri? DestinationFileUri => DestinationFile?.Uri;
+
     /// <summary>
     /// A type of jump from one node to another.
     /// </summary>

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

@@ -272,6 +272,24 @@ public Yarn.Compiler.CompilationResult CompileProject(bool notifyOnComplete, Yar
 
             this.LastCompilationResult = compilationResult;
 
+
+            // For all jumps in all files, attempt to identify the file that the
+            // target of the jump is in, and store it in the jump info
+            var nodesToFiles = this.Files
+                .SelectMany(f => f.NodeInfos
+                    .Where(n => n.SourceTitle != null))
+                    .ToLookup(n => n.SourceTitle!);
+
+
+            foreach (var file in this.Files)
+            {
+                foreach (var jump in file.NodeJumps)
+                {
+                    var nodesWithTitle = nodesToFiles.FirstOrDefault(n => n.Key == jump.DestinationTitle);
+                    jump.DestinationFile = nodesWithTitle?.FirstOrDefault()?.File;
+                }
+            }
+
             if (notifyOnComplete)
             {
                 OnProjectCompiled?.Invoke(compilationResult);