Merge branch 'main' into limit-git

Author: belav

…thub/workflows/validate_pull_request.yml .github/workflows/ValidatePullRequest.yml.github/workflows/validate_pull_request.yml renamed to .github/workflows/ValidatePullRequest.yml .github/workflows/validate_pull_request.yml renamed to .github/workflows/ValidatePullRequest.yml

@@ -32,6 +32,18 @@ jobs:
           rm -r -f ./Tests/CSharpier.MsBuild.Test
           dotnet tool restore
           dotnet csharpier check .
+  check_todos:
+    runs-on: ubuntu-latest
+    name: Check TODOs
+    steps:
+      - uses: actions/checkout@v2
+      - name: Get branch name (pull request)
+        if: github.event_name == 'pull_request'
+        shell: bash
+        run: echo "BRANCH_NAME=$(echo ${GITHUB_HEAD_REF} | tr / -)" >> $GITHUB_ENV
+      - shell: pwsh
+        run: |
+          ./.github/workflows/ValidatePullRequest_CheckTodos.ps1 -BranchName ${{ env.BRANCH_NAME }}
   test_msbuild:
     strategy:
       matrix:

.github/workflows/ValidatePullRequest_CheckTodos.ps1

@@ -0,0 +1,76 @@
+param
+(
+    [Parameter(Mandatory = $true)] [String]$BranchName
+)
+
+Set-StrictMode -Version 3.0
+$ErrorActionPreference = "Stop"
+
+$skippedDirectories = @("node_modules",   `
+          "dist",   `
+          "obj",   `
+          "bin",   `
+          "lib",   `
+          "Libraries",   `
+          "packages",   `
+          "Service References",   `
+          ".idea",   `
+          ".vscode",   `
+          "BuildArtifacts",   `
+          ".sass-cache",   `
+          "Typings",   `
+          ".git",   `
+          ".sql"   `
+    ) `
+    | ForEach-Object { ([IO.Path]::DirectorySeparatorChar + $_).ToLower() }
+
+Write-Host "::group::Checking for TODOs"
+
+$directoriesToProcess = @()
+foreach ($item in Get-ChildItem -Recurse -Directory) {
+    $add = $true
+    foreach ($directory in $skippedDirectories) {
+        if ($item.FullName.ToLower() -like "*$directory*") {
+            $add = $false
+            continue
+        }
+    }
+
+    if ($add) {
+        $directoriesToProcess += $item.FullName
+    }
+}
+
+Write-Host "Looking for TODO $BranchName"
+$regexPattern = "(TODO[\s-\:]*$BranchName)"
+
+function checkForTodoComments {
+    $directoriesToProcess | ForEach-Object -Parallel {
+        foreach ($item in Get-ChildItem -Path "$_\*" -File -Exclude "*.exe", "*.dll", "*.pdf") {
+            if ($item.FullName.EndsWith(".js") -or $item.FullName.EndsWith(".js.map")) {
+                if (Test-Path $item.FullName.Replace(".js.map", ".ts").Replace(".js", ".ts")) {
+                    continue
+                }
+            }
+
+            Select-String -Pattern "$using:regexPattern" -Path $item.FullName
+        }
+    }
+}
+
+$todoMatches = checkForTodoComments
+
+Write-Host "::endgroup::"
+if ($null -eq $todoMatches) {
+    exit 0
+}
+
+Write-Host "`nFound TODOs that need to be addressed."
+foreach ($todoMatch in $todoMatches) {
+    $relativePath = $todoMatch.Path.Substring($PWD.ToString().Length + 1)
+    Write-Host "::error file=$relativePath,line=$( $todoMatch.LineNumber )::This TODO needs to be cleaned up"
+    Write-Host "       $( $relativePath ):$( $todoMatch.LineNumber )"
+    Write-Host "       $( $todoMatch.Line )"
+}
+
+exit 1

Src/CSharpier.Core/PrinterOptions.cs

@@ -1,3 +1,5 @@
+using System.Globalization;
+
 namespace CSharpier.Core;
 
 internal class PrinterOptions(Formatter formatter)
@@ -36,16 +38,16 @@ internal static string GetLineEnding(string code, PrinterOptions printerOptions)
 
     public static Formatter GetFormatter(string filePath)
     {
-        var formatter =
-            filePath.EndsWith(".cs", StringComparison.Ordinal) ? Formatter.CSharp
-            : filePath.EndsWith(".csx", StringComparison.Ordinal) ? Formatter.CSharpScript
-            : filePath.EndsWith(".csproj", StringComparison.Ordinal)
-            || filePath.EndsWith(".props", StringComparison.Ordinal)
-            || filePath.EndsWith(".targets", StringComparison.Ordinal)
-            || filePath.EndsWith(".xml", StringComparison.Ordinal)
-            || filePath.EndsWith(".config", StringComparison.Ordinal)
-                ? Formatter.XML
-            : Formatter.Unknown;
+        var extension = Path.GetExtension(filePath)[1..].ToLower(CultureInfo.InvariantCulture);
+
+        var formatter = extension switch
+        {
+            "cs" => Formatter.CSharp,
+            "csx" => Formatter.CSharpScript,
+            "config" or "csproj" or "props" or "slnx" or "targets" or "xaml" or "xml" =>
+                Formatter.XML,
+            _ => Formatter.Unknown,
+        };
         return formatter;
     }
 }

Src/CSharpier.Tests/OptionsProviderTests.cs

@@ -47,11 +47,13 @@ string extension
         ShouldHaveDefaultCSharpOptions(result);
     }
 
-    [TestCase("xml")]
+    [TestCase("config")]
     [TestCase("csproj")]
     [TestCase("props")]
+    [TestCase("slnx")]
     [TestCase("targets")]
-    [TestCase("config")]
+    [TestCase("xaml")]
+    [TestCase("xml")]
     public async Task Should_Return_Default_Options_With_No_File_And_Known_Xml_Extension(
         string extension
     )

docs/Configuration.md

@@ -98,8 +98,7 @@ indent_style = space
 indent_size = 4
 max_line_length = 100
 
-[*.{csproj,props,targets,xml,config}]
-# Configurable behaviors
+[*.{config,csproj,props,slnx,targets,xaml,xml}]
 indent_style = space
 indent_size = 2
 max_line_length = 100

docs/Pre-commit.md

@@ -66,7 +66,7 @@ Modify the file at `.husky/task-runner.json`. Include any file extensions that y
         "name": "Run csharpier",
         "command": "dotnet",
         "args": [ "csharpier", "format", "${staged}" ],
-        "include": [ "**/*.{cs,csx,csproj,props,targets,xml,config}" ]
+        "include": [ "**/*.{cs,csx,config,csproj,props,slnx,targets,xaml,xml}" ]
     }]
 }
 ```