Skip to content

Add setting to control references code lens #1900

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

Merged
merged 2 commits into from
Aug 31, 2022
Merged
Show file tree
Hide file tree
Changes from all 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
Expand Up @@ -31,11 +31,13 @@ internal class ReferencesCodeLensProvider : ICodeLensProvider
private readonly SymbolsService _symbolsService;
private readonly WorkspaceService _workspaceService;

public static string Id => nameof(ReferencesCodeLensProvider);

/// <summary>
/// Specifies a unique identifier for the feature provider, typically a
/// fully-qualified name like "Microsoft.PowerShell.EditorServices.MyProvider"
/// </summary>
public string ProviderId => nameof(ReferencesCodeLensProvider);
public string ProviderId => Id;

/// <summary>
/// Construct a new ReferencesCodeLensProvider for a given EditorSession.
Expand Down
31 changes: 23 additions & 8 deletions src/PowerShellEditorServices/Services/Symbols/SymbolsService.cs
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
using Microsoft.Extensions.Logging;
using Microsoft.PowerShell.EditorServices.CodeLenses;
using Microsoft.PowerShell.EditorServices.Logging;
using Microsoft.PowerShell.EditorServices.Services.Configuration;
using Microsoft.PowerShell.EditorServices.Services.PowerShell;
using Microsoft.PowerShell.EditorServices.Services.PowerShell.Runspace;
using Microsoft.PowerShell.EditorServices.Services.PowerShell.Utility;
Expand Down Expand Up @@ -66,17 +67,15 @@ public SymbolsService(
_workspaceService = workspaceService;

_codeLensProviders = new ConcurrentDictionary<string, ICodeLensProvider>();
ICodeLensProvider[] codeLensProviders = new ICodeLensProvider[]
if (configurationService.CurrentSettings.EnableReferencesCodeLens)
{
new ReferencesCodeLensProvider(_workspaceService, this),
new PesterCodeLensProvider(configurationService)
};

foreach (ICodeLensProvider codeLensProvider in codeLensProviders)
{
_codeLensProviders.TryAdd(codeLensProvider.ProviderId, codeLensProvider);
ReferencesCodeLensProvider referencesProvider = new(_workspaceService, this);
_codeLensProviders.TryAdd(referencesProvider.ProviderId, referencesProvider);
}

PesterCodeLensProvider pesterProvider = new(configurationService);
_codeLensProviders.TryAdd(pesterProvider.ProviderId, pesterProvider);

_documentSymbolProviders = new ConcurrentDictionary<string, IDocumentSymbolProvider>();
IDocumentSymbolProvider[] documentSymbolProviders = new IDocumentSymbolProvider[]
{
Expand Down Expand Up @@ -671,5 +670,21 @@ public static FunctionDefinitionAst GetFunctionDefinitionAtLine(

return functionDefinitionAst as FunctionDefinitionAst;
}

internal void OnConfigurationUpdated(object _, LanguageServerSettings e)
{
if (e.EnableReferencesCodeLens)
{
if (_codeLensProviders.ContainsKey(ReferencesCodeLensProvider.Id))
{
return;
}

TryRegisterCodeLensProvider(new ReferencesCodeLensProvider(_workspaceService, this));
return;
}

DeregisterCodeLensProvider(ReferencesCodeLensProvider.Id);
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -24,20 +24,21 @@ internal class PsesConfigurationHandler : DidChangeConfigurationHandlerBase
private readonly WorkspaceService _workspaceService;
private readonly ConfigurationService _configurationService;
private readonly ILanguageServerFacade _languageServer;

public PsesConfigurationHandler(
ILoggerFactory factory,
WorkspaceService workspaceService,
AnalysisService analysisService,
ConfigurationService configurationService,
ILanguageServerFacade languageServer)
ILanguageServerFacade languageServer,
SymbolsService symbolsService)
{
_logger = factory.CreateLogger<PsesConfigurationHandler>();
_workspaceService = workspaceService;
_configurationService = configurationService;
_languageServer = languageServer;

ConfigurationUpdated += analysisService.OnConfigurationUpdated;
ConfigurationUpdated += symbolsService.OnConfigurationUpdated;
}

public override async Task<Unit> Handle(DidChangeConfigurationParams request, CancellationToken cancellationToken)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ internal class LanguageServerSettings
public CodeFoldingSettings CodeFolding { get; set; }
public PesterSettings Pester { get; set; }
public string Cwd { get; set; }
public bool EnableReferencesCodeLens { get; set; } = true;

public LanguageServerSettings()
{
Expand All @@ -46,6 +47,7 @@ public void Update(
CodeFolding.Update(settings.CodeFolding, logger);
Pester.Update(settings.Pester, logger);
Cwd = settings.Cwd;
EnableReferencesCodeLens = settings.EnableReferencesCodeLens;
}
}
}
Expand Down