Establish repository formatting baseline and enforcement

- normalize repository whitespace and formatting to the current .editorconfig baseline
- add a pre-commit hook, hook installer, CI verification, and contributor guidance for formatting
- tune .editorconfig and project files to avoid WinUI/XAML false positives and keep Visual Studio design-time loading working
- fix WindowsPackageManager interop workspace loading for dotnet format

Author: mamoreau-devolutions

.gitattributes

@@ -1 +1,2 @@
-src/UniGetUI.PackageEngine.Managers.Chocolatey/choco-cli/** linguist-vendored
+src/UniGetUI.PackageEngine.Managers.Chocolatey/choco-cli/** linguist-vendored
+.githooks/* text eol=lf

.githooks/pre-commit

@@ -0,0 +1,38 @@
+#!/usr/bin/env sh
+
+set -eu
+
+repo_root=$(git rev-parse --show-toplevel)
+cd "$repo_root"
+
+staged_files=$(git diff --cached --name-only --diff-filter=ACMR -- src | grep -E '\.(cs|csproj|props|targets|editorconfig|json|sln|slnx)$' || true)
+
+if [ -z "$staged_files" ]; then
+    exit 0
+fi
+
+unstaged_files=$(git diff --name-only -- $staged_files || true)
+if [ -n "$unstaged_files" ]; then
+    echo "pre-commit: relevant files have unstaged changes."
+    echo "Stage or stash them before committing so dotnet format does not rewrite mixed content."
+    printf '%s\n' "$unstaged_files"
+    exit 1
+fi
+
+if ! command -v dotnet >/dev/null 2>&1; then
+    echo "pre-commit: dotnet CLI not found; skipping whitespace formatting."
+    exit 0
+fi
+
+echo "pre-commit: running dotnet format whitespace on staged src files"
+
+# shellcheck disable=SC2086
+dotnet format whitespace src --folder --verbosity minimal --include $staged_files
+
+if ! git diff --quiet -- $staged_files; then
+    git add -- $staged_files
+    echo "pre-commit: formatting updates were staged. Review them and run git commit again."
+    exit 1
+fi
+
+exit 0

.github/workflows/dotnet-test.yml

@@ -5,15 +5,21 @@ on:
     paths:
       - '**.cs'
       - '**.csproj'
+      - '**.props'
+      - '**.targets'
       - '**.sln'
+      - 'src/.editorconfig'
       - '.github/workflows/dotnet-test.yml'
 
   pull_request:
     branches: [ "main" ]
     paths:
       - '**.cs'
       - '**.csproj'
+      - '**.props'
+      - '**.targets'
       - '**.sln'
+      - 'src/.editorconfig'
       - '.github/workflows/dotnet-test.yml'
 
   workflow_dispatch:
@@ -47,6 +53,13 @@ jobs:
       working-directory: src
       run: dotnet restore UniGetUI.sln
 
+    - name: Check whitespace formatting
+      run: dotnet format whitespace src --folder --verify-no-changes --verbosity minimal
+
+    - name: Check code style formatting
+      working-directory: src
+      run: dotnet format style UniGetUI.sln --no-restore --verify-no-changes --verbosity minimal
+
     - name: Run Tests
       working-directory: src
       run: dotnet test UniGetUI.sln --no-restore --verbosity q --nologo

CONTRIBUTING.md

@@ -38,6 +38,14 @@ Before reading: All of the rules below are guidelines, which means that they sho
  - Draft pull requests should be properly identified as [draft pull requests](https://github.blog/2019-02-14-introducing-draft-pull-requests/) to avoid confusion.
  - When modifying/coding, please follow the guidelines below:
 
+## Formatting:
+ - Run `pwsh ./scripts/install-git-hooks.ps1` once after cloning to enable the repository pre-commit hook.
+- The pre-commit hook runs `dotnet format whitespace src --folder` on staged files under `src` when the `dotnet` CLI is available, and stops the commit if it had to rewrite files so you can review the changes and commit again.
+ - CI enforces whitespace formatting with `dotnet format whitespace src --folder --verify-no-changes` and code-style verification with `dotnet format style src/UniGetUI.sln --no-restore --verify-no-changes` in `.github/workflows/dotnet-test.yml`.
+ - The pre-commit hook intentionally does not run `dotnet format style` because solution loading makes it take roughly the same time for one staged C# file as for the full solution.
+ - If you want to check the same style rules locally before pushing, run `dotnet format style src/UniGetUI.sln --no-restore --verify-no-changes` from the repository root.
+ - If you want to prepare a dedicated formatting-only commit, run `dotnet format whitespace src --folder` from the repository root.
+
 ## Coding:
  - As a repository standard, every function and variable name should use camelCase.
    - Correct usage: `updatesCount = 0`, `def searchForUpdates(packageManager):`

scripts/install-git-hooks.ps1

@@ -0,0 +1,8 @@
+$ErrorActionPreference = 'Stop'
+
+$repoRoot = (Resolve-Path (Join-Path $PSScriptRoot '..')).Path
+
+git -C $repoRoot config core.hooksPath .githooks
+
+Write-Host 'Configured git hooks path to .githooks' -ForegroundColor Green
+Write-Host 'The pre-commit hook will run dotnet format whitespace on staged files under src.' -ForegroundColor Green

src/.editorconfig

@@ -280,7 +280,7 @@ dotnet_diagnostic.CA2246.severity = warning
 dotnet_diagnostic.CA2249.severity = warning
 
 # IDE0005: Remove unnecessary usings
-dotnet_diagnostic.IDE0005.severity = warning
+dotnet_diagnostic.IDE0005.severity = suggestion
 
 # IDE0011: Curly braces to surround blocks of code
 dotnet_diagnostic.IDE0011.severity = warning
@@ -343,6 +343,15 @@ dotnet_diagnostic.IDE0200.severity = warning
 dotnet_style_allow_multiple_blank_lines_experimental = false
 dotnet_diagnostic.IDE2000.severity = warning
 
+# WinUI code-behind relies on XAML-wired event handlers that Roslyn cannot
+# reliably see as C# references.
+[UniGetUI/**.cs]
+dotnet_diagnostic.IDE0051.severity = suggestion
+dotnet_diagnostic.IDE0060.severity = suggestion
+
+[UniGetUI/Controls/SourceManager.xaml.cs]
+dotnet_diagnostic.IDE0044.severity = suggestion
+
 ###### End of EditorConfig from dotnet/aspnetcore repository
 
 ### Our rules

src/Directory.Build.props

@@ -17,9 +17,16 @@
     </PropertyGroup>
 
     <PropertyGroup>
-        <BuildSharedWindowsTargetFrameworks Condition="$([MSBuild]::IsOSPlatform('Windows')) == 'true' or '$(EnableWindowsTargeting)' == 'true'">true</BuildSharedWindowsTargetFrameworks>
-        <SharedTargetFrameworks Condition="'$(BuildSharedWindowsTargetFrameworks)' == 'true'">$(PortableTargetFramework);$(WindowsTargetFramework)</SharedTargetFrameworks>
-        <SharedTargetFrameworks Condition="'$(SharedTargetFrameworks)' == ''">$(PortableTargetFramework)</SharedTargetFrameworks>
+        <BuildSharedWindowsTargetFrameworks
+            Condition="$([MSBuild]::IsOSPlatform('Windows')) == 'true' or '$(EnableWindowsTargeting)' == 'true'"
+            >true</BuildSharedWindowsTargetFrameworks
+        >
+        <SharedTargetFrameworks Condition="'$(BuildSharedWindowsTargetFrameworks)' == 'true'"
+            >$(PortableTargetFramework);$(WindowsTargetFramework)</SharedTargetFrameworks
+        >
+        <SharedTargetFrameworks Condition="'$(SharedTargetFrameworks)' == ''"
+            >$(PortableTargetFramework)</SharedTargetFrameworks
+        >
     </PropertyGroup>
 
     <PropertyGroup Condition="'$(TargetFramework)' == '' and '$(TargetFrameworks)' == ''">
@@ -31,7 +38,10 @@
         <WindowsSdkPackageVersion>10.0.26100.56</WindowsSdkPackageVersion>
         <WindowsAppSDKSelfContained>true</WindowsAppSDKSelfContained>
         <RuntimeIdentifiers>win-x64;win-arm64</RuntimeIdentifiers>
-        <RuntimeIdentifier Condition="'$(Platform)' != '' and '$(Platform)' != 'AnyCPU' and '$(Platform)' != 'Any CPU'">win-$(Platform)</RuntimeIdentifier>
+        <RuntimeIdentifier
+            Condition="'$(Platform)' != '' and '$(Platform)' != 'AnyCPU' and '$(Platform)' != 'Any CPU'"
+            >win-$(Platform)</RuntimeIdentifier
+        >
     </PropertyGroup>
 
     <PropertyGroup>

src/ExternalLibraries.Clipboard/ExternalLibraries.Clipboard.csproj

@@ -1,10 +1,6 @@
 <Project Sdk="Microsoft.NET.Sdk">
-
-	<PropertyGroup>
-		<TargetFramework>$(WindowsTargetFramework)</TargetFramework>
-		<TargetFrameworks />
-	</PropertyGroup>
-
-
-
+    <PropertyGroup>
+        <TargetFramework>$(WindowsTargetFramework)</TargetFramework>
+        <TargetFrameworks />
+    </PropertyGroup>
 </Project>

src/ExternalLibraries.FilePickers/Classes/FileOpenDialogRCW.cs

@@ -1,14 +1,14 @@
-using System.Runtime.InteropServices;
+using System.Runtime.InteropServices;
 using ExternalLibraries.Pickers.Guids;
 
 namespace ExternalLibraries.Pickers.Classes;
 
 // ---------------------------------------------------
 // .NET classes representing runtime callable wrappers
-[ComImport,
-ClassInterface(ClassInterfaceType.None),
-TypeLibType(TypeLibTypeFlags.FCanCreate),
-Guid(CLSIDGuid.FileOpenDialog)]
-internal class FileOpenDialogRCW
-{
-}
+[
+    ComImport,
+    ClassInterface(ClassInterfaceType.None),
+    TypeLibType(TypeLibTypeFlags.FCanCreate),
+    Guid(CLSIDGuid.FileOpenDialog)
+]
+internal class FileOpenDialogRCW { }

src/ExternalLibraries.FilePickers/Classes/FileSaveDialogRCW.cs

@@ -1,14 +1,14 @@
-using System.Runtime.InteropServices;
+using System.Runtime.InteropServices;
 using ExternalLibraries.Pickers.Guids;
 
 namespace ExternalLibraries.Pickers.Classes;
 
 // ---------------------------------------------------
 // .NET classes representing runtime callable wrappers
-[ComImport,
-ClassInterface(ClassInterfaceType.None),
-TypeLibType(TypeLibTypeFlags.FCanCreate),
-Guid(CLSIDGuid.FileSaveDialog)]
-internal class FileSaveDialogRCW
-{
-}
+[
+    ComImport,
+    ClassInterface(ClassInterfaceType.None),
+    TypeLibType(TypeLibTypeFlags.FCanCreate),
+    Guid(CLSIDGuid.FileSaveDialog)
+]
+internal class FileSaveDialogRCW { }