Merge pull request #673 from JoeRobich/include-generated

Add option to format generated code files.
dotnet · May 12, 2020 · 9a8a070 · 9a8a070
2 parents f52ee3e + cf21c70
commit 9a8a070
Show file tree

Hide file tree

Showing 23 changed files with 151 additions and 22 deletions.
diff --git a/perf/FormattedFiles.cs b/perf/FormattedFiles.cs
@@ -37,7 +37,8 @@ public void FilesFormattedFolder()
                 saveFormattedFiles: false,
                 changesAreErrors: false,
                 AllFileMatcher,
-                reportPath: string.Empty);
+                reportPath: string.Empty,
+                includeGeneratedFiles: false);
             _ = CodeFormatter.FormatWorkspaceAsync(options, EmptyLogger, default).GetAwaiter().GetResult();
         }
 
@@ -52,7 +53,8 @@ public void FilesFormattedProject()
                 saveFormattedFiles: false,
                 changesAreErrors: false,
                 AllFileMatcher,
-                reportPath: string.Empty);
+                reportPath: string.Empty,
+                includeGeneratedFiles: false);
             _ = CodeFormatter.FormatWorkspaceAsync(options, EmptyLogger, default).GetAwaiter().GetResult();
         }
 
@@ -67,7 +69,8 @@ public void FilesFormattedSolution()
                 saveFormattedFiles: false,
                 changesAreErrors: false,
                 AllFileMatcher,
-                reportPath: string.Empty);
+                reportPath: string.Empty,
+                includeGeneratedFiles: false);
             _ = CodeFormatter.FormatWorkspaceAsync(options, EmptyLogger, default).GetAwaiter().GetResult();
         }
 

diff --git a/perf/NoFilesFormatted.cs b/perf/NoFilesFormatted.cs
@@ -37,7 +37,8 @@ public void NoFilesFormattedFolder()
                 saveFormattedFiles: false,
                 changesAreErrors: false,
                 AllFileMatcher,
-                reportPath: string.Empty);
+                reportPath: string.Empty,
+                includeGeneratedFiles: false);
             _ = CodeFormatter.FormatWorkspaceAsync(options, EmptyLogger, default).GetAwaiter().GetResult();
         }
 
@@ -52,7 +53,8 @@ public void NoFilesFormattedProject()
                 saveFormattedFiles: false,
                 changesAreErrors: false,
                 AllFileMatcher,
-                reportPath: string.Empty);
+                reportPath: string.Empty,
+                includeGeneratedFiles: false);
             _ = CodeFormatter.FormatWorkspaceAsync(options, EmptyLogger, default).GetAwaiter().GetResult();
         }
 
@@ -67,7 +69,8 @@ public void NoFilesFormattedSolution()
                 saveFormattedFiles: false,
                 changesAreErrors: false,
                 AllFileMatcher,
-                reportPath: string.Empty);
+                reportPath: string.Empty,
+                includeGeneratedFiles: false);
             _ = CodeFormatter.FormatWorkspaceAsync(options, EmptyLogger, default).GetAwaiter().GetResult();
         }
 

diff --git a/perf/RealWorldSolution.cs b/perf/RealWorldSolution.cs
@@ -39,7 +39,8 @@ public void FilesFormattedSolution()
                 saveFormattedFiles: false,
                 changesAreErrors: false,
                 AllFileMatcher,
-                reportPath: string.Empty);
+                reportPath: string.Empty,
+                includeGeneratedFiles: false);
             _ = CodeFormatter.FormatWorkspaceAsync(options, EmptyLogger, default).GetAwaiter().GetResult();
         }
 
@@ -54,7 +55,8 @@ public void FilesFormattedFolder()
                 saveFormattedFiles: false,
                 changesAreErrors: false,
                 AllFileMatcher,
-                reportPath: string.Empty);
+                reportPath: string.Empty,
+                includeGeneratedFiles: false);
             _ = CodeFormatter.FormatWorkspaceAsync(options, EmptyLogger, default).GetAwaiter().GetResult();
         }
 

