Always ignore any files in .git folder (#1444)

closes #1438
belav · Jan 20, 2025 · 6eb1253 · 6eb1253
1 parent fe57b44
commit 6eb1253
Show file tree

Hide file tree

Showing 3 changed files with 24 additions and 3 deletions.
diff --git a/Src/CSharpier.Cli.Tests/CliTests.cs b/Src/CSharpier.Cli.Tests/CliTests.cs
@@ -97,6 +97,24 @@ public async Task Should_Respect_Ignore_File_With_Subdirectory_When_DirectorOrFi
         result.Should().Be(unformattedContent, $"The file at {filePath} should have been ignored");
     }
 
+    [TestCase(".git")]
+    [TestCase("subdirectory/.git")]
+    [TestCase("node_modules")]
+    [TestCase("subdirectory/node_modules")]
+    [TestCase("obj")]
+    [TestCase("subdirectory/obj")]
+    public async Task Should_Ignore_Special_Case_Files(string path)
+    {
+        var unformattedContent = "public class Unformatted {     }";
+        var filePath = $"{path}/IgnoredFile.cs";
+        await this.WriteFileAsync(filePath, unformattedContent);
+
+        await new CsharpierProcess().WithArguments(".").ExecuteAsync();
+        var result = await this.ReadAllTextAsync(filePath);
+
+        result.Should().Be(unformattedContent, $"The file at {filePath} should have been ignored");
+    }
+
     [Test]
     public async Task Should_Support_Config_Path()
     {

diff --git a/Src/CSharpier.Cli/IgnoreFile.cs b/Src/CSharpier.Cli/IgnoreFile.cs
@@ -6,7 +6,7 @@ internal class IgnoreFile
 {
     protected Ignore.Ignore Ignore { get; }
     protected string IgnoreBaseDirectoryPath { get; }
-    private static readonly string[] alwaysIgnored = ["**/node_modules/**/*.cs", "**/obj/**/*.cs"];
+    private static readonly string[] alwaysIgnored = ["**/node_modules", "**/obj", "**/.git"];
 
     protected IgnoreFile(Ignore.Ignore ignore, string ignoreBaseDirectoryPath)
     {

diff --git a/docs/Ignore.md b/docs/Ignore.md
@@ -30,9 +30,12 @@ _See [Configuration](CLI.md) for including these files_
 - Any file that ends with `.g.i.cs`
 - Any file that begins with a comment that contains `<autogenerated` or `<auto-generated`
 
-#### Node Module Files
+#### Special Case Files
 
-- Any file that matches the gitignore syntax `**/node_modules/**/*.cs`
+- Any file that matches the gitignore syntax 
+    - `**/node_modules`
+    - `**/obj`
+    - `**/.git`
 
 ## Ignoring Code