make sure mlc output is always ordered and small tweaks

Author: edumserrano

.github/workflows/test-action.yml

@@ -252,12 +252,10 @@ jobs:
         step-name: 'Markdown Link Check'
         only-errors: 'false'
         output: 'step-md'
-        json-filepath: './mlc-json-result-3.json'
-        markdown-filepath: './mlc-md-result-3.md'
     - name: Dump outputs from previous step
       run: |
         Write-Output "${{ steps.mlc-log-parser-3.outputs.mlc-result }}"
-    - name: Verify md file output for mlc with errors
+    - name: Verify md step output for mlc with errors
       if: github.event.workflow_run.name == 'Markdown Link Check with errors'
       run: |
         $file = Get-Content ${{ github.workspace }}/.github/workflows/markdown-link-check-files/expected-file-outputs/with-errors/result-without-capture-errors-only.md -Raw
@@ -274,7 +272,7 @@ jobs:
         {
           Write-Output "Markdown step output matches expected Markdown."
         }
-    - name: Verify md file output for mlc without errors
+    - name: Verify md step output for mlc without errors
       if: github.event.workflow_run.name == 'Markdown Link Check without errors'
       run: |
         $file = Get-Content ${{ github.workspace }}/.github/workflows/markdown-link-check-files/expected-file-outputs/without-errors/result.md  -Raw

MarkdownLinkCheckLogParser/.editorconfig

@@ -90,6 +90,7 @@ dotnet_diagnostic.CA1014.severity = none        # CA1014: Mark assemblies with C
 dotnet_diagnostic.CA1030.severity = silent      # CA1030: Use events where appropriate
 dotnet_diagnostic.CA1032.severity = none        # CA1032: Implement standard exception constructors
 # Globalization rules https://docs.microsoft.com/en-us/dotnet/fundamentals/code-analysis/quality-rules/globalization-warnings
+dotnet_diagnostic.CA1303.severity = none        # CA1303: Do not pass literals as localized parameters
 dotnet_diagnostic.CA1308.severity = none        # CA1308: Normalize strings to uppercase
 # Maintainability rules https://docs.microsoft.com/en-us/dotnet/fundamentals/code-analysis/quality-rules/maintainability-warnings
 dotnet_diagnostic.CA1508.severity = none        # CA1508: Avoid dead conditional code # This one seems to flag false positives in some cases

MarkdownLinkCheckLogParser/src/MarkdownLinkCheckLogParserCli/CliCommands/ParseLog/ParseLogCommand.cs

@@ -83,7 +83,7 @@ public async ValueTask ExecuteAsync(IConsole console)
             var outputMarkdownFilePath = new OutputMarkdownFilepathOption(OutputMarkdownFilepath);
             var outputFormats = OutputFormats.Create(outputOptions, _file, console, outputJsonFilePath, outputMarkdownFilePath);
 
-            using var httpClient = _httpClient ?? GitHubHttpClient.Create(authToken);
+            using var httpClient = _httpClient ?? GitHubHttpClient.CreateHttpClient(authToken);
             var gitHubHttpClient = new GitHubHttpClient(httpClient);
             var gitHubWorkflowRunLogs = new GitHubWorkflowRunLogs(gitHubHttpClient);
             var stepLog = await gitHubWorkflowRunLogs.GetStepLogAsync(repo, runId, jobName, stepName);

MarkdownLinkCheckLogParser/src/MarkdownLinkCheckLogParserCli/GitHub/GitHubHttpClient.cs

@@ -9,7 +9,7 @@ public GitHubHttpClient(HttpClient httpClient)
         _httpClient = httpClient.NotNull();
     }
 
-    public static HttpClient Create(GitHubAuthToken authToken)
+    public static HttpClient CreateHttpClient(GitHubAuthToken authToken)
     {
         authToken.NotNull();
         var httpClient = new HttpClient
@@ -18,7 +18,7 @@ public static HttpClient Create(GitHubAuthToken authToken)
         };
         httpClient.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("token", authToken);
         httpClient.DefaultRequestHeaders.TryAddWithoutValidation("Accept", "application/vnd.github.v3+json");
-        httpClient.DefaultRequestHeaders.TryAddWithoutValidation("User-Agent", "markdown-link-check-log-parser");
+        httpClient.DefaultRequestHeaders.TryAddWithoutValidation("User-Agent", "edumserrano/markdown-link-check-log-parser");
         return httpClient;
     }
 

