Remove experimental flag for JSONRPC command group

docs/experimental-features.md

@@ -47,8 +47,5 @@ Should be enabled in tandem with `assertions` experimental feature flag for expe
 ### `publish-provider` CLI Command
 Command that allows the publishing of providers to container registries. For more information, see [Using the Publish Provider Command](./experimental/publish-provider-command.md).
 
-### `jsonrpc` CLI Command
-Command that launches the CLI in a JSONRPC server mode. Useful for invoking the CLI programatically to consume structured output, and to avoid cold-start delays when compiling multiple files. For more information, see [Using the JSONRPC Command](./experimental/jsonrpc-command.md).
-
 ### Deployment Pane
 The Deployment Pane is a UI panel in VSCode that allows you to connect to your Azure subscription and execute validate, deploy & whatif operations and get instant feedback without leaving the editor. For more information, see [Using the Deployment Pane](./experimental/deploy-ui.md).

src/Bicep.Cli.IntegrationTests/JsonRpcCommandTests.cs

@@ -32,7 +32,7 @@ await Task.WhenAll(
             {
                 var result = await Bicep(registerAction, cts.Token, "jsonrpc", "--pipe", pipeName);
                 result.ExitCode.Should().Be(0);
-                result.Stderr.Should().EqualIgnoringNewlines("The 'jsonrpc' CLI command group is an experimental feature. Experimental features should be enabled for testing purposes only, as there are no guarantees about the quality or stability of these features. Do not enable these settings for any production usage, or your production environment may be subject to breaking.\n");
+                result.Stderr.Should().Be("");
                 result.Stdout.Should().Be("");
             }),
             Task.Run(async () =>

src/Bicep.Cli/Commands/JsonRpcCommand.cs

@@ -26,8 +26,6 @@ public JsonRpcCommand(BicepCompiler compiler, IOContext io)
 
     public async Task<int> RunAsync(JsonRpcArguments args, CancellationToken cancellationToken)
     {
-        await io.Error.WriteLineAsync("The 'jsonrpc' CLI command group is an experimental feature. Experimental features should be enabled for testing purposes only, as there are no guarantees about the quality or stability of these features. Do not enable these settings for any production usage, or your production environment may be subject to breaking.");
-
         if (args.Pipe is { } pipeName)
         {
             if (pipeName.StartsWith(@"\\.\pipe\"))

src/Bicep.Cli/Commands/RootCommand.cs

@@ -227,6 +227,18 @@ bicep build-params params.bicepparam --outfile otherParams.json
       bicep build-params params.bicepparam --no-restore
       bicep build-params params.bicepparam --diagnostics-format sarif
 
+  {exeName} jsonrpc [options]
+    Runs a JSONRPC server for interacting with Bicep programatically.
+
+    Options:
+      --pipe <name>   Runs the JSONRPC server using a named pipe.
+      --socket <dir>  Runs the JSONRPC server on a specific port.
+      --stdio         Runs the JSONRPC server over stdin/stdout.
+
+    Examples:
+      bicep jsonrpc --pipe /path/to/pipe.sock
+      bicep jsonrpc --stdio
+
 "; // this newline is intentional
 
             io.Output.Write(output);

src/Bicep.Cli/Rpc/CliJsonRpcServer.cs

@@ -36,6 +36,7 @@ public CliJsonRpcServer(BicepCompiler compiler)
         this.compiler = compiler;
     }
 
+    /// <inheritdoc/>
     public async Task<VersionResponse> Version(VersionRequest request, CancellationToken cancellationToken)
     {
         await Task.Yield();
@@ -44,6 +45,7 @@ public async Task<VersionResponse> Version(VersionRequest request, CancellationT
             ThisAssembly.AssemblyInformationalVersion.Split('+')[0]);
     }
 
+    /// <inheritdoc/>
     public async Task<CompileResponse> Compile(CompileRequest request, CancellationToken cancellationToken)
     {
         var model = await GetSemanticModel(compiler, request.Path);
@@ -58,6 +60,7 @@ public async Task<CompileResponse> Compile(CompileRequest request, CancellationT
         return new(success, diagnostics, success ? writer.ToString() : null);
     }
 
+    /// <inheritdoc/>
     public async Task<CompileParamsResponse> CompileParams(CompileParamsRequest request, CancellationToken cancellationToken)
     {
         var model = await GetSemanticModel(compiler, request.Path);
@@ -81,6 +84,7 @@ public async Task<CompileParamsResponse> CompileParams(CompileParamsRequest requ
             paramsResult.TemplateSpecId);
     }
 
+    /// <inheritdoc/>
     public async Task<GetFileReferencesResponse> GetFileReferences(GetFileReferencesRequest request, CancellationToken cancellationToken)
     {
         var model = await GetSemanticModel(compiler, request.Path);
@@ -101,6 +105,7 @@ public async Task<GetFileReferencesResponse> GetFileReferences(GetFileReferences
             [.. fileUris.Select(x => x.LocalPath).OrderBy(x => x)]);
     }
 
+    /// <inheritdoc/>
     public async Task<GetMetadataResponse> GetMetadata(GetMetadataRequest request, CancellationToken cancellationToken)
     {
         var model = await GetSemanticModel(compiler, request.Path);

src/Bicep.Cli/Rpc/ICliJsonRpcProtocol.cs

@@ -101,23 +101,47 @@ public record Edge(
         string Target);
 }
 
+/// <summary>
+/// The definition for the Bicep CLI JSONRPC interface.
+/// </summary>
+/// <remarks>
+/// As of Bicep 0.29, this interface is no longer "experimental". Please consider carefully whether you are making a change that may break backwards compatibility.
+/// </remarks>
 public interface ICliJsonRpcProtocol
 {
+    /// <summary>
+    /// Returns the version of the Bicep CLI.
+    /// </summary>
     [JsonRpcMethod("bicep/version", UseSingleObjectParameterDeserialization = true)]
     Task<VersionResponse> Version(VersionRequest request, CancellationToken cancellationToken);
 
+    /// <summary>
+    /// Compiles a specified .bicep file.
+    /// </summary>
     [JsonRpcMethod("bicep/compile", UseSingleObjectParameterDeserialization = true)]
     Task<CompileResponse> Compile(CompileRequest request, CancellationToken cancellationToken);
 
+    /// <summary>
+    /// Compiles a specified .bicepparam file.
+    /// </summary>
     [JsonRpcMethod("bicep/compileParams", UseSingleObjectParameterDeserialization = true)]
     Task<CompileParamsResponse> CompileParams(CompileParamsRequest request, CancellationToken cancellationToken);
 
+    /// <summary>
+    /// Returns metadata about a specified .bicep file.
+    /// </summary>
     [JsonRpcMethod("bicep/getMetadata", UseSingleObjectParameterDeserialization = true)]
     Task<GetMetadataResponse> GetMetadata(GetMetadataRequest request, CancellationToken cancellationToken);
 
+    /// <summary>
+    /// Returns the deployment graph for a specified .bicep file.
+    /// </summary>
     [JsonRpcMethod("bicep/getDeploymentGraph", UseSingleObjectParameterDeserialization = true)]
     Task<GetDeploymentGraphResponse> GetDeploymentGraph(GetDeploymentGraphRequest request, CancellationToken cancellationToken);
 
+    /// <summary>
+    /// Gets the full list of file paths that are referenced by a compilation. Useful to determine a set of files to watch for changes.
+    /// </summary>
     [JsonRpcMethod("bicep/getFileReferences", UseSingleObjectParameterDeserialization = true)]
     Task<GetFileReferencesResponse> GetFileReferences(GetFileReferencesRequest request, CancellationToken cancellationToken);
 }