AGENTS.md

1# UniGetUI - Copilot Instructions
2 
3## Project Overview
4 
5UniGetUI is an Avalonia desktop app (C#/.NET 10) providing a GUI for CLI package managers (WinGet, Scoop, Chocolatey, Pip, Npm, .NET Tool, PowerShell Gallery, Cargo, Vcpkg).
6 
7Solution entry points:
8- `src/UniGetUI.Windows.slnx` - official Windows solution; builds the Avalonia app and Windows-specific package-manager integrations
9- `src/UniGetUI.Avalonia.slnx` - cross-platform Avalonia solution
10 
11## Architecture
12 
13The codebase follows a **layered, modular structure** with ~40 projects:
14 
15- **`UniGetUI.Avalonia/`** - Avalonia entry point, AXAML pages, controls, and app shell (`Program.cs`, `Views/MainWindow.axaml`)
16- **`SharedAssets/`** - shared app icons, symbols, splash images, and utility scripts used by packaging
17- **`UniGetUI.Core.*`** - Shared infrastructure: `Logger`, `Settings`, `Tools` (includes `CoreTools.Translate()`), `IconEngine`, `LanguageEngine`
18- **`UniGetUI.PackageEngine.Interfaces`** - Contracts: `IPackageManager`, `IPackage`, `IManagerSource`, `IPackageDetails`
19- **`UniGetUI.PackageEngine.PackageManagerClasses`** - Base implementations: `PackageManager` (abstract), `Package`, helpers (`BasePkgDetailsHelper`, `BasePkgOperationHelper`, `BaseSourceHelper`)
20- **`UniGetUI.PackageEngine.Managers.*`** - Concrete manager implementations (one project per manager: `WinGet`, `Scoop`, `Chocolatey`, `Pip`, `npm`, etc.)
21- **`UniGetUI.PackageEngine.Operations`** - Install/update/uninstall operation orchestration
22- **`UniGetUI.Interface.*`** - Enums, telemetry, background API
23 
24## Adding a New Package Manager
25 
26Each manager extends `PackageManager` and must override three abstract methods:
27 
28```csharp
29protected override IReadOnlyList<Package> FindPackages_UnSafe(string query);
30protected override IReadOnlyList<Package> GetAvailableUpdates_UnSafe();
31protected override IReadOnlyList<Package> GetInstalledPackages_UnSafe();
32```
33 
34Each manager also provides three helper classes (in a `Helpers/` subfolder):
35- `*PkgDetailsHelper` extends `BasePkgDetailsHelper` - overrides `GetDetails_UnSafe`, `GetInstallableVersions_UnSafe`, `GetIcon_UnSafe`, etc.
36- `*PkgOperationHelper` extends `BasePkgOperationHelper` - overrides `_getOperationParameters`, `_getOperationResult`
37- `*SourceHelper` extends `BaseSourceHelper` - overrides `GetSources_UnSafe`, `GetAddSourceParameters`, etc.
38 
39The constructor sets `Capabilities`, `Properties`, and wires the helpers. See `src/UniGetUI.PackageEngine.Managers.Scoop/Scoop.cs` as a clean reference implementation.
40 
41## Build & Test
42 
43```shell
44# Restore & test (from src/)
45dotnet restore UniGetUI.Windows.slnx
46dotnet test UniGetUI.Windows.slnx --verbosity q --nologo /p:Platform=x64
47 
48# Publish release build
49dotnet publish src/UniGetUI.Avalonia/UniGetUI.Avalonia.csproj /p:Configuration=Release /p:Platform=x64 -p:RuntimeIdentifier=win-x64
50```
51 
52- Target framework: `net10.0-windows10.0.26100.0` (min `10.0.19041`)
53- Build generates secrets via `src/UniGetUI.Avalonia/Infrastructure/generate-secrets.ps1` and integrity tree via `scripts/generate-integrity-tree.ps1`
54- Self-contained, publish-trimmed (partial), Windows App SDK self-contained
55- Tests use **xUnit** (`[Fact]`, `Assert.*`)
56 
57## NativeAOT and Trim Safety
58 
59Release packages are self-contained, fully trimmed NativeAOT binaries on every supported RID. Treat NativeAOT safety as a non-negotiable production requirement: changes must work without runtime-generated code or metadata that the trimmer cannot prove is required.
60 
61- Consider every `IL2xxx` trim warning and `IL3xxx` AOT warning a defect. Do not blanket-suppress warnings or use a broad `RequiresUnreferencedCode`, `RequiresDynamicCode`, `DynamicDependency`, `DynamicallyAccessedMembers`, linker descriptor, or root assembly as a workaround. An exception must be narrowly scoped, explain the concrete runtime requirement, and have a publish-path test that proves it is safe.
62- Use `JsonSerializerContext`/`JsonTypeInfo<T>` source-generated metadata for every production JSON serialization or deserialization path, including generic helpers, HTTP payloads, settings, IPC, telemetry, and persisted state. Do not call reflection-based serializer overloads or retain a reflection fallback for unknown application types. Add the closed type to a context and test the persisted or transported path.
63- Do not introduce production reflection-driven activation or discovery (`Assembly.Load`, `Type.GetType`, `Activator`, member lookup/invocation), runtime generic construction, expression compilation, runtime code generation, or dynamically loaded plugins. Prefer explicit registrations, direct constructors, generated metadata, and compiled XAML bindings. If a framework-owned dynamic boundary cannot be removed, isolate it and add published-NativeAOT runtime coverage.
64- New shipping COM interop must use source-generated interfaces and wrappers (`GeneratedComInterface`, `StrategyBasedComWrappers`) or raw ABI calls; do not add `ComImport`, `CoClass`, RCW activation, or legacy marshal-to-object APIs to a NativeAOT path. Define the ABI precisely, balance COM reference ownership, and test both x64 and arm64 where applicable.
65- Prefer `LibraryImport` for new P/Invokes. Existing `DllImport` declarations are acceptable only when their marshalling is supported by NativeAOT; keep platform guards, calling conventions, ownership, callback lifetimes, and x64/arm64 struct layouts explicit and covered.
66- Audit all new or changed startup, XAML/view-loading, dependency-injection, serialization, COM/WinRT, P/Invoke, and package-manager code against the publish output, not only a Debug build. Run the relevant NativeAOT publish profile, for example:
67 
68```shell
69  dotnet publish src/UniGetUI.Avalonia/UniGetUI.Avalonia.csproj --configuration Release --runtime win-x64 --self-contained true /p:Platform=x64 /p:PublishProfile=Win-x64-NativeAot
70```
71 
72- When modifying a shared or portable path, retain the same safety guarantees for all checked-in NativeAOT publish profiles: `win-x64`, `win-arm64`, `linux-x64`, `linux-arm64`, `osx-x64`, and `osx-arm64`. Record unsupported runtime-matrix coverage as a gap, never as a pass.
73 
74## Avalonia DevTools (Developer-Only)
75 
76Use these rules when changing Avalonia diagnostics/devtools behavior:
77 
78- Build-time switch is `EnableAvaloniaDiagnostics` in `src/Directory.Build.props`.
79- Default policy: enabled in `Debug`, disabled in `Release`.
80- `src/UniGetUI.Avalonia/UniGetUI.Avalonia.csproj` must condition `AvaloniaUI.DiagnosticsSupport` on `$(EnableAvaloniaDiagnostics)`.
81- Compile-time diagnostics code in `src/UniGetUI.Avalonia/Program.cs` must be gated by `#if AVALONIA_DIAGNOSTICS_ENABLED` (not `#if DEBUG`).
82- Runtime controls are developer-only and intentionally not listed in `docs/CLI.md`.
83- Runtime precedence in `Program.cs`: CLI flags > `UNIGETUI_AVALONIA_DEVTOOLS` environment variable > `Auto` default.
84- Accepted runtime env/CLI values for mode parsing: `auto`, `enabled`, `disabled`, `on`, `off`, `true`, `false`, `1`, `0`.
85- `Auto` mode must remain WSL-safe (DevTools disabled by default on WSL).
86- If diagnostics were excluded at build time, runtime toggle requests should log a no-op warning.
87 
88## Key Patterns & Conventions
89 
90### Settings
91File-based settings via `Settings.Get(Settings.K.*)` / `Settings.Set(Settings.K.*, value)` and `Settings.GetValue(Settings.K.*)` / `Settings.SetValue(Settings.K.*, value)`. Setting keys are defined in the `Settings.K` enum in `SettingsEngine_Names.cs`. Boolean settings are stored as file existence; string settings as file content.
92 
93### Logging
94Use `Logger.Info()`, `Logger.Warn()`, `Logger.Error()`, `Logger.Debug()`, `Logger.ImportantInfo()` from `UniGetUI.Core.Logging`. Accepts both `string` and `Exception` parameters.
95 
96### Localization
97Use `CoreTools.Translate("text")` for all user-facing strings. Parameterized: `CoreTools.Translate("{0} packages found", count)`. In XAML, use the `TranslatedTextBlock` control. Translation assets live under `src/Languages/`; do not assume Tolgee-based automation exists in this repository.
98 
99### Naming
100- Types, methods, properties: **PascalCase**
101- Private fields: `__doubleUnderscore` or `_singleUnderscore` prefix
102- Internal unsafe methods: suffix `_UnSafe` (e.g., `FindPackages_UnSafe`)
103- Nullable enabled globally; `LangVersion` is `latest`
104- Code style enforced in build (`EnforceCodeStyleInBuild=true`)
105 
106### Manager conventions
107- `FALSE_PACKAGE_NAMES`, `FALSE_PACKAGE_IDS`, `FALSE_PACKAGE_VERSIONS` static arrays filter CLI parsing noise
108- Manager initialization flows through `Initialize()` -> `_loadManagerExecutableFile()` -> `_loadManagerVersion()` -> `_performExtraLoadingSteps()`
109- Operations that may fail return `OperationVeredict` (note: intentional misspelling used throughout codebase)
110 
111## Key Files
112 
113| Purpose | Path |
114|---|---|
115| Windows solution | `src/UniGetUI.Windows.slnx` |
116| Cross-platform solution | `src/UniGetUI.Avalonia.slnx` |
117| Shared build props | `src/Directory.Build.props` |
118| Version info | `src/SharedAssemblyInfo.cs` |
119| Manager interface | `src/UniGetUI.PackageEngine.Interfaces/IPackageManager.cs` |
120| Base manager class | `src/UniGetUI.PackageEngine.PackageManagerClasses/Manager/PackageManager.cs` |
121| Package class | `src/UniGetUI.PackageEngine.PackageManagerClasses/Packages/Package.cs` |
122| Settings engine | `src/UniGetUI.Core.Settings/SettingsEngine.cs` |
123| Setting keys | `src/UniGetUI.Core.Settings/SettingsEngine_Names.cs` |
124| Logger | `src/UniGetUI.Core.Logger/Logger.cs` |
125| CI test workflow | `.github/workflows/dotnet-test.yml` |
126