Add opt-in for Pester v5 code lens

Author: nohwnd

src/PowerShellEditorServices/Services/CodeLens/PesterCodeLensProvider.cs

@@ -3,7 +3,9 @@
 // Licensed under the MIT license. See LICENSE file in the project root for full license information.
 //
 
+using System;
 using System.Collections.Generic;
+using Microsoft.PowerShell.EditorServices.Services;
 using Microsoft.PowerShell.EditorServices.Services.Symbols;
 using Microsoft.PowerShell.EditorServices.Services.TextDocument;
 using Microsoft.PowerShell.EditorServices.Utility;
@@ -14,6 +16,7 @@ namespace Microsoft.PowerShell.EditorServices.CodeLenses
 {
     internal class PesterCodeLensProvider : ICodeLensProvider
     {
+        private readonly ConfigurationService _configurationService;
 
         /// <summary>
         /// The symbol provider to get symbols from to build code lenses with.
@@ -29,8 +32,9 @@ internal class PesterCodeLensProvider : ICodeLensProvider
         /// <summary>
         /// Create a new Pester CodeLens provider for a given editor session.
         /// </summary>
-        public PesterCodeLensProvider()
+        public PesterCodeLensProvider(ConfigurationService configurationService)
         {
+            _configurationService = configurationService;
             _symbolProvider = new PesterDocumentSymbolProvider();
         }
 
@@ -100,7 +104,11 @@ public CodeLens[] ProvideCodeLenses(ScriptFile scriptFile)
             {
                 if (symbol is PesterSymbolReference pesterSymbol)
                 {
-                    lenses.AddRange(GetPesterLens(pesterSymbol, scriptFile));
+                    if (_configurationService.CurrentSettings.Pester.Pester5CodeLens 
+                        || pesterSymbol.Command == PesterCommandType.Describe)
+                    {
+                        lenses.AddRange(GetPesterLens(pesterSymbol, scriptFile));
+                    }
                 }
             }
 

src/PowerShellEditorServices/Services/TextDocument/Handlers/CodeLensHandlers.cs

@@ -27,14 +27,16 @@ internal class CodeLensHandlers : ICodeLensHandler, ICodeLensResolveHandler
         private readonly ILogger _logger;
         private readonly SymbolsService _symbolsService;
         private readonly WorkspaceService _workspaceService;
+        private readonly ConfigurationService _configurationService;
 
         private CodeLensCapability _capability;
 
-        public CodeLensHandlers(ILoggerFactory factory, SymbolsService symbolsService, WorkspaceService workspaceService)
+        public CodeLensHandlers(ILoggerFactory factory, SymbolsService symbolsService, WorkspaceService workspaceService, ConfigurationService configurationService)
         {
             _logger = factory.CreateLogger<FoldingRangeHandler>();
             _workspaceService = workspaceService;
             _symbolsService = symbolsService;
+            _configurationService = configurationService;
         }
 
         CodeLensRegistrationOptions IRegistration<CodeLensRegistrationOptions>.GetRegistrationOptions()

src/PowerShellEditorServices/Services/Workspace/LanguageServerSettings.cs

@@ -26,11 +26,14 @@ internal class LanguageServerSettings
 
         public CodeFoldingSettings CodeFolding { get; set; }
 
+        public PesterSettings Pester { get; set; }
+
         public LanguageServerSettings()
         {
             this.ScriptAnalysis = new ScriptAnalysisSettings();
             this.CodeFormatting = new CodeFormattingSettings();
             this.CodeFolding = new CodeFoldingSettings();
+            this.Pester = new PesterSettings();
         }
 
         public void Update(
@@ -49,6 +52,7 @@ public void Update(
                         logger);
                     this.CodeFormatting = new CodeFormattingSettings(settings.CodeFormatting);
                     this.CodeFolding.Update(settings.CodeFolding, logger);
+                    this.Pester = new PesterSettings(settings.Pester);
                 }
             }
         }
@@ -356,6 +360,27 @@ public void Update(
         }
     }
 
+    /// <summary>
+    /// Pester settings
+    /// </summary>
+    public class PesterSettings
+    {
+        public PesterSettings()
+        {
+
+        }
+
+        public PesterSettings(PesterSettings settings)
+        {
+            Pester5CodeLens = settings.Pester5CodeLens;
+        }
+
+        /// <summary>
+        /// Whether integration features specific to Pester v5 are enabled
+        /// </summary>
+        public bool Pester5CodeLens { get; set; } = false;
+    }
+
     /// <summary>
     /// Additional settings from the Language Client that affect Language Server operations but
     /// do not exist under the 'powershell' section