MarkdownLinkCheckLogParser/src/MarkdownLinkCheckLogParserCli/GitHub/Types/GitHubJobName.cs

@@ -4,14 +4,14 @@ internal sealed class GitHubJobName
 {
     private readonly string _value;
 
-    public GitHubJobName(string gitHubJobName)
+    public GitHubJobName(string jobName)
     {
-        _value = gitHubJobName.NotNullOrWhiteSpace();
+        _value = jobName.NotNullOrWhiteSpace();
     }
 
-    public static implicit operator string(GitHubJobName gitHubAuthToken)
+    public static implicit operator string(GitHubJobName jobName)
     {
-        return gitHubAuthToken._value;
+        return jobName._value;
     }
 
     public override string ToString() => (string)this;

MarkdownLinkCheckLogParser/src/MarkdownLinkCheckLogParserCli/GitHub/Types/GitHubRepository.cs

@@ -4,14 +4,14 @@ internal sealed class GitHubRepository
 {
     private readonly string _value;
 
-    public GitHubRepository(string gitHubRepository)
+    public GitHubRepository(string repository)
     {
-        _value = gitHubRepository.NotNullOrWhiteSpace();
+        _value = repository.NotNullOrWhiteSpace();
     }
 
-    public static implicit operator string(GitHubRepository gitHubAuthToken)
+    public static implicit operator string(GitHubRepository repository)
     {
-        return gitHubAuthToken._value;
+        return repository._value;
     }
 
     public override string ToString() => (string)this;

MarkdownLinkCheckLogParser/src/MarkdownLinkCheckLogParserCli/GitHub/Types/GitHubRunId.cs

@@ -4,14 +4,14 @@ internal sealed class GitHubRunId
 {
     private readonly string _value;
 
-    public GitHubRunId(string gitHubRunId)
+    public GitHubRunId(string runId)
     {
-        _value = gitHubRunId.NotNullOrWhiteSpace();
+        _value = runId.NotNullOrWhiteSpace();
     }
 
-    public static implicit operator string(GitHubRunId gitHubAuthToken)
+    public static implicit operator string(GitHubRunId rundId)
     {
-        return gitHubAuthToken._value;
+        return rundId._value;
     }
 
     public override string ToString() => (string)this;

MarkdownLinkCheckLogParser/src/MarkdownLinkCheckLogParserCli/GitHub/Types/GitHubStepName.cs

@@ -4,14 +4,14 @@ internal sealed class GitHubStepName
 {
     private readonly string _value;
 
-    public GitHubStepName(string gitHubStepName)
+    public GitHubStepName(string stepName)
     {
-        _value = gitHubStepName.NotNullOrWhiteSpace();
+        _value = stepName.NotNullOrWhiteSpace();
     }
 
-    public static implicit operator string(GitHubStepName gitHubAuthToken)
+    public static implicit operator string(GitHubStepName stepaName)
     {
-        return gitHubAuthToken._value;
+        return stepaName._value;
     }
 
     public override string ToString() => (string)this;

MarkdownLinkCheckLogParser/src/MarkdownLinkCheckLogParserCli/MarkdownLinkCheck/LogLines/IMarkdownLinkCheckLogLine.cs

@@ -1,5 +1,8 @@
 namespace MarkdownLinkCheckLogParserCli.MarkdownLinkCheck.LogLines;
 
+// This is part of the Visitor pattern implement to handle the parsing of each log line of the mlc output
+// This interface would be equivalent to the IComponent in this example https://refactoring.guru/design-patterns/visitor/csharp/example
+// Also, the Handle method in this interface is equivalent to the Accept method in the IComponent interface
 internal interface IMarkdownLinkCheckLogLine
 {
     void Handle(ParserState state);

MarkdownLinkCheckLogParser/src/MarkdownLinkCheckLogParserCli/MarkdownLinkCheck/MarkdownFileCheck.cs

@@ -18,7 +18,7 @@ public MarkdownFileCheck(string filename)
 
     public bool HasErrors => ErrorCount > 0;
 
-    public IReadOnlyList<MarkdownLinkError> Errors => _errors;
+    public IReadOnlyList<MarkdownLinkError> Errors => _errors.OrderBy(x => x.Link).ToList();
 
     internal void AddError(string link, int statusCode)
     {