Adds config new command to create new config file. Closes #975 (#996)

Author: waldekmastykarz

dev-proxy/CommandHandlers/ConfigNewCommandHandler.cs

@@ -0,0 +1,101 @@
+// 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 DevProxy.Abstractions;
+using System.Text.Json;
+using System.Text.RegularExpressions;
+
+namespace DevProxy.CommandHandlers;
+
+public class VisualStudioCodeSnippet
+{
+    public string? Prefix { get; set; }
+    public string[]? Body { get; set; }
+    public string? Description { get; set; }
+}
+
+public static class ConfigNewCommandHandler
+{
+    private static readonly string snippetsFileUrl = "https://aka.ms/devproxy/snippets";
+    private static readonly string configFileSnippetName = "ConfigFile";
+
+    public static async Task CreateConfigFileAsync(string name, ILogger logger)
+    {
+        try
+        {
+            var snippets = await DownloadSnippetsAsync(logger);
+            if (snippets is null)
+            {
+                return;
+            }
+
+            if (!snippets.TryGetValue(configFileSnippetName, out var snippet))
+            {
+                logger.LogError("Snippet {snippetName} not found", configFileSnippetName);
+                return;
+            }
+
+            if (snippet.Body is null || snippet.Body.Length == 0)
+            {
+                logger.LogError("Snippet {snippetName} is empty", configFileSnippetName);
+                return;
+            }
+
+            var snippetBody = GetSnippetBody(snippet.Body);
+            var targetFileName = GetTargetFileName(name, logger);
+            File.WriteAllText(targetFileName, snippetBody);
+            logger.LogInformation("Config file created at {targetFileName}", targetFileName);
+        }
+        catch (Exception ex)
+        {
+            logger.LogError(ex, "Error downloading config");
+        }
+    }
+
+    private static string? GetSnippetBody(string[] bodyLines)
+    {
+        var body = string.Join("\n", bodyLines);
+        // unescape $
+        body = body.Replace("\\$", "$");
+        // remove snippet $n markers
+        body = Regex.Replace(body, @"\$[0-9]+", "");
+        return body;
+    }
+
+    private static async Task<Dictionary<string, VisualStudioCodeSnippet>?> DownloadSnippetsAsync(ILogger logger)
+    {
+        logger.LogDebug("Downloading snippets from {snippetsFileUrl}...", snippetsFileUrl);
+        using var client = new HttpClient();
+        var response = await client.GetAsync(snippetsFileUrl);
+        if (response.IsSuccessStatusCode)
+        {
+            var content = await response.Content.ReadAsStringAsync();
+            return JsonSerializer.Deserialize<Dictionary<string, VisualStudioCodeSnippet>>(content, ProxyUtils.JsonSerializerOptions);
+        }
+        else
+        {
+            logger.LogError("Failed to download snippets. Status code: {statusCode}", response.StatusCode);
+            return null;
+        }
+    }
+
+    private static string GetTargetFileName(string name, ILogger logger)
+    {
+        var originalNameWithoutExtension = Path.GetFileNameWithoutExtension(name);
+        var originalExtension = Path.GetExtension(name);
+        var counter = 1;
+
+        while (true)
+        {
+            if (!File.Exists(name))
+            {
+                return name;
+            }
+
+            var newName = $"{originalNameWithoutExtension}-{++counter}{originalExtension}";
+            logger.LogDebug("File {name} already exists. Trying {newName}...", name, newName);
+            name = newName;
+        }
+    }
+}

dev-proxy/Program.cs

@@ -80,6 +80,8 @@
     // we don't need to init plugins if the user is using a global option or
     // using a subcommand, so we can exit early
     await rootCommand.InvokeAsync(args);
+    // required to output all messages before closing the program
+    loggerFactory.Dispose();
     return;
 }
 

dev-proxy/ProxyHost.cs

@@ -309,6 +309,16 @@ public RootCommand GetRootCommand(ILogger logger)
         configGetCommand.SetHandler(async configId => await ConfigGetCommandHandler.DownloadConfigAsync(configId, logger), configIdArgument);
         configCommand.Add(configGetCommand);
 
+        var configNewCommand = new Command("new", "Create new Dev Proxy configuration file");
+        var nameArgument = new Argument<string>("name", "Name of the configuration file")
+        {
+            Arity = ArgumentArity.ZeroOrOne
+        };
+        nameArgument.SetDefaultValue("devproxyrc.json");
+        configNewCommand.AddArgument(nameArgument);
+        configNewCommand.SetHandler(async name => await ConfigNewCommandHandler.CreateConfigFileAsync(name, logger), nameArgument);
+        configCommand.Add(configNewCommand);
+
         var configOpenCommand = new Command("open", "Open devproxyrc.json");
         configOpenCommand.SetHandler(() =>
         {