File based programs IDE support #78208

RikkiGibson · 2025-04-18T21:46:46Z

Design doc: https://github.com/rikkigibson/roslyn/blob/file-based-programs-ide/docs/features/file-based-programs-vscode.md

language server failing to notify client when project finishes loading? (punting)
stop showing misc files warning dialog for FBPs (punting)
remove document
feature flag in FileBasedProgramsWorkspaceProviderFactory
fix razor and non-file uris in general
- when razor doc opened, use LanguageNames.CSharp, pass the doc as AdditionalDoc, pass nothing for ordinary documents
address subscribe to NeedsReload threading concern

See also dotnet/vscode-csharp#8253

.vscode/settings.json

...gs/ConvertLocalFunctionToMethod/CSharpConvertLocalFunctionToMethodCodeRefactoringProvider.cs

src/Features/CSharp/Portable/CodeRefactorings/SyncNamespace/CSharpChangeNamespaceService.cs

...ageServer/Microsoft.CodeAnalysis.LanguageServer/HostWorkspace/LanguageServerProjectSystem.cs

...Server/Microsoft.CodeAnalysis.LanguageServer/HostWorkspace/LanguageServerWorkspaceFactory.cs

src/LanguageServer/Microsoft.CodeAnalysis.LanguageServer/LspFileBasedProgramWorkspace.cs

CyrusNajmabadi · 2025-04-18T22:03:32Z

src/LanguageServer/Microsoft.CodeAnalysis.LanguageServer/LspFileBasedProgramWorkspace.cs

+            var root = tree.GetRoot();
+            return
+                //root.DescendantNodes(descendIntoChildren: node => node.IsKind(SyntaxKind.CompilationUnit)).OfType<GlobalStatementSyntax>().Any() ||
+                root.GetLeadingTrivia().FirstOrDefault().IsKind(SyntaxKind.ShebangDirectiveTrivia);


this feels expensive. if we're just checking leading trivial, we can get hte text, and just check if it literally starts with a #!. because you're getting the leading trivia, only checking the first, and forcing it to ahve that. now it's just a two char check, instead of a full lex/parse.

src/LanguageServer/Microsoft.CodeAnalysis.LanguageServer/LspFileBasedProgramWorkspace.cs

CyrusNajmabadi · 2025-04-18T22:06:52Z

src/LanguageServer/Microsoft.CodeAnalysis.LanguageServer/LspFileBasedProgramWorkspace.cs

+                </PropertyGroup>
+
+                <ItemGroup>
+                    <Compile Include="{documentFilePath}" />


this is not at all safe. (effectively, this is like sql injection). We should not be manually making xml. We should use an xml creation lib to get to this to happen.

This is going to be deleted and replaced with usage of API described in #78159.

src/LanguageServer/Microsoft.CodeAnalysis.LanguageServer/LspFileBasedProgramWorkspace.cs

src/LanguageServer/Protocol/Workspaces/ILspFileBasedProgramWorkspace.cs

CyrusNajmabadi · 2025-04-18T22:08:31Z

src/LanguageServer/Protocol/Workspaces/ILspFileBasedProgramWorkspace.cs

