Bump version to 1.0.0

csharpier

Author: ChristianSauer

CodeQualityToGitlab/CodeQualityToGitlab.csproj

@@ -8,7 +8,7 @@
         <PackAsTool>true</PackAsTool>
         <ToolCommandName>cq</ToolCommandName>
         <PackageOutputPath>./nupkg</PackageOutputPath>
-        <Version>0.9.0</Version>
+        <Version>1.0.0</Version>
         <Company>codecentric</Company>
         <Copyright>(c) codecentric</Copyright>
         <PackageProjectUrl>https://github.com/codecentric/dotnet_gitlab_code_quality</PackageProjectUrl>

CodeQualityToGitlab/Common.cs

@@ -22,14 +22,11 @@ public static void WriteToDisk(FileInfo target, IEnumerable<CodeQuality> result)
         {
             WriteIndented = true,
             PropertyNamingPolicy = new LowerCaseNamingPolicy(),
-            Converters =
-            {
-                new JsonStringEnumConverter()
-            }
+            Converters = { new JsonStringEnumConverter() }
         };
         using var fileStream = File.Create(target.FullName);
         using var utf8JsonWriter = new Utf8JsonWriter(fileStream);
         JsonSerializer.Serialize(utf8JsonWriter, result, options);
         Log.Information("Result written to: {TargetFullName}", target.FullName);
     }
-}
+}

CodeQualityToGitlab/Merger.cs

@@ -14,16 +14,17 @@ public static void Merge(FileInfo[] sources, FileInfo target, bool bumpToMajor)
         {
             WriteIndented = true,
             PropertyNamingPolicy = new LowerCaseNamingPolicy(),
-            Converters ={
-                new JsonStringEnumConverter()
-            }
+            Converters = { new JsonStringEnumConverter() }
         };
 
         foreach (var source in sources)
         {
             if (!source.Exists)
             {
-                throw new FileNotFoundException($"The file '{source.FullName}' does not exist", source.FullName);
+                throw new FileNotFoundException(
+                    $"The file '{source.FullName}' does not exist",
+                    source.FullName
+                );
             }
 
             using var f = source.OpenRead();
@@ -33,7 +34,9 @@ public static void Merge(FileInfo[] sources, FileInfo target, bool bumpToMajor)
 
                 if (data == null)
                 {
-                    throw new ArgumentNullException($"could not deserialize content of {source.FullName}");
+                    throw new ArgumentNullException(
+                        $"could not deserialize content of {source.FullName}"
+                    );
                 }
                 result.AddRange(data);
             }
@@ -45,16 +48,17 @@ public static void Merge(FileInfo[] sources, FileInfo target, bool bumpToMajor)
         }
 
         result = result.DistinctBy(x => x.Fingerprint).ToList();
-        
+
         if (bumpToMajor)
         {
-            foreach (var cqr in result
-                         .Where(cqr => cqr.Severity is Severity.minor or Severity.info))
+            foreach (
+                var cqr in result.Where(cqr => cqr.Severity is Severity.minor or Severity.info)
+            )
             {
                 cqr.Severity = Severity.major;
             }
         }
-        
+
         Common.WriteToDisk(target, result);
     }
-}
+}

CodeQualityToGitlab/Program.cs

