Add url-link in console for download content from url

Author: davidkallesen

src/Atc.CodingRules.AnalyzerProviders/Providers/AnalyzerProviderBase.cs

@@ -2,8 +2,7 @@ namespace Atc.CodingRules.AnalyzerProviders.Providers;
 
 public abstract class AnalyzerProviderBase : IAnalyzerProvider
 {
-    [SuppressMessage("Minor Code Smell", "S1075:URIs should not be hardcoded", Justification = "OK.")]
-    private const string GitRawAtcAnalyzerProviderBaseRulesBasePath = "https://raw.githubusercontent.com/atc-net/atc-coding-rules-updater/main/AnalyzerProviderBaseRules/";
+    private const string GitRawAtcAnalyzerProviderBaseRulesBasePath = Constants.GitRawContentUrl + "/atc-net/atc-coding-rules-updater/main/AnalyzerProviderBaseRules/";
     private readonly ILogger logger;
     private readonly bool logWithAnsiConsoleMarkup;
 
@@ -133,7 +132,12 @@ protected static Task WriteToTempFolder(
     {
         ArgumentNullException.ThrowIfNull(data);
 
-        var rawGitData = HttpClientHelper.GetAsString(logger, GitRawAtcAnalyzerProviderBaseRulesBasePath + data.Name + ".json");
+        var url = GitRawAtcAnalyzerProviderBaseRulesBasePath + data.Name + ".json";
+        var displayName = url.Replace(Constants.GitRawContentUrl, Constants.GitHubPrefix, StringComparison.Ordinal);
+        var rawGitData = HttpClientHelper.GetAsString(
+            logger,
+            url,
+            displayName);
         return Task.FromResult(string.IsNullOrEmpty(rawGitData)
             ? null
             : JsonSerializer.Deserialize<AnalyzerProviderBaseRuleData>(rawGitData, AnalyzerProviderSerialization.JsonOptions)!);

src/Atc.CodingRules.Updater.CLI/ProjectHelper.cs

@@ -8,8 +8,7 @@ namespace Atc.CodingRules.Updater.CLI;
 
 public static class ProjectHelper
 {
-    [SuppressMessage("Minor Code Smell", "S1075:URIs should not be hardcoded", Justification = "OK.")]
-    private const string RawCodingRulesDistributionBaseUrl = "https://raw.githubusercontent.com/atc-net/atc-coding-rules/main/distribution";
+    private const string RawCodingRulesDistributionBaseUrl = Constants.GitRawContentUrl + "/atc-net/atc-coding-rules/main/distribution";
     private const string AtcCodingRulesSuppressionsFileName = "AtcCodingRulesSuppressions.txt";
 
     private const string AtcCodingRulesSuppressionsFileNameAsExcel = "AtcCodingRulesSuppressions.xlsx";

src/Atc.CodingRules.Updater/DirectoryBuildPropsHelper.cs

@@ -40,14 +40,16 @@ public static void HandleFile(
             ? $"{rawCodingRulesDistribution}/{FileName}"
             : $"{rawCodingRulesDistribution}/{urlPart}/{FileName}";
 
+        var displayName = rawGitUrl.Replace(Constants.GitRawContentUrl, Constants.GitHubPrefix, StringComparison.Ordinal);
+
         try
         {
             if (!file.Directory!.Exists)
             {
                 Directory.CreateDirectory(file.Directory.FullName);
             }
 
-            var contentGit = HttpClientHelper.GetAsString(logger, rawGitUrl);
+            var contentGit = HttpClientHelper.GetAsString(logger, rawGitUrl, displayName);
             if (useLatestMinorNugetVersion)
             {
                 contentGit = EnsureLatestPackageReferencesVersion(logger, contentGit, LogCategoryType.Trace);

src/Atc.CodingRules.Updater/EditorConfigHelper.cs

@@ -33,14 +33,16 @@ public static void HandleFile(
             ? $"{rawCodingRulesDistribution}/{FileName}"
             : $"{rawCodingRulesDistribution}/{urlPart}/{FileName}";
 
+        var displayName = rawGitUrl.Replace(Constants.GitRawContentUrl, Constants.GitHubPrefix, StringComparison.Ordinal);
+
         try
         {
             if (!file.Directory!.Exists)
             {
                 Directory.CreateDirectory(file.Directory.FullName);
             }
 
-            var contentGit = HttpClientHelper.GetAsString(logger, rawGitUrl).TrimEndForEmptyLines();
+            var contentGit = HttpClientHelper.GetAsString(logger, rawGitUrl, displayName).TrimEndForEmptyLines();
             var contentFile = FileHelper.ReadAllText(file);
 
             HandleFile(logger, area, contentGit, contentFile, descriptionPart, file);

src/Atc.CodingRules/Constants.cs

@@ -0,0 +1,8 @@
+namespace Atc.CodingRules;
+
+public static class Constants
+{
+    [SuppressMessage("Minor Code Smell", "S1075:URIs should not be hardcoded", Justification = "OK.")]
+    public const string GitRawContentUrl = "https://raw.githubusercontent.com";
+    public const string GitHubPrefix = "[silver][[GitHub]][/] ";
+}

src/Atc.CodingRules/GlobalUsings.cs

@@ -1,5 +1,6 @@
 global using System.Collections.Concurrent;
 global using System.Diagnostics;
+global using System.Diagnostics.CodeAnalysis;
 global using System.Net;
 
 global using Atc.Helpers;

src/Atc.CodingRules/HttpClientHelper.cs

@@ -7,6 +7,7 @@ public static class HttpClientHelper
     public static string GetAsString(
         ILogger logger,
         string url,
+        string displayName,
         CancellationToken cancellationToken = default)
     {
         var cacheValue = Cache.GetValueOrDefault(url);
@@ -15,13 +16,18 @@ public static string GetAsString(
             return cacheValue;
         }
 
+        if (string.IsNullOrEmpty(displayName))
+        {
+            displayName = url;
+        }
+
         try
         {
             var response = string.Empty;
             TaskHelper.RunSync(async () =>
             {
                 var stopwatch = Stopwatch.StartNew();
-                logger.LogTrace($"     Download from: {url}");
+                logger.LogTrace($"     Download from: [link={url}]{displayName}[/]");
 
                 var uri = new Uri(url);
                 using var client = new HttpClient();