+internal interface ILspFileBasedProgramWorkspace : ILspService
+{
+    public Task<Document?> AddMiscellaneousDocumentAsync(Uri uri, SourceText documentText, string languageId, ILspLogger logger, CancellationToken cancellationToken);
+    public void TryRemoveMiscellaneousDocument(Uri uri, bool removeFromMetadataWorkspace);


doc the heck out of these. esp. threading concerns.

jasonmalinowski · 2025-05-06T01:14:18Z

...ageServer/Microsoft.CodeAnalysis.LanguageServer/HostWorkspace/LanguageServerProjectLoader.cs

            var preferredBuildHostKind = GetKindForProject(projectPath);
            var (buildHost, actualBuildHostKind) = await buildHostProcessManager.GetBuildHostWithFallbackAsync(preferredBuildHostKind, projectPath, cancellationToken);
            if (preferredBuildHostKind != actualBuildHostKind)
                preferredBuildHostKindThatWeDidNotGet = preferredBuildHostKind;


We still need to move this block into the TryLoadProjectAsync() method, since the GetKindForProject is implicitly looking at the project file contents. In the case of the file-based programs, the selection is trivially "just use .NET Core".

jasonmalinowski · 2025-05-06T01:14:53Z

...ageServer/Microsoft.CodeAnalysis.LanguageServer/HostWorkspace/LanguageServerProjectLoader.cs

+            foreach (var project in projectsToRemove)
+            {
+                project.Dispose();
+                _loadedProjects.AddOrUpdate(projectPath, addValueFactory: _ => throw new InvalidOperationException(), updateValueFactory: (_, arr) => arr.Remove(project));


Add a comment obviously that we only expect this getting the update path.

jasonmalinowski · 2025-05-06T01:15:19Z

...ageServer/Microsoft.CodeAnalysis.LanguageServer/HostWorkspace/LanguageServerProjectLoader.cs

    }
+
+    /// <summary>
+    /// Creates a 'LoadedProject' which has bare minimum information, but, which documents can be added to and obtained from.


Use a cref.

jasonmalinowski · 2025-05-06T01:16:47Z

src/LanguageServer/Microsoft.CodeAnalysis.LanguageServer/HostWorkspace/LoadedProject.cs

            // We should never be changing the fundamental identity of this project; if this happens we really should have done a full unload/reload.
            Contract.ThrowIfFalse(newProjectInfo.FilePath == _mostRecentFileInfo.FilePath);
-            Contract.ThrowIfFalse(newProjectInfo.TargetFramework == _mostRecentFileInfo.TargetFramework);
+            Contract.ThrowIfFalse(_mostRecentFileInfo.TargetFramework == null || newProjectInfo.TargetFramework == _mostRecentFileInfo.TargetFramework);


Can be removed now.

jasonmalinowski · 2025-05-06T01:20:47Z

...Server/Microsoft.CodeAnalysis.LanguageServer/HostWorkspace/FileBasedProgramsProjectSystem.cs

+            ContentFilePaths = [],
+            FileGlobs = []
+        };
+        await loadedProject.UpdateWithNewProjectInfoAsync(projectFileInfo, _logger);


We still need to remember to set the "HasAllInformation" flag here.

Considering the following scenarios:

ordinary project. HasAllInformation should always be true, when this method runs, I think.

loose file, not part of a file-based program. HasAllInformation should be false.

file-based program entry point (currently). HasAllInformation should be true.

So I was wondering if we should pass in a flag like forMiscellaneousFiles when creating the LoadedProject, and finally say HasAllInformation = !forMiscellaneousFiles || checkHeuristic() within this method (since it's FBP-ness can change from edit-to-edit.)

jasonmalinowski · 2025-05-06T17:57:07Z

...Server/Microsoft.CodeAnalysis.LanguageServer/HostWorkspace/FileBasedProgramsProjectSystem.cs

+    {
+        const BuildHostProcessKind buildHostKind = BuildHostProcessKind.NetCore;
+        var buildHost = await buildHostProcessManager.GetBuildHostAsync(buildHostKind, cancellationToken);
+        var documentPath = projectToLoad.Path;


We only ever need the path from projectToLoad, right? Should we just pass that in?

...ageServer/Microsoft.CodeAnalysis.LanguageServer/HostWorkspace/LanguageServerProjectLoader.cs

jasonmalinowski · 2025-05-06T18:01:39Z

...ageServer/Microsoft.CodeAnalysis.LanguageServer/HostWorkspace/LanguageServerProjectLoader.cs

+                else
+                {
+                    newProjects.Add(project);
+                }


If we're going to re-create the array all the time, just do ImmutableArray.RemoveRange().

…-ide

RikkiGibson · 2025-05-07T00:09:33Z

"Support unloading projects" is a bit gnarly, I am going to make a pass tomorrow to clean it up and add comments to make our assumptions clear.

docs/features/file-based-programs-vscode.md

...ageServer/Microsoft.CodeAnalysis.LanguageServer/HostWorkspace/LanguageServerProjectLoader.cs

ghost added Area-Infrastructure untriaged Issues and PRs which have not yet been triaged by a lead labels Apr 18, 2025

dotnet-policy-service bot added the VSCode label Apr 18, 2025