diff --git a/src/CodeFormatter.cs b/src/CodeFormatter.cs
@@ -37,7 +37,7 @@ internal static class CodeFormatter
             CancellationToken cancellationToken,
             bool createBinaryLog = false)
         {
-            var (workspaceFilePath, workspaceType, logLevel, saveFormattedFiles, _, fileMatcher, reportPath) = options;
+            var (workspaceFilePath, workspaceType, logLevel, saveFormattedFiles, _, fileMatcher, reportPath, includeGeneratedFiles) = options;
             var logWorkspaceWarnings = logLevel == LogLevel.Trace;
 
             logger.LogInformation(string.Format(Resources.Formatting_code_files_in_workspace_0, workspaceFilePath));
@@ -62,7 +62,7 @@ internal static class CodeFormatter
             logger.LogTrace(Resources.Determining_formattable_files);
 
             var (fileCount, formatableFiles) = await DetermineFormattableFiles(
-                solution, projectPath, fileMatcher, logger, cancellationToken).ConfigureAwait(false);
+                solution, projectPath, fileMatcher, includeGeneratedFiles, logger, cancellationToken).ConfigureAwait(false);
 
             var determineFilesMS = workspaceStopwatch.ElapsedMilliseconds - loadWorkspaceMS;
             logger.LogTrace(Resources.Complete_in_0_ms, determineFilesMS);
@@ -264,6 +264,7 @@ private static void LogWorkspaceDiagnostics(ILogger logger, bool logWorkspaceWar
             Solution solution,
             string projectPath,
             Matcher fileMatcher,
+            bool includeGeneratedFiles,
             ILogger logger,
             CancellationToken cancellationToken)
         {
@@ -296,7 +297,7 @@ private static void LogWorkspaceDiagnostics(ILogger logger, bool logWorkspaceWar
 
                 // Get project documents and options with .editorconfig settings applied.
                 var getProjectDocuments = project.DocumentIds.Select(documentId => GetDocumentAndOptions(
-                    project, documentId, fileMatcher, codingConventionsManager, optionsApplier, cancellationToken));
+                    project, documentId, fileMatcher, includeGeneratedFiles, codingConventionsManager, optionsApplier, cancellationToken));
                 getDocumentsAndOptions.AddRange(getProjectDocuments);
             }
 
