Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add dynamic registration for razor and cshtml files #73369

Merged
merged 4 commits into from
May 13, 2024
Merged
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
// See the LICENSE file in the project root for more information.

using System;
using System.Composition;
using System.Threading;
using System.Threading.Tasks;
using Microsoft.CodeAnalysis.Host.Mef;
using Microsoft.CodeAnalysis.LanguageServer;
using Microsoft.CodeAnalysis.LanguageServer.Handler;
using Roslyn.LanguageServer.Protocol;

namespace Microsoft.VisualStudio.LanguageServices.DevKit.EditAndContinue;

[ExportCSharpVisualBasicLspServiceFactory(typeof(OnInitialized)), Shared]
[method: ImportingConstructor]
[method: Obsolete(MefConstruction.ImportingConstructorMessage, error: true)]
internal sealed class DynamicDocumentSyncRegistration() : ILspServiceFactory
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think I'd prefer this to be in the main language server project. We can check if devkit is enabled using a global option, but maybe we should just have it always be on too.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you just want it next to the sync handlers?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we put it in the protocol project, it will light up in VS. If you want that, then yes. Otherwise put it in the LanguageServer.csproj project (probably in the language server folder).

This is the devkit global option - https://github.com/dotnet/roslyn/blob/main/src/Features/LanguageServer/Protocol/LspOptionsStorage.cs#L31

{
public ILspService CreateILspService(LspServices lspServices, WellKnownLspServerKinds serverKind)
=> new OnInitialized();

public class OnInitialized : IOnInitialized, ILspService
{
public async Task OnInitializedAsync(ClientCapabilities clientCapabilities, RequestContext context, CancellationToken cancellationToken)
{
// If dynamic registration for text document synchronization is supported, register for .razor and .cshtml files
// so that they are up to date for hot reload scenarios rather than depending on the file watchers to update
// the contents.
if (clientCapabilities.TextDocument?.Synchronization?.DynamicRegistration is true)
{
var languageServerManager = context.GetRequiredLspService<IClientLanguageServerManager>();

var documentFilters = new[] { new DocumentFilter() { Pattern = "**/*.razor" }, new DocumentFilter() { Pattern = "**/*.cshtml" } };
var registrationOptions = new TextDocumentRegistrationOptions()
{
DocumentSelector = documentFilters
};

await languageServerManager.SendRequestAsync(Methods.ClientRegisterCapabilityName,
new RegistrationParams()
{
Registrations = [
new()
{
Id = Guid.NewGuid().ToString(), // No need to save this for unregistering
Method = Methods.TextDocumentDidOpenName,
RegisterOptions = registrationOptions
},
new()
{
Id = Guid.NewGuid().ToString(), // No need to save this for unregistering
Method = Methods.TextDocumentDidChangeName,
RegisterOptions = registrationOptions
},
new()
{
Id = Guid.NewGuid().ToString(), // No need to save this for unregistering
Method = Methods.TextDocumentDidCloseName,
RegisterOptions = registrationOptions
}
]
},
cancellationToken).ConfigureAwait(false);
}
}
}
}

Loading