@@ -7,88 +7,113 @@ internal static class Program
 {
     private static async Task<int> Main(string[] args)
     {
-        Log.Logger = new LoggerConfiguration()
-            .WriteTo.Console()
-            .CreateLogger();
-        
+        Log.Logger = new LoggerConfiguration().WriteTo.Console().CreateLogger();
+
         var sourceArgument = new Argument<FileInfo>(
             name: "source",
             description: "The file to convert"
-            );
+        );
 
-        var targetArgument = new Argument<FileInfo>(
-            name: "target",
-            description: "The target file"
+        var targetArgument = new Argument<FileInfo>(name: "target", description: "The target file");
+
+        var bumpToMajorOption = new Option<bool>(
+            name: "--all_major",
+            "if true all info and minor issues are promoted to major for Gitlab"
         );
 
-        var bumpToMajorOption = new Option<bool>(name: "--all_major",
-            "if true all info and minor issues are promoted to major for Gitlab");
-        
         var rootPathArgument = new Argument<string?>(
             name: "root",
-            description: "The name root of the repository. Gitlab requires Code Quality issues to contain paths relative to the repository, " +
-                         "but the tools report them as absolute file paths. " +
-                         "Everything given in with this option will be removed. E.g. root is 'c:/dev' and the file name is something like 'c:/dev/myrepo/file.cs' it will transformed to 'myrepo/file.cs'. Can often be omitted. ",
+            description: "The name root of the repository. Gitlab requires Code Quality issues to contain paths relative to the repository, "
+                + "but the tools report them as absolute file paths. "
+                + "Everything given in with this option will be removed. E.g. root is 'c:/dev' and the file name is something like 'c:/dev/myrepo/file.cs' it will transformed to 'myrepo/file.cs'. Can often be omitted. ",
             getDefaultValue: () => null
         );
-        
+
         var rootCommand = new RootCommand("Tool to convert Dotnet-Formats to Gitlab code quality");
-        var roslynatorToCodeQuality = new Command("roslynator", "Convert Roslynator file to Code Quality issue")
+        var roslynatorToCodeQuality = new Command(
+            "roslynator",
+            "Convert Roslynator file to Code Quality issue"
+        )
         {
             sourceArgument,
             targetArgument,
             rootPathArgument
         };
-        
+
         var sarifToCodeQuality = new Command("sarif", "Convert Sarif files to Code Quality issue")
         {
             sourceArgument,
             targetArgument,
             rootPathArgument
         };
-        
+
         var sourcesArgument = new Argument<FileInfo[]>(
             name: "sources",
             description: "The files to merge"
         );
-        
-        var mergeCodeQuality = new Command("merge", "Merge multiple code quality files into one")    
+
+        var mergeCodeQuality = new Command("merge", "Merge multiple code quality files into one")
         {
             targetArgument,
             sourcesArgument,
             bumpToMajorOption
         };
-        
+
         var sourceGlobArgument = new Argument<string>(
             name: "sarifGlob",
             description: "Glob pattern for the sarif files",
             getDefaultValue: () => "**/*.sarif.json"
         );
-        
+
         var sourceRoslynatorArgument = new Argument<string>(
             name: "roslynatorGlob",
             description: "Glob pattern for the roslynator files",
             getDefaultValue: () => "**/roslynator.xml"
         );
-        
-        var transformCodeQuality = new Command("transform", "Transforms files from a glob mapping and merges them to one file")    
+
+        var transformCodeQuality = new Command(
+            "transform",
+            "Transforms files from a glob mapping and merges them to one file"
+        )
         {
             sourceGlobArgument,
             sourceRoslynatorArgument,
             targetArgument,
             rootPathArgument,
             bumpToMajorOption
         };
-        
-        roslynatorToCodeQuality.SetHandler(RoslynatorConverter.ConvertToCodeQuality, sourceArgument, targetArgument, rootPathArgument);
-        sarifToCodeQuality.SetHandler(SarifConverter.ConvertToCodeQuality, sourceArgument, targetArgument, rootPathArgument);
-        mergeCodeQuality.SetHandler(Merger.Merge, sourcesArgument, targetArgument, bumpToMajorOption);
-        transformCodeQuality.SetHandler(Transform.TransformAll, sourceGlobArgument, sourceRoslynatorArgument, targetArgument,rootPathArgument, bumpToMajorOption);
+
+        roslynatorToCodeQuality.SetHandler(
+            RoslynatorConverter.ConvertToCodeQuality,
+            sourceArgument,
+            targetArgument,
+            rootPathArgument
+        );
+        sarifToCodeQuality.SetHandler(
+            SarifConverter.ConvertToCodeQuality,
+            sourceArgument,
+            targetArgument,
+            rootPathArgument
+        );
+        mergeCodeQuality.SetHandler(
+            Merger.Merge,
+            sourcesArgument,
+            targetArgument,
+            bumpToMajorOption
+        );
+        transformCodeQuality.SetHandler(
+            Transform.TransformAll,
+            sourceGlobArgument,
+            sourceRoslynatorArgument,
+            targetArgument,
+            rootPathArgument,
+            bumpToMajorOption
+        );
         rootCommand.Add(roslynatorToCodeQuality);
         rootCommand.Add(sarifToCodeQuality);
         rootCommand.Add(mergeCodeQuality);
         rootCommand.Add(transformCodeQuality);
 
         return await rootCommand.InvokeAsync(args);
     }
-}
+}

CodeQualityToGitlab/RoslynatorConverter.cs

@@ -8,12 +8,13 @@ public static class RoslynatorConverter
 {
     public static List<CodeQuality> ConvertToCodeQualityRaw(FileInfo source, string? pathRoot)
     {
-        var serializer =
-            new XmlSerializer(typeof(Roslynator));
+        var serializer = new XmlSerializer(typeof(Roslynator));
 
         var result = new List<CodeQuality>();
         using Stream reader = new FileStream(source.FullName, FileMode.Open);
-        var roslynator = (Roslynator)(serializer.Deserialize(reader) ?? throw new ArgumentException("no data"));
+        var roslynator = (Roslynator)(
+            serializer.Deserialize(reader) ?? throw new ArgumentException("no data")
+        );
         foreach (var project in roslynator.CodeAnalysis.Projects.Project)
         {
             Log.Information("Working on {ProjectName}", project.Name);
@@ -27,7 +28,7 @@ public static List<CodeQuality> ConvertToCodeQualityRaw(FileInfo source, string?
                     Severity = GetSeverity(diagnostic.Severity),
                     Location = new LocationCq
                     {
-                        Path = GetPath(diagnostic, project, pathRoot), 
+                        Path = GetPath(diagnostic, project, pathRoot),
                         Lines = new Lines { Begin = lineNumber }
                     },
                     Fingerprint = Common.GetHash($"{project.Name}{diagnostic.Id}{lineNumber}")
@@ -39,7 +40,6 @@ public static List<CodeQuality> ConvertToCodeQualityRaw(FileInfo source, string?
 
         return result;
     }
-    
 
     public static void ConvertToCodeQuality(FileInfo source, FileInfo target, string? pathRoot)
     {
@@ -50,12 +50,12 @@ public static void ConvertToCodeQuality(FileInfo source, FileInfo target, string
     private static string GetPath(Diagnostic diagnostic, Project project, string? pathRoot)
     {
         var path = diagnostic.FilePath ?? project.FilePath;
-        
+
         if (string.IsNullOrWhiteSpace(pathRoot))
         {
             return path;
         }
-        
+
         var rv = path.Replace(pathRoot, "");
         return rv;
     }
@@ -73,13 +73,16 @@ private static Severity GetSeverity(string diagnosticSeverity)
             "Warning" => Severity.major,
             "Error" => Severity.critical,
             "Hidden" => Severity.minor,
-            _ => throw new ArgumentOutOfRangeException(diagnosticSeverity, $"unknown: {diagnosticSeverity}")
+            _
+                => throw new ArgumentOutOfRangeException(
+                    diagnosticSeverity,
+                    $"unknown: {diagnosticSeverity}"
+                )
         };
     }
 }
 
 public class LowerCaseNamingPolicy : JsonNamingPolicy
 {
-    public override string ConvertName(string name) =>
-        name.ToLower();
+    public override string ConvertName(string name) => name.ToLower();
 }

CodeQualityToGitlab/SarifConverter.cs

@@ -1,9 +1,9 @@
 namespace CodeQualityToGitlab;
 
-using Serilog;
 using Microsoft.CodeAnalysis.Sarif.Readers;
 using Microsoft.CodeAnalysis.Sarif.VersionOne;
 using Newtonsoft.Json;
+using Serilog;
 
 public static class SarifConverter
 {
@@ -23,8 +23,8 @@ public static List<CodeQuality> ConvertToCodeQualityRaw(FileInfo source, string?
             .SelectMany(x => x.Results)
             .Where(r => r.SuppressionStates == SuppressionStatesVersionOne.None);
 
-		var cqrs = new List<CodeQuality>();
-		foreach (var result in results)
+        var cqrs = new List<CodeQuality>();
+        foreach (var result in results)
         {
             var begin = result.Locations?.FirstOrDefault();
 
@@ -34,7 +34,7 @@ public static List<CodeQuality> ConvertToCodeQualityRaw(FileInfo source, string?
                 continue;
             }
 
-			try
+            try
             {
                 var cqr = new CodeQuality
                 {
@@ -45,7 +45,9 @@ public static List<CodeQuality> ConvertToCodeQualityRaw(FileInfo source, string?
                         Path = GetPath(pathRoot, begin),
                         Lines = new Lines { Begin = begin.ResultFile.Region.StartLine }
                     },
-                    Fingerprint = Common.GetHash($"{result.RuleId}|{begin.ResultFile.Uri}|{begin.ResultFile.Region.StartLine}")
+                    Fingerprint = Common.GetHash(
+                        $"{result.RuleId}|{begin.ResultFile.Uri}|{begin.ResultFile.Region.StartLine}"
+                    )
                 };
                 cqrs.Add(cqr);
             }
@@ -57,6 +59,7 @@ public static List<CodeQuality> ConvertToCodeQualityRaw(FileInfo source, string?
 
         return cqrs;
     }
+
     public static void ConvertToCodeQuality(FileInfo source, FileInfo target, string? pathRoot)
     {
         var cqrs = ConvertToCodeQualityRaw(source, pathRoot);
@@ -68,7 +71,10 @@ private static string GetPath(string? pathRoot, LocationVersionOne begin)
         // nullability says Uri is always set, but there are tools which omit this.
         if (begin.ResultFile.Uri == null)
         {
-            Log.Error("There is no valid Path for the issue {@Region}, cannot create a path. Check the source sarif for missing physicalLocation.uri", begin.ResultFile.Region);
+            Log.Error(
+                "There is no valid Path for the issue {@Region}, cannot create a path. Check the source sarif for missing physicalLocation.uri",
+                begin.ResultFile.Region
+            );
             return "noPathInSourceSarif";
         }
 
@@ -98,4 +104,4 @@ private static Severity GetSeverity(ResultLevelVersionOne resultLevel)
             _ => throw new ArgumentOutOfRangeException(nameof(resultLevel), resultLevel, null)
         };
     }
-}
+}