The support for gitignore kills performance and there isn't a straightforward fix (#1589)

Will hopefully be re-enabled with #1587

closes #1584

Author: belav

CHANGELOG.md

@@ -42,6 +42,7 @@ The tool command name was changed to just `csharpier`
 The assembly/exe names have changed to just `CSharpier`
 
 ### Support for ignoring files via a .gitignore [#631](https://github.com/belav/csharpier/issues/631)
+**Disabled for performance issues as of 1.0.1** see [#1588](https://github.com/belav/csharpier/issues/1588)
 CSharpier now works as follows when determining if a file should be ignored.
 
 - .gitignore files are considered when determining if a file will be ignored. A .gitignore file at the same level as a given file will take priority over a .gitignore file above it in the directory tree.

Src/CSharpier.Cli/IgnoreFile.cs

@@ -1,5 +1,7 @@
 using System.Diagnostics.CodeAnalysis;
 using System.IO.Abstractions;
+using CSharpier.Cli.Options;
+using CSharpier.Core;
 using Ignore;
 
 namespace CSharpier.Cli;
@@ -37,6 +39,7 @@ public bool IsIgnored(string filePath)
         CancellationToken cancellationToken
     )
     {
+        DebugLogger.Log("Creating IgnoreFile for " + baseDirectoryPath);
         var ignoreFilePaths = FindIgnorePaths(baseDirectoryPath, fileSystem);
         if (ignoreFilePaths.Count == 0)
         {
@@ -110,11 +113,11 @@ private static List<string> FindIgnorePaths(string baseDirectoryPath, IFileSyste
                 }
             }
 
-            var gitIgnoreFilePath = fileSystem.Path.Combine(directoryInfo.FullName, ".gitignore");
-            if (fileSystem.File.Exists(gitIgnoreFilePath))
-            {
-                result.Add(gitIgnoreFilePath);
-            }
+            // var gitIgnoreFilePath = fileSystem.Path.Combine(directoryInfo.FullName, ".gitignore");
+            // if (OptionsProvider.UseGitIgnore && fileSystem.File.Exists(gitIgnoreFilePath))
+            // {
+            //     result.Add(gitIgnoreFilePath);
+            // }
 
             directoryInfo = directoryInfo.Parent;
         }

Src/CSharpier.Cli/Options/OptionsProvider.cs

@@ -184,10 +184,9 @@ CancellationToken cancellationToken
             directoryName,
             this.ignoreFilesByDirectory,
             (searchingDirectory) =>
-                this.fileSystem.File.Exists(Path.Combine(searchingDirectory, ".gitignore"))
-                || this.fileSystem.File.Exists(
-                    Path.Combine(searchingDirectory, ".csharpierignore")
-                ),
+                // this.fileSystem.File.Exists(Path.Combine(searchingDirectory, ".gitignore"))
+                //||
+                this.fileSystem.File.Exists(Path.Combine(searchingDirectory, ".csharpierignore")),
             (searchingDirectory) =>
                 IgnoreFile.CreateAsync(searchingDirectory, this.fileSystem, cancellationToken)
         );

Src/CSharpier.Tests/CommandLineFormatterTests.cs

@@ -628,7 +628,7 @@ public void Ignore_Reports_Errors()
     [TestCase("File.cs", "!File.cs", false)]
     [TestCase("", "File.cs", true)]
     [TestCase("!File.cs", "File.cs", true)]
-    [TestCase("File.cs", "", true)]
+    // [TestCase("File.cs", "", true)]
     public void CSharpier_Ignore_And_Git_Ignore_Root_Level(
         string gitIgnoreContents,
         string csharpierIgnoreContents,
@@ -651,7 +651,7 @@ bool isIgnored
     [TestCase("File.cs", "!File.cs", false)]
     [TestCase("", "File.cs", true)]
     [TestCase("!File.cs", "File.cs", true)]
-    [TestCase("File.cs", "", true)]
+    // [TestCase("File.cs", "", true)]
     public void CSharpier_Ignore_And_Git_Ignore_Sub_Level(
         string gitIgnoreContents,
         string csharpierIgnoreContents,
@@ -671,28 +671,28 @@ bool isIgnored
             .StartWith(isIgnored ? "Formatted 0 files in " : "Formatted 1 files in ");
     }
 
-    [TestCase("File.cs", "!File.cs", false)]
-    [TestCase("", "File.cs", true)]
-    [TestCase("!File.cs", "File.cs", true)]
-    [TestCase("File.cs", "", true)]
-    public void Two_Git_Ignores(
-        string rootGitIgnoreContents,
-        string subGitIgnoreContents,
-        bool isIgnored
-    )
-    {
-        var context = new TestContext();
-        context.WhenAFileExists("Sub/File.cs", UnformattedClassContent);
-        context.WhenAFileExists(".gitignore", rootGitIgnoreContents);
-        context.WhenAFileExists("Sub/.gitignore", subGitIgnoreContents);
-
-        var result = Format(context);
-
-        result
-            .OutputLines.FirstOrDefault()
-            .Should()
-            .StartWith(isIgnored ? "Formatted 0 files in " : "Formatted 1 files in ");
-    }
+    // [TestCase("File.cs", "!File.cs", false)]
+    // [TestCase("", "File.cs", true)]
+    // [TestCase("!File.cs", "File.cs", true)]
+    // [TestCase("File.cs", "", true)]
+    // public void Two_Git_Ignores(
+    //     string rootGitIgnoreContents,
+    //     string subGitIgnoreContents,
+    //     bool isIgnored
+    // )
+    // {
+    //     var context = new TestContext();
+    //     context.WhenAFileExists("Sub/File.cs", UnformattedClassContent);
+    //     context.WhenAFileExists(".gitignore", rootGitIgnoreContents);
+    //     context.WhenAFileExists("Sub/.gitignore", subGitIgnoreContents);
+    //
+    //     var result = Format(context);
+    //
+    //     result
+    //         .OutputLines.FirstOrDefault()
+    //         .Should()
+    //         .StartWith(isIgnored ? "Formatted 0 files in " : "Formatted 1 files in ");
+    // }
 
     [Test]
     public void Write_Stdout_Should_Only_Write_File()

docs/Ignore.md

@@ -17,6 +17,8 @@ Uploads/
 ```
 
 ### .gitignore
+**Disabled for performance issues as of 1.0.1** see [#1588](https://github.com/belav/csharpier/issues/1588)
+
 CSharpier will read the contents of `.gitignore` files and use them in addition to a `.csharpierignore` file to determine if a file should be ignored.
 
 If a directory tree contains a `.csharpierignore` file then patterns in that file will always take priority over any `.gitignore` file in the same tree.