|
| 1 | +using System.IO; |
| 2 | +using System.Linq; |
| 3 | +using Colorful; |
| 4 | +using Nuke.Common; |
| 5 | +using Nuke.Common.IO; |
| 6 | +using Nuke.Common.Tooling; |
| 7 | +using Nuke.Common.Tools.DotNet; |
| 8 | +using static Nuke.Common.Tools.DotNet.DotNetTasks; |
| 9 | +using static Nuke.Common.Tools.Git.GitTasks; |
| 10 | +using static Helpers; |
| 11 | +using System.Collections.Generic; |
| 12 | +using System.Threading.Tasks; |
| 13 | +using System.Text; |
| 14 | +using System; |
| 15 | +using System.Drawing; |
| 16 | + |
| 17 | +partial class Build : NukeBuild |
| 18 | +{ |
| 19 | + private readonly string _shippedApiFile = "PublicAPI.Shipped.txt"; |
| 20 | + private readonly string _unshippedApiFile = "PublicAPI.Unshipped.txt"; |
| 21 | + private readonly string _removedApiPrefix = "*REMOVED*"; |
| 22 | + |
| 23 | + [Parameter] readonly string From; |
| 24 | + [Parameter] readonly string To; |
| 25 | + [Parameter] readonly bool Breaking; |
| 26 | + |
| 27 | + Target CheckPublicApi => _ => _ |
| 28 | + .DependsOn(Restore) |
| 29 | + .Executes(() => |
| 30 | + { |
| 31 | + if (!InvokedTargets.Contains(Restore)) |
| 32 | + { |
| 33 | + DotNetBuildSonarSolution(AllSolutionFile); |
| 34 | + } |
| 35 | + |
| 36 | + DotNetBuild(c => c |
| 37 | + .SetProjectFile(AllSolutionFile) |
| 38 | + .SetNoRestore(InvokedTargets.Contains(Restore)) |
| 39 | + .SetConfiguration(Configuration) |
| 40 | + .SetProperty("RequireDocumentationOfPublicApiChanges", true)); |
| 41 | + }); |
| 42 | + |
| 43 | + Target AddUnshipped => _ => _ |
| 44 | + .DependsOn(Restore) |
| 45 | + .Executes(() => |
| 46 | + { |
| 47 | + // first we ensure that the All.sln exists. |
| 48 | + if (!InvokedTargets.Contains(Restore)) |
| 49 | + { |
| 50 | + DotNetBuildSonarSolution(AllSolutionFile); |
| 51 | + } |
| 52 | + |
| 53 | + // new we restore our local dotnet tools including dotnet-format |
| 54 | + DotNetToolRestore(c => c.SetProcessWorkingDirectory(RootDirectory)); |
| 55 | + |
| 56 | + // last we run the actual dotnet format command. |
| 57 | + DotNet($@"format ""{AllSolutionFile}"" --fix-analyzers warn --diagnostics RS0016", workingDirectory: RootDirectory); |
| 58 | + }); |
| 59 | + |
| 60 | + Target DiffShippedApi => _ => _ |
| 61 | + .Executes(() => |
| 62 | + { |
| 63 | + var from = string.IsNullOrEmpty(From) ? GitRepository.Branch : From; |
| 64 | + var to = string.IsNullOrEmpty(To) ? "main" : To; |
| 65 | + |
| 66 | + if (from == to) |
| 67 | + { |
| 68 | + Colorful.Console.WriteLine("Nothing to diff here.", Color.Yellow); |
| 69 | + return; |
| 70 | + } |
| 71 | + |
| 72 | + AbsolutePath shippedPath = SourceDirectory / "**" / _shippedApiFile; |
| 73 | + |
| 74 | + Git($@" --no-pager diff --minimal -U0 --word-diff ""{from}"" ""{to}"" -- ""{shippedPath}""", RootDirectory); |
| 75 | + }); |
| 76 | + |
| 77 | + Target DisplayUnshippedApi => _ => _ |
| 78 | + .Executes(async () => |
| 79 | + { |
| 80 | + var unshippedFiles = Directory.GetFiles(SourceDirectory, _unshippedApiFile, SearchOption.AllDirectories); |
| 81 | + |
| 82 | + if (Breaking) |
| 83 | + { |
| 84 | + Colorful.Console.WriteLine("Unshipped breaking changes:", Color.Red); |
| 85 | + } |
| 86 | + else |
| 87 | + { |
| 88 | + Colorful.Console.WriteLine("Unshipped changes:"); |
| 89 | + } |
| 90 | + |
| 91 | + Colorful.Console.WriteLine(); |
| 92 | + |
| 93 | + foreach (var unshippedFile in unshippedFiles) |
| 94 | + { |
| 95 | + IEnumerable<string> unshippedApis = await GetNonEmptyLinesAsync(unshippedFile); |
| 96 | + |
| 97 | + if (Breaking) |
| 98 | + { |
| 99 | + unshippedApis = unshippedApis.Where(u => u.StartsWith(_removedApiPrefix)).ToList(); |
| 100 | + } |
| 101 | + |
| 102 | + if (!unshippedApis.Any()) |
| 103 | + { |
| 104 | + continue; |
| 105 | + } |
| 106 | + |
| 107 | + foreach (var unshippedApi in unshippedApis) |
| 108 | + { |
| 109 | + if (unshippedApi.StartsWith(_removedApiPrefix)) |
| 110 | + { |
| 111 | + var value = unshippedApi[_removedApiPrefix.Length..]; |
| 112 | + Colorful.Console.WriteLine(value); |
| 113 | + } |
| 114 | + else |
| 115 | + { |
| 116 | + Colorful.Console.WriteLine(unshippedApi); |
| 117 | + } |
| 118 | + } |
| 119 | + } |
| 120 | + }); |
| 121 | + |
| 122 | + Target MarkApiShipped => _ => _ |
| 123 | + .Executes(async () => |
| 124 | + { |
| 125 | + var shippedFiles = Directory.GetFiles(SourceDirectory, _shippedApiFile, SearchOption.AllDirectories); |
| 126 | + |
| 127 | + foreach (var shippedFile in shippedFiles) |
| 128 | + { |
| 129 | + var projectDir = Path.GetDirectoryName(shippedFile); |
| 130 | + var unshippedFile = Path.Join(projectDir, _unshippedApiFile); |
| 131 | + |
| 132 | + if (!File.Exists(unshippedFile)) |
| 133 | + { |
| 134 | + continue; |
| 135 | + } |
| 136 | + |
| 137 | + List<string> unshippedApis = await GetNonEmptyLinesAsync(unshippedFile); |
| 138 | + |
| 139 | + if (!unshippedApis.Any()) |
| 140 | + { |
| 141 | + continue; |
| 142 | + } |
| 143 | + |
| 144 | + List<string> shippedApis = await GetNonEmptyLinesAsync(shippedFile); |
| 145 | + |
| 146 | + List<string> removedApis = new(); |
| 147 | + |
| 148 | + foreach (var unshippedApi in unshippedApis) |
| 149 | + { |
| 150 | + if (unshippedApi.StartsWith(_removedApiPrefix)) |
| 151 | + { |
| 152 | + var value = unshippedApi[_removedApiPrefix.Length..]; |
| 153 | + removedApis.Add(value); |
| 154 | + } |
| 155 | + else |
| 156 | + { |
| 157 | + shippedApis.Add(unshippedApi); |
| 158 | + } |
| 159 | + } |
| 160 | + |
| 161 | + IOrderedEnumerable<string> newShippedApis = shippedApis |
| 162 | + .Where(s => !removedApis.Contains(s)) |
| 163 | + .Distinct() |
| 164 | + .OrderBy(s => s); |
| 165 | + |
| 166 | + await File.WriteAllLinesAsync(shippedFile, newShippedApis, Encoding.ASCII); |
| 167 | + await File.WriteAllTextAsync(unshippedFile, "", Encoding.ASCII); |
| 168 | + } |
| 169 | + }); |
| 170 | + |
| 171 | + private static async Task<List<string>> GetNonEmptyLinesAsync(string filepath) |
| 172 | + { |
| 173 | + var lines = await File.ReadAllLinesAsync(filepath); |
| 174 | + |
| 175 | + return lines.Where(c => !string.IsNullOrWhiteSpace(c)).ToList(); |
| 176 | + } |
| 177 | +} |
0 commit comments