@@ -335,13 +336,14 @@ private static void LogWorkspaceDiagnostics(ILogger logger, bool logWorkspaceWar
             Project project,
             DocumentId documentId,
             Matcher fileMatcher,
+            bool includeGeneratedFiles,
             ICodingConventionsManager codingConventionsManager,
             EditorConfigOptionsApplier optionsApplier,
             CancellationToken cancellationToken)
         {
             var document = project.Solution.GetDocument(documentId);
 
-            if (document is null || await ShouldIgnoreDocument(document, fileMatcher, cancellationToken))
+            if (document is null || await ShouldIgnoreDocument(document, fileMatcher, includeGeneratedFiles, cancellationToken))
             {
                 return (null, null, null, false);
             }
@@ -364,6 +366,7 @@ private static void LogWorkspaceDiagnostics(ILogger logger, bool logWorkspaceWar
         private static async Task<bool> ShouldIgnoreDocument(
             Document document,
             Matcher fileMatcher,
+            bool includeGeneratedFiles,
             CancellationToken cancellationToken)
         {
             if (!fileMatcher.Match(document.FilePath).HasMatches)
@@ -375,7 +378,7 @@ private static void LogWorkspaceDiagnostics(ILogger logger, bool logWorkspaceWar
             {
                 return true;
             }
-            else if (await GeneratedCodeUtilities.IsGeneratedCodeAsync(document, cancellationToken).ConfigureAwait(false))
+            else if (!includeGeneratedFiles && await GeneratedCodeUtilities.IsGeneratedCodeAsync(document, cancellationToken).ConfigureAwait(false))
             {
                 // Ignore generated code files.
                 return true;

diff --git a/src/FormatOptions.cs b/src/FormatOptions.cs
@@ -14,6 +14,7 @@ internal class FormatOptions
         public bool ChangesAreErrors { get; }
         public Matcher FileMatcher { get; }
         public string? ReportPath { get; }
+        public bool IncludeGeneratedFiles { get; }
 
         public FormatOptions(
             string workspaceFilePath,
@@ -22,7 +23,8 @@ internal class FormatOptions
             bool saveFormattedFiles,
             bool changesAreErrors,
             Matcher fileMatcher,
-            string? reportPath)
+            string? reportPath,
+            bool includeGeneratedFiles)
         {
             WorkspaceFilePath = workspaceFilePath;
             WorkspaceType = workspaceType;
@@ -31,6 +33,7 @@ internal class FormatOptions
             ChangesAreErrors = changesAreErrors;
             FileMatcher = fileMatcher;
             ReportPath = reportPath;
+            IncludeGeneratedFiles = includeGeneratedFiles;
         }
 
         public void Deconstruct(
@@ -40,7 +43,8 @@ internal class FormatOptions
             out bool saveFormattedFiles,
             out bool changesAreErrors,
             out Matcher fileMatcher,
-            out string? reportPath)
+            out string? reportPath,
+            out bool includeGeneratedFiles)
         {
             workspaceFilePath = WorkspaceFilePath;
             workspaceType = WorkspaceType;
@@ -49,6 +53,7 @@ internal class FormatOptions
             changesAreErrors = ChangesAreErrors;
             fileMatcher = FileMatcher;
             reportPath = ReportPath;
+            includeGeneratedFiles = IncludeGeneratedFiles;
         }
     }
 }
diff --git a/src/Program.cs b/src/Program.cs
@@ -55,6 +55,11 @@ private static async Task<int> Main(string[] args)
                 {
                     Argument = new Argument<string?>() { Arity = ArgumentArity.ExactlyOne }
                 },
+                new Option(new[] { "--include-generated" }, Resources.Include_generated_code_files_in_formatting_operations)
+                {
+                    Argument = new Argument<bool>(),
+                    IsHidden = true
+                },
             };
 
             rootCommand.Description = "dotnet-format";
@@ -64,7 +69,7 @@ private static async Task<int> Main(string[] args)
             return await rootCommand.InvokeAsync(args);
         }
 
-        public static async Task<int> Run(string? folder, string? workspace, string? verbosity, bool check, string[] include, string[] exclude, string? report, IConsole console = null!)
+        public static async Task<int> Run(string? folder, string? workspace, string? verbosity, bool check, string[] include, string[] exclude, string? report, bool includeGenerated, IConsole console = null!)
         {
             // Setup logging.
             var serviceCollection = new ServiceCollection();
@@ -159,7 +164,8 @@ public static async Task<int> Run(string? folder, string? workspace, string? ver
                     saveFormattedFiles: !check,
                     changesAreErrors: check,
                     fileMatcher,
-                    reportPath: report);
+                    reportPath: report,
+                    includeGenerated);
 
                 var formatResult = await CodeFormatter.FormatWorkspaceAsync(
                     formatOptions,

diff --git a/src/Resources.resx b/src/Resources.resx
@@ -225,4 +225,7 @@
   <data name="Unable_to_locate_MSBuild_Ensure_the_NET_SDK_was_installed_with_the_official_installer" xml:space="preserve">
     <value>Unable to locate MSBuild. Ensure the .NET SDK was installed with the official installer.</value>
   </data>
+  <data name="Include_generated_code_files_in_formatting_operations" xml:space="preserve">
+    <value>Include generated code files in formatting operations.</value>
+  </data>
 </root>
diff --git a/src/xlf/Resources.cs.xlf b/src/xlf/Resources.cs.xlf
@@ -102,6 +102,11 @@
         <target state="translated">Formátují se soubory kódu v pracovním prostoru {0}.</target>
         <note />
       </trans-unit>
+      <trans-unit id="Include_generated_code_files_in_formatting_operations">
+        <source>Include generated code files in formatting operations.</source>
+        <target state="new">Include generated code files in formatting operations.</target>
+        <note />
+      </trans-unit>
       <trans-unit id="Loading_workspace">
         <source>Loading workspace.</source>
         <target state="translated">Načítá se pracovní prostor.</target>

diff --git a/src/xlf/Resources.de.xlf b/src/xlf/Resources.de.xlf
@@ -102,6 +102,11 @@
         <target state="translated">Codedateien im Arbeitsbereich "{0}" werden formatiert.</target>
         <note />
       </trans-unit>
+      <trans-unit id="Include_generated_code_files_in_formatting_operations">
+        <source>Include generated code files in formatting operations.</source>
+        <target state="new">Include generated code files in formatting operations.</target>
+        <note />
+      </trans-unit>
       <trans-unit id="Loading_workspace">
         <source>Loading workspace.</source>
         <target state="translated">Arbeitsbereich wird geladen.</target>

diff --git a/src/xlf/Resources.es.xlf b/src/xlf/Resources.es.xlf
@@ -102,6 +102,11 @@
         <target state="translated">Aplicar formato a archivos de código en espacio de trabajo "{0}".</target>
         <note />
       </trans-unit>
+      <trans-unit id="Include_generated_code_files_in_formatting_operations">
+        <source>Include generated code files in formatting operations.</source>
+        <target state="new">Include generated code files in formatting operations.</target>
+        <note />
+      </trans-unit>
       <trans-unit id="Loading_workspace">
         <source>Loading workspace.</source>
         <target state="translated">Cargando área de trabajo.</target>

diff --git a/src/xlf/Resources.fr.xlf b/src/xlf/Resources.fr.xlf
@@ -102,6 +102,11 @@
         <target state="translated">Mise en forme des fichiers de code dans l'espace de travail '{0}'.</target>
         <note />
       </trans-unit>
+      <trans-unit id="Include_generated_code_files_in_formatting_operations">
+        <source>Include generated code files in formatting operations.</source>
+        <target state="new">Include generated code files in formatting operations.</target>
+        <note />
+      </trans-unit>
       <trans-unit id="Loading_workspace">
         <source>Loading workspace.</source>
         <target state="translated">Chargement de l'espace de travail.</target>

diff --git a/src/xlf/Resources.it.xlf b/src/xlf/Resources.it.xlf
@@ -102,6 +102,11 @@
         <target state="translated">Formattazione del file di codice nell'area di lavoro '{0}'.</target>
         <note />
       </trans-unit>
+      <trans-unit id="Include_generated_code_files_in_formatting_operations">
+        <source>Include generated code files in formatting operations.</source>
+        <target state="new">Include generated code files in formatting operations.</target>
+        <note />
+      </trans-unit>
       <trans-unit id="Loading_workspace">
         <source>Loading workspace.</source>
         <target state="translated">Caricamento dell'area di lavoro.</target>

diff --git a/src/xlf/Resources.ja.xlf b/src/xlf/Resources.ja.xlf
@@ -102,6 +102,11 @@
         <target state="translated">ワークスペース '{0}' でコード ファイルを書式設定します。</target>
         <note />
       </trans-unit>
+      <trans-unit id="Include_generated_code_files_in_formatting_operations">
+        <source>Include generated code files in formatting operations.</source>
+        <target state="new">Include generated code files in formatting operations.</target>
+        <note />
+      </trans-unit>
       <trans-unit id="Loading_workspace">
         <source>Loading workspace.</source>
         <target state="translated">ワークスペースを読み込んでいます。</target>

diff --git a/src/xlf/Resources.ko.xlf b/src/xlf/Resources.ko.xlf
@@ -102,6 +102,11 @@
         <target state="translated">'{0}' 작업 영역에서 코드 파일의 서식을 지정합니다.</target>
         <note />
       </trans-unit>
+      <trans-unit id="Include_generated_code_files_in_formatting_operations">
+        <source>Include generated code files in formatting operations.</source>
+        <target state="new">Include generated code files in formatting operations.</target>
+        <note />
+      </trans-unit>
       <trans-unit id="Loading_workspace">
         <source>Loading workspace.</source>
         <target state="translated">작업 영역을 로드하는 중입니다.</target>

diff --git a/src/xlf/Resources.pl.xlf b/src/xlf/Resources.pl.xlf
@@ -102,6 +102,11 @@
         <target state="translated">Formatowanie plików kodu w obszarze roboczym „{0}”.</target>
         <note />
       </trans-unit>
+      <trans-unit id="Include_generated_code_files_in_formatting_operations">
+        <source>Include generated code files in formatting operations.</source>
+        <target state="new">Include generated code files in formatting operations.</target>
+        <note />
+      </trans-unit>
       <trans-unit id="Loading_workspace">
         <source>Loading workspace.</source>
         <target state="translated">Ładowanie obszaru roboczego.</target>

diff --git a/src/xlf/Resources.pt-BR.xlf b/src/xlf/Resources.pt-BR.xlf
@@ -102,6 +102,11 @@
         <target state="translated">Formatação de arquivos de código no espaço de trabalho '{0}'.</target>
         <note />
       </trans-unit>
+      <trans-unit id="Include_generated_code_files_in_formatting_operations">
+        <source>Include generated code files in formatting operations.</source>
+        <target state="new">Include generated code files in formatting operations.</target>
+        <note />
+      </trans-unit>
       <trans-unit id="Loading_workspace">
         <source>Loading workspace.</source>
         <target state="translated">Carregando espaço de trabalho.</target>

diff --git a/src/xlf/Resources.ru.xlf b/src/xlf/Resources.ru.xlf
@@ -102,6 +102,11 @@
         <target state="translated">Форматирование кода файлов в рабочей области "{0}".</target>
         <note />
       </trans-unit>
+      <trans-unit id="Include_generated_code_files_in_formatting_operations">
+        <source>Include generated code files in formatting operations.</source>
+        <target state="new">Include generated code files in formatting operations.</target>
+        <note />
+      </trans-unit>
       <trans-unit id="Loading_workspace">
         <source>Loading workspace.</source>
         <target state="translated">Загрузка рабочей области.</target>

diff --git a/src/xlf/Resources.tr.xlf b/src/xlf/Resources.tr.xlf
@@ -102,6 +102,11 @@
         <target state="translated">Çalışma alanı '{0}' kod dosyalarında biçimlendirme.</target>
         <note />
       </trans-unit>
+      <trans-unit id="Include_generated_code_files_in_formatting_operations">
+        <source>Include generated code files in formatting operations.</source>
+        <target state="new">Include generated code files in formatting operations.</target>
+        <note />
+      </trans-unit>
       <trans-unit id="Loading_workspace">
         <source>Loading workspace.</source>
         <target state="translated">Çalışma alanı yükleniyor.</target>

diff --git a/src/xlf/Resources.zh-Hans.xlf b/src/xlf/Resources.zh-Hans.xlf
@@ -102,6 +102,11 @@
         <target state="translated">正在设置工作区“{0}”中代码文件的格式。</target>
         <note />
       </trans-unit>
+      <trans-unit id="Include_generated_code_files_in_formatting_operations">
+        <source>Include generated code files in formatting operations.</source>
+        <target state="new">Include generated code files in formatting operations.</target>
+        <note />
+      </trans-unit>
       <trans-unit id="Loading_workspace">
         <source>Loading workspace.</source>
         <target state="translated">正在加载工作区。</target>

diff --git a/src/xlf/Resources.zh-Hant.xlf b/src/xlf/Resources.zh-Hant.xlf
@@ -102,6 +102,11 @@
         <target state="translated">正在將工作區 '{0}' 中的程式碼檔案格式化。</target>
         <note />
       </trans-unit>
+      <trans-unit id="Include_generated_code_files_in_formatting_operations">
+        <source>Include generated code files in formatting operations.</source>
+        <target state="new">Include generated code files in formatting operations.</target>
+        <note />
+      </trans-unit>
       <trans-unit id="Loading_workspace">
         <source>Loading workspace.</source>
         <target state="translated">正在載入工作區。</target>