Merge pull request dotnet#1044 from jmarolf/feature/add-binlog-command

JoeRobich · Mar 12, 2021 · 6e45e79 · 6e45e79
2 parents 594ec0a + 55270ae
commit 6e45e79
Show file tree

Hide file tree

Showing 22 changed files with 229 additions and 16 deletions.
diff --git a/src/CodeFormatter.cs b/src/CodeFormatter.cs
@@ -32,7 +32,7 @@ internal static class CodeFormatter
             FormatOptions formatOptions,
             ILogger logger,
             CancellationToken cancellationToken,
-            bool createBinaryLog = false)
+            string? binaryLogPath = null)
         {
             var logWorkspaceWarnings = formatOptions.LogLevel == LogLevel.Trace;
 
@@ -44,7 +44,7 @@ internal static class CodeFormatter
 
             using var workspace = formatOptions.WorkspaceType == WorkspaceType.Folder
                 ? OpenFolderWorkspace(formatOptions.WorkspaceFilePath, formatOptions.FileMatcher)
-                : await OpenMSBuildWorkspaceAsync(formatOptions.WorkspaceFilePath, formatOptions.WorkspaceType, createBinaryLog, logWorkspaceWarnings, logger, cancellationToken).ConfigureAwait(false);
+                : await OpenMSBuildWorkspaceAsync(formatOptions.WorkspaceFilePath, formatOptions.WorkspaceType, binaryLogPath, logWorkspaceWarnings, logger, cancellationToken).ConfigureAwait(false);
 
             if (workspace is null)
             {
@@ -123,12 +123,12 @@ private static Workspace OpenFolderWorkspace(string workspacePath, SourceFileMat
         private static Task<Workspace?> OpenMSBuildWorkspaceAsync(
             string solutionOrProjectPath,
             WorkspaceType workspaceType,
-            bool createBinaryLog,
+            string? binaryLogPath,
             bool logWorkspaceWarnings,
             ILogger logger,
             CancellationToken cancellationToken)
         {
-            return MSBuildWorkspaceLoader.LoadAsync(solutionOrProjectPath, workspaceType, createBinaryLog, logWorkspaceWarnings, logger, cancellationToken);
+            return MSBuildWorkspaceLoader.LoadAsync(solutionOrProjectPath, workspaceType, binaryLogPath, logWorkspaceWarnings, logger, cancellationToken);
         }
 
         private static async Task<Solution> RunCodeFormattersAsync(

diff --git a/src/FormatCommand.cs b/src/FormatCommand.cs
@@ -10,7 +10,7 @@ namespace Microsoft.CodeAnalysis.Tools
 {
     internal static class FormatCommand
     {
-        // This delegate should be kept in Sync with the FormatCommand options and arguement names
+        // This delegate should be kept in Sync with the FormatCommand options and argument names
         // so that values bind correctly.
         internal delegate Task<int> Handler(
             string? workspace,
@@ -25,6 +25,7 @@ internal static class FormatCommand
             string[] exclude,
             string? report,
             bool includeGenerated,
+            string? binarylog,
             IConsole console);
 
         internal static string[] VerbosityLevels => new[] { "q", "quiet", "m", "minimal", "n", "normal", "d", "detailed", "diag", "diagnostic" };
@@ -75,11 +76,16 @@ internal static RootCommand CreateCommandLineOptions()
                 {
                     IsHidden = true
                 },
+                new Option(new[] { "--binarylog" }, Resources.Log_all_project_or_solution_load_information_to_a_binary_log_file)
+                {
+                    Argument = new Argument<string?>(() => null) { Name = "binary-log-path", Arity = ArgumentArity.ZeroOrOne }.LegalFilePathsOnly()
+                },
             };
 
             rootCommand.Description = "dotnet-format";
             rootCommand.AddValidator(EnsureFolderNotSpecifiedWhenFixingStyle);
             rootCommand.AddValidator(EnsureFolderNotSpecifiedWhenFixingAnalyzers);
+            rootCommand.AddValidator(EnsureFolderNotSpecifiedWhenLoggingBinlog);
 
             return rootCommand;
         }
@@ -102,6 +108,15 @@ internal static RootCommand CreateCommandLineOptions()
                 : null;
         }
 
+        internal static string? EnsureFolderNotSpecifiedWhenLoggingBinlog(CommandResult symbolResult)
+        {
+            var folder = symbolResult.ValueForOption<bool>("--folder");
+            var binarylog = symbolResult.OptionResult("--binarylog");
+            return folder && binarylog is not null && !binarylog.IsImplicit
+                ? Resources.Cannot_specify_the_folder_option_when_writing_a_binary_log
+                : null;
+        }
+
         internal static bool WasOptionUsed(this ParseResult result, params string[] aliases)
         {
             return result.Tokens

diff --git a/src/Program.cs b/src/Program.cs
@@ -12,6 +12,7 @@
 using System.Text;
 using System.Threading;
 using System.Threading.Tasks;
+
 using Microsoft.CodeAnalysis.Tools.Logging;
 using Microsoft.CodeAnalysis.Tools.MSBuild;
 using Microsoft.CodeAnalysis.Tools.Utilities;
@@ -55,6 +56,7 @@ private static async Task<int> Main(string[] args)
             string[] exclude,
             string? report,
             bool includeGenerated,
+            string? binarylog,
             IConsole console = null!)
         {
             if (s_parseResult == null)
@@ -182,9 +184,28 @@ private static async Task<int> Main(string[] args)
                     formatOptions,
                     logger,
                     cancellationTokenSource.Token,
-                    createBinaryLog: logLevel == LogLevel.Trace).ConfigureAwait(false);
+                    binaryLogPath: GetBinaryLogPath(s_parseResult, binarylog)).ConfigureAwait(false);
 
                 return GetExitCode(formatResult, check);
+
+                static string? GetBinaryLogPath(ParseResult parseResult, string? binarylog)
+                {
+                    if (parseResult.WasOptionUsed("--binarylog"))
+                    {
+                        if (binarylog is null)
+                        {
+                            return Path.Combine(Directory.GetCurrentDirectory(), "format.binlog");
+                        }
+                        else if (Path.GetExtension(binarylog)?.Equals(".binlog") == false)
+                        {
+                            return Path.ChangeExtension(binarylog, ".binlog");
+                        }
+
+                        return binarylog;
+                    }
+
+                    return null;
+                }
             }
             catch (FileNotFoundException fex)
             {

diff --git a/src/Resources.resx b/src/Resources.resx
@@ -1,4 +1,4 @@
-<?xml version="1.0" encoding="utf-8"?>
+<?xml version="1.0" encoding="utf-8"?>
 <root>
   <!--
     Microsoft ResX Schema
@@ -321,4 +321,10 @@
   <data name="Replace_0_characters_with_1" xml:space="preserve">
     <value>Replace {0} characters with '{1}'.</value>
   </data>
+  <data name="Log_all_project_or_solution_load_information_to_a_binary_log_file" xml:space="preserve">
+    <value>Log all project or solution load information to a binary log file.</value>
+  </data>
+  <data name="Cannot_specify_the_folder_option_when_writing_a_binary_log" xml:space="preserve">
+    <value>Cannot specify the '--folder' option when writing a binary log.</value>
+  </data>
 </root>
diff --git a/src/Workspaces/MSBuildWorkspaceLoader.cs b/src/Workspaces/MSBuildWorkspaceLoader.cs
@@ -3,7 +3,6 @@
 using System;
 using System.Collections.Generic;
 using System.Collections.Immutable;
-using System.IO;
 using System.Threading;
 using System.Threading.Tasks;
 using Microsoft.CodeAnalysis.MSBuild;
@@ -19,7 +18,7 @@ internal static class MSBuildWorkspaceLoader
         public static async Task<Workspace?> LoadAsync(
             string solutionOrProjectPath,
             WorkspaceType workspaceType,
-            bool createBinaryLog,
+            string? binaryLogPath,
             bool logWorkspaceWarnings,
             ILogger logger,
             CancellationToken cancellationToken)
@@ -35,11 +34,11 @@ internal static class MSBuildWorkspaceLoader
             var workspace = MSBuildWorkspace.Create(properties);
 
             Build.Framework.ILogger? binlog = null;
-            if (createBinaryLog)
+            if (binaryLogPath is not null)
             {
                 binlog = new Build.Logging.BinaryLogger()
                 {
-                    Parameters = Path.Combine(Environment.CurrentDirectory, "formatDiagnosticLog.binlog"),
+                    Parameters = binaryLogPath,
                     Verbosity = Build.Framework.LoggerVerbosity.Diagnostic,
                 };
             }
@@ -98,15 +97,15 @@ static void LogWorkspaceDiagnostics(ILogger logger, bool logWorkspaceWarnings, I
         internal static async Task<Workspace?> LockedLoadAsync(
             string solutionOrProjectPath,
             WorkspaceType workspaceType,
-            bool createBinaryLog,
+            string? binaryLogPath,
             bool logWorkspaceWarnings,
             ILogger logger,
             CancellationToken cancellationToken)
         {
             await Guard.WaitAsync();
             try
             {
-                return await LoadAsync(solutionOrProjectPath, workspaceType, createBinaryLog, logWorkspaceWarnings, logger, cancellationToken);
+                return await LoadAsync(solutionOrProjectPath, workspaceType, binaryLogPath, logWorkspaceWarnings, logger, cancellationToken);
             }
             finally
             {

diff --git a/src/dotnet-format.csproj b/src/dotnet-format.csproj
@@ -3,7 +3,7 @@
   <PropertyGroup>
     <TargetFramework>netcoreapp2.1</TargetFramework>
     <OutputType>Exe</OutputType>
-    <LangVersion>8.0</LangVersion>
+    <LangVersion>9.0</LangVersion>
     <AllowUnsafeBlocks>true</AllowUnsafeBlocks>
     <RootNamespace>Microsoft.CodeAnalysis.Tools</RootNamespace>
     <ServerGarbageCollection>true</ServerGarbageCollection>

diff --git a/src/xlf/Resources.cs.xlf b/src/xlf/Resources.cs.xlf
@@ -52,6 +52,11 @@
         <target state="new">Cannot specify the '--folder' option when running analyzers.</target>
         <note />
       </trans-unit>
+      <trans-unit id="Cannot_specify_the_folder_option_when_writing_a_binary_log">
+        <source>Cannot specify the '--folder' option when writing a binary log.</source>
+        <target state="new">Cannot specify the '--folder' option when writing a binary log.</target>
+        <note />
+      </trans-unit>
       <trans-unit id="Code_Style">
         <source>Code Style</source>
         <target state="translated">Styl kódu</target>
@@ -167,6 +172,11 @@
         <target state="translated">Načítá se pracovní prostor.</target>
         <note />
       </trans-unit>
+      <trans-unit id="Log_all_project_or_solution_load_information_to_a_binary_log_file">
+        <source>Log all project or solution load information to a binary log file.</source>
+        <target state="new">Log all project or solution load information to a binary log file.</target>
+        <note />
+      </trans-unit>
       <trans-unit id="Multiple_MSBuild_project_files_found_in_0_Specify_which_to_use_with_the_workspace_argument">
         <source>Multiple MSBuild project files found in '{0}'. Specify which to use with the &lt;workspace&gt; argument.</source>
         <target state="translated">{0} obsahuje více souborů projektů MSBuild. Určete, který soubor chcete použít, pomocí argumentu &lt;workspace&gt;.</target>

diff --git a/src/xlf/Resources.de.xlf b/src/xlf/Resources.de.xlf
@@ -52,6 +52,11 @@
         <target state="new">Cannot specify the '--folder' option when running analyzers.</target>
         <note />
       </trans-unit>
+      <trans-unit id="Cannot_specify_the_folder_option_when_writing_a_binary_log">
+        <source>Cannot specify the '--folder' option when writing a binary log.</source>
+        <target state="new">Cannot specify the '--folder' option when writing a binary log.</target>
+        <note />
+      </trans-unit>
       <trans-unit id="Code_Style">
         <source>Code Style</source>
         <target state="translated">Codeformat</target>
@@ -167,6 +172,11 @@
         <target state="translated">Arbeitsbereich wird geladen.</target>
         <note />
       </trans-unit>
+      <trans-unit id="Log_all_project_or_solution_load_information_to_a_binary_log_file">
+        <source>Log all project or solution load information to a binary log file.</source>
+        <target state="new">Log all project or solution load information to a binary log file.</target>
+        <note />
+      </trans-unit>
       <trans-unit id="Multiple_MSBuild_project_files_found_in_0_Specify_which_to_use_with_the_workspace_argument">
         <source>Multiple MSBuild project files found in '{0}'. Specify which to use with the &lt;workspace&gt; argument.</source>
         <target state="translated">In "{0}" wurden mehrere MSBuild-Projektdateien gefunden. Geben Sie die zu verwendende Datei mit dem &lt;workspace&gt;-Argument an.</target>

diff --git a/src/xlf/Resources.es.xlf b/src/xlf/Resources.es.xlf
@@ -52,6 +52,11 @@
         <target state="new">Cannot specify the '--folder' option when running analyzers.</target>
         <note />
       </trans-unit>
+      <trans-unit id="Cannot_specify_the_folder_option_when_writing_a_binary_log">
+        <source>Cannot specify the '--folder' option when writing a binary log.</source>
+        <target state="new">Cannot specify the '--folder' option when writing a binary log.</target>
+        <note />
+      </trans-unit>
       <trans-unit id="Code_Style">
         <source>Code Style</source>
         <target state="translated">Estilo de código</target>
@@ -167,6 +172,11 @@
         <target state="translated">Cargando área de trabajo.</target>
         <note />
       </trans-unit>
+      <trans-unit id="Log_all_project_or_solution_load_information_to_a_binary_log_file">
+        <source>Log all project or solution load information to a binary log file.</source>
+        <target state="new">Log all project or solution load information to a binary log file.</target>
+        <note />
+      </trans-unit>
       <trans-unit id="Multiple_MSBuild_project_files_found_in_0_Specify_which_to_use_with_the_workspace_argument">
         <source>Multiple MSBuild project files found in '{0}'. Specify which to use with the &lt;workspace&gt; argument.</source>
         <target state="translated">Se encontraron varios archivos del proyecto MSBuild en "{0}". Especifique cuál debe usarse con el argumento &lt;workspace&gt;.</target>

diff --git a/src/xlf/Resources.fr.xlf b/src/xlf/Resources.fr.xlf
@@ -52,6 +52,11 @@
         <target state="new">Cannot specify the '--folder' option when running analyzers.</target>
         <note />
       </trans-unit>
+      <trans-unit id="Cannot_specify_the_folder_option_when_writing_a_binary_log">
+        <source>Cannot specify the '--folder' option when writing a binary log.</source>
+        <target state="new">Cannot specify the '--folder' option when writing a binary log.</target>
+        <note />
+      </trans-unit>
       <trans-unit id="Code_Style">
         <source>Code Style</source>
         <target state="translated">Style de code</target>
@@ -167,6 +172,11 @@
         <target state="translated">Chargement de l'espace de travail.</target>
         <note />
       </trans-unit>
+      <trans-unit id="Log_all_project_or_solution_load_information_to_a_binary_log_file">
+        <source>Log all project or solution load information to a binary log file.</source>
+        <target state="new">Log all project or solution load information to a binary log file.</target>
+        <note />
+      </trans-unit>
       <trans-unit id="Multiple_MSBuild_project_files_found_in_0_Specify_which_to_use_with_the_workspace_argument">
         <source>Multiple MSBuild project files found in '{0}'. Specify which to use with the &lt;workspace&gt; argument.</source>
         <target state="translated">Plusieurs fichiers projet MSBuild trouvés dans '{0}'. Spécifiez celui qui doit être utilisé avec l'argument &lt;espace de travail&gt;.</target>

diff --git a/src/xlf/Resources.it.xlf b/src/xlf/Resources.it.xlf
@@ -52,6 +52,11 @@
         <target state="new">Cannot specify the '--folder' option when running analyzers.</target>
         <note />
       </trans-unit>
+      <trans-unit id="Cannot_specify_the_folder_option_when_writing_a_binary_log">
+        <source>Cannot specify the '--folder' option when writing a binary log.</source>
+        <target state="new">Cannot specify the '--folder' option when writing a binary log.</target>
+        <note />
+      </trans-unit>
       <trans-unit id="Code_Style">
         <source>Code Style</source>
         <target state="translated">Stile codice</target>
@@ -167,6 +172,11 @@
         <target state="translated">Caricamento dell'area di lavoro.</target>
         <note />
       </trans-unit>
+      <trans-unit id="Log_all_project_or_solution_load_information_to_a_binary_log_file">
+        <source>Log all project or solution load information to a binary log file.</source>
+        <target state="new">Log all project or solution load information to a binary log file.</target>
+        <note />
+      </trans-unit>
       <trans-unit id="Multiple_MSBuild_project_files_found_in_0_Specify_which_to_use_with_the_workspace_argument">
         <source>Multiple MSBuild project files found in '{0}'. Specify which to use with the &lt;workspace&gt; argument.</source>
         <target state="translated">In '{0}' sono stati trovati più file di progetto MSBuild. Per specificare quello desiderato, usare l'argomento &lt;workspace&gt;.</target>

diff --git a/src/xlf/Resources.ja.xlf b/src/xlf/Resources.ja.xlf
@@ -52,6 +52,11 @@
         <target state="new">Cannot specify the '--folder' option when running analyzers.</target>
         <note />
       </trans-unit>
+      <trans-unit id="Cannot_specify_the_folder_option_when_writing_a_binary_log">
+        <source>Cannot specify the '--folder' option when writing a binary log.</source>
+        <target state="new">Cannot specify the '--folder' option when writing a binary log.</target>
+        <note />
+      </trans-unit>
       <trans-unit id="Code_Style">
         <source>Code Style</source>
         <target state="translated">コード スタイル</target>
@@ -167,6 +172,11 @@
         <target state="translated">ワークスペースを読み込んでいます。</target>
         <note />
       </trans-unit>
+      <trans-unit id="Log_all_project_or_solution_load_information_to_a_binary_log_file">
+        <source>Log all project or solution load information to a binary log file.</source>
+        <target state="new">Log all project or solution load information to a binary log file.</target>
+        <note />
+      </trans-unit>
       <trans-unit id="Multiple_MSBuild_project_files_found_in_0_Specify_which_to_use_with_the_workspace_argument">
         <source>Multiple MSBuild project files found in '{0}'. Specify which to use with the &lt;workspace&gt; argument.</source>
         <target state="translated">複数の MSBuild プロジェクト ファイルが '{0}' で見つかりました。使用するものを &lt;workspace&gt; 引数で指定してください。</target>

diff --git a/src/xlf/Resources.ko.xlf b/src/xlf/Resources.ko.xlf
@@ -52,6 +52,11 @@
         <target state="new">Cannot specify the '--folder' option when running analyzers.</target>
         <note />
       </trans-unit>
+      <trans-unit id="Cannot_specify_the_folder_option_when_writing_a_binary_log">
+        <source>Cannot specify the '--folder' option when writing a binary log.</source>
+        <target state="new">Cannot specify the '--folder' option when writing a binary log.</target>
+        <note />
+      </trans-unit>
       <trans-unit id="Code_Style">
         <source>Code Style</source>
         <target state="translated">코드 스타일</target>
@@ -167,6 +172,11 @@
         <target state="translated">작업 영역을 로드하는 중입니다.</target>
         <note />
       </trans-unit>
+      <trans-unit id="Log_all_project_or_solution_load_information_to_a_binary_log_file">
+        <source>Log all project or solution load information to a binary log file.</source>
+        <target state="new">Log all project or solution load information to a binary log file.</target>
+        <note />
+      </trans-unit>
       <trans-unit id="Multiple_MSBuild_project_files_found_in_0_Specify_which_to_use_with_the_workspace_argument">
         <source>Multiple MSBuild project files found in '{0}'. Specify which to use with the &lt;workspace&gt; argument.</source>
         <target state="translated">'{0}'에 여러 MSBuild 프로젝트 파일이 있습니다. &lt;workspace&gt; 인수를 사용하여 사용할 파일을 지정하세요.</target>