Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 13 additions & 7 deletions AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -197,13 +197,19 @@ both sides, then implement the Go `*Service` and call it from a C# ViewModel.
(`errorStatus` helper); the `ErrorCode` enum is the programmatic discriminator
and the frontend maps it to a localized string. The status message is diagnostic
only.
- **i18n**: dynamic display messages travel as a localization **key**
`"namespace.method.type"` (+ args) in a `LocalizedMessage`; the frontend resolves
it against `.resw`. Resources live in
`app/JustHostMC.App/Strings/{en-US,zh-Hant}/Resources.resw`; **en-US is the base
and fallback**. Backend keys use `.` separators; `LocalizationService` rewrites
`.` → `_` to match `.resw` keys. Adding a language is a new `.resw` folder, no
code change.
- **i18n/resources**: prefer XAML `x:Uid` property resources for all static UI,
including dialog chrome, InfoBars, tooltips, and automation properties.
Resources live in
`app/JustHostMC.App/Strings/{en-US,zh-TW}/Resources.resw`; **en-US is the base
and fallback**. Dynamic backend messages use dotted
`"namespace.method.type"` keys (+ args) in `LocalizedMessage`;
`LocalizationService` maps `.` → `/` for MRT Core lookup. Localized dialogs
are XAML `ContentDialog` classes, imperative controls select XAML-defined
tooltip styles/templates, and app-wide Community Toolkit converters stay in
`Application.Resources`. Deduplicate by semantic meaning and target property;
document unavoidable duplicates with their canonical identifier. See
[`docs/resources.md`](docs/resources.md) for the complete rules, approved C#
exceptions, assets, language addition, and validation workflow.

### MVVM Toolkit source generation

Expand Down
19 changes: 19 additions & 0 deletions JustHostMC.sln
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "JustHostMC.Core.Tests", "ap
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "JustHostMC.App", "app\JustHostMC.App\JustHostMC.App.csproj", "{E5CDD455-4BC1-459D-AE24-721828C866D4}"
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "JustHostMC.App.ResourceTests", "app\JustHostMC.App.ResourceTests\JustHostMC.App.ResourceTests.csproj", "{A5B1D07E-7E7C-4D72-9C9A-4B86D58C7150}"
EndProject
Global
GlobalSection(SolutionConfigurationPlatforms) = preSolution
Debug|Any CPU = Debug|Any CPU
Expand Down Expand Up @@ -79,6 +81,22 @@ Global
{E5CDD455-4BC1-459D-AE24-721828C866D4}.Release|x86.ActiveCfg = Release|x86
{E5CDD455-4BC1-459D-AE24-721828C866D4}.Release|x86.Build.0 = Release|x86
{E5CDD455-4BC1-459D-AE24-721828C866D4}.Release|x86.Deploy.0 = Release|x86
{A5B1D07E-7E7C-4D72-9C9A-4B86D58C7150}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{A5B1D07E-7E7C-4D72-9C9A-4B86D58C7150}.Debug|Any CPU.Build.0 = Debug|Any CPU
{A5B1D07E-7E7C-4D72-9C9A-4B86D58C7150}.Debug|ARM64.ActiveCfg = Debug|Any CPU
{A5B1D07E-7E7C-4D72-9C9A-4B86D58C7150}.Debug|ARM64.Build.0 = Debug|Any CPU
{A5B1D07E-7E7C-4D72-9C9A-4B86D58C7150}.Debug|x64.ActiveCfg = Debug|Any CPU
{A5B1D07E-7E7C-4D72-9C9A-4B86D58C7150}.Debug|x64.Build.0 = Debug|Any CPU
{A5B1D07E-7E7C-4D72-9C9A-4B86D58C7150}.Debug|x86.ActiveCfg = Debug|Any CPU
{A5B1D07E-7E7C-4D72-9C9A-4B86D58C7150}.Debug|x86.Build.0 = Debug|Any CPU
{A5B1D07E-7E7C-4D72-9C9A-4B86D58C7150}.Release|Any CPU.ActiveCfg = Release|Any CPU
{A5B1D07E-7E7C-4D72-9C9A-4B86D58C7150}.Release|Any CPU.Build.0 = Release|Any CPU
{A5B1D07E-7E7C-4D72-9C9A-4B86D58C7150}.Release|ARM64.ActiveCfg = Release|Any CPU
{A5B1D07E-7E7C-4D72-9C9A-4B86D58C7150}.Release|ARM64.Build.0 = Release|Any CPU
{A5B1D07E-7E7C-4D72-9C9A-4B86D58C7150}.Release|x64.ActiveCfg = Release|Any CPU
{A5B1D07E-7E7C-4D72-9C9A-4B86D58C7150}.Release|x64.Build.0 = Release|Any CPU
{A5B1D07E-7E7C-4D72-9C9A-4B86D58C7150}.Release|x86.ActiveCfg = Release|Any CPU
{A5B1D07E-7E7C-4D72-9C9A-4B86D58C7150}.Release|x86.Build.0 = Release|Any CPU
EndGlobalSection
GlobalSection(SolutionProperties) = preSolution
HideSolutionNode = FALSE
Expand All @@ -87,6 +105,7 @@ Global
{6C695E07-80F7-4CDD-89D7-5166A97D4B6E} = {F95F473B-E98A-ACD6-1986-755F447BE36F}
{468F0BCC-71DE-4F47-BAD0-80300AE43D03} = {F95F473B-E98A-ACD6-1986-755F447BE36F}
{E5CDD455-4BC1-459D-AE24-721828C866D4} = {F95F473B-E98A-ACD6-1986-755F447BE36F}
{A5B1D07E-7E7C-4D72-9C9A-4B86D58C7150} = {F95F473B-E98A-ACD6-1986-755F447BE36F}
EndGlobalSection
GlobalSection(ExtensibilityGlobals) = postSolution
SolutionGuid = {7D2AD613-A606-4755-BA00-96E200813585}
Expand Down
74 changes: 74 additions & 0 deletions app/JustHostMC.App.ResourceTests/BackupConfigFiniteStateTests.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
using Xunit;

namespace JustHostMC.App.ResourceTests;

public sealed class BackupConfigFiniteStateTests {
[Fact]
public void BackupWorkflowUsesSemanticStateAndXamlResources() {
var viewModel = File.ReadAllText(
RepositoryLayout.AppPath("ViewModels", "BackupsViewModel.cs"));
var xaml = File.ReadAllText(
RepositoryLayout.AppPath("Views", "BackupsDialog.xaml"));

Assert.Contains("BackupStatus", viewModel, StringComparison.Ordinal);
Assert.DoesNotContain("_localizer.Get(\"Backups_", viewModel,
StringComparison.Ordinal);
Assert.Contains("x:Uid=\"BackupsStatusCreating\"", xaml,
StringComparison.Ordinal);
Assert.Contains("x:Uid=\"BackupsStatusCreated\"", xaml,
StringComparison.Ordinal);
Assert.Contains("x:Uid=\"BackupsStatusRestoring\"", xaml,
StringComparison.Ordinal);
Assert.Contains("x:Uid=\"BackupsStatusRestored\"", xaml,
StringComparison.Ordinal);
Assert.Contains("x:Uid=\"BackupsStatusDeleting\"", xaml,
StringComparison.Ordinal);
Assert.Contains("x:Uid=\"BackupsStatusDeleted\"", xaml,
StringComparison.Ordinal);
Assert.DoesNotContain("_localizer.Get(",
File.ReadAllText(RepositoryLayout.AppPath(
"Views", "BackupsDialog.xaml.cs")),
StringComparison.Ordinal);
}

[Fact]
public void ConfigWorkflowUsesSemanticStateAndXamlResources() {
var viewModel = File.ReadAllText(
RepositoryLayout.AppPath("ViewModels", "ServerConfigViewModel.cs"));
var xaml = File.ReadAllText(RepositoryLayout.AppPath(
"Controls", "Server", "ServerConfigPanel.xaml"));

Assert.Contains("ConfigStatus", viewModel, StringComparison.Ordinal);
Assert.DoesNotContain("_localizer.Get(\"Config_", viewModel,
StringComparison.Ordinal);
Assert.Contains("x:Uid=\"ConfigStatusSaved\"", xaml,
StringComparison.Ordinal);
Assert.Contains("x:Uid=\"ConfigStatusLoadFailed\"", xaml,
StringComparison.Ordinal);
Assert.Contains("x:Uid=\"ConfigStatusSaveFailed\"", xaml,
StringComparison.Ordinal);
}

[Fact]
public void ConfigValueTypesUseSemanticFlagsAndXamlResources() {
var model = File.ReadAllText(
RepositoryLayout.AppPath("Models", "ConfigEntryItem.cs"));
var xaml = File.ReadAllText(
RepositoryLayout.AppPath("Controls", "ConfigEntryEditor.xaml"));

Assert.DoesNotContain("TypeText", model, StringComparison.Ordinal);
Assert.DoesNotContain("ConfigType_", model, StringComparison.Ordinal);
Assert.Contains("IsBoolean", model, StringComparison.Ordinal);
Assert.Contains("IsInteger", model, StringComparison.Ordinal);
Assert.Contains("IsChoice", model, StringComparison.Ordinal);
Assert.Contains("IsText", model, StringComparison.Ordinal);
Assert.Contains("x:Uid=\"ConfigTypeBooleanText\"", xaml,
StringComparison.Ordinal);
Assert.Contains("x:Uid=\"ConfigTypeIntegerText\"", xaml,
StringComparison.Ordinal);
Assert.Contains("x:Uid=\"ConfigTypeChoiceText\"", xaml,
StringComparison.Ordinal);
Assert.Contains("x:Uid=\"ConfigTypeTextText\"", xaml,
StringComparison.Ordinal);
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
using Xunit;

namespace JustHostMC.App.ResourceTests;

public sealed class ControlLocalizationArchitectureTests {
[Fact]
public void AssignedControlsDoNotFetchStaticOrFiniteStateStringsFromCode() {
var forbiddenKeys = new[] {
"LogViewer_JumpToLatest",
"Scripts_RemoveConfirmPrimary",
"ServerSectionConfig/Text",
"ServerSectionConfigHint/Text",
"ConfigStoppedHint/Text",
"Server_PortAutoValue",
"Server_ValueUnknown",
"ServerSectionModsHint/Text",
"ModsStoppedHint/Text",
"ServerSectionPerformance/Text",
"ServerSectionPerformanceHint/Text",
"PlayersEmptyHint/Text",
"ServerSectionPlayersHint/Text",
};
var sourceFiles = new[] {
RepositoryLayout.AppPath("Controls", "LogViewer.xaml.cs"),
RepositoryLayout.AppPath("Controls", "ScriptEntryCard.xaml.cs"),
RepositoryLayout.AppPath("Controls", "Server",
"ServerConfigPanel.xaml.cs"),
RepositoryLayout.AppPath("Controls", "Server",
"ServerHeaderPanel.xaml.cs"),
RepositoryLayout.AppPath("Controls", "Server",
"ServerModsPanel.xaml.cs"),
RepositoryLayout.AppPath("Controls", "Server",
"ServerPerformancePanel.xaml.cs"),
RepositoryLayout.AppPath("Controls", "Server",
"ServerPlayersPanel.xaml.cs"),
RepositoryLayout.AppPath("Views", "SettingsPage.xaml.cs"),
};
var source = string.Join('\n', sourceFiles.Select(File.ReadAllText));

foreach (var key in forbiddenKeys)
Assert.DoesNotContain($"\"{key}\"", source,
StringComparison.Ordinal);

var settingsXaml = File.ReadAllText(
RepositoryLayout.AppPath("Views", "SettingsPage.xaml"));
Assert.DoesNotContain("PlaceholderText=\"API Key\"", settingsXaml,
StringComparison.Ordinal);
}
}
28 changes: 28 additions & 0 deletions app/JustHostMC.App.ResourceTests/ConverterArchitectureTests.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
using System.Xml.Linq;
using Xunit;

namespace JustHostMC.App.ResourceTests;

public sealed class ConverterArchitectureTests {
[Fact]
public void AppReferencesCommunityToolkitConverters() {
var project =
XDocument.Load(RepositoryLayout.AppPath("JustHostMC.App.csproj"));

var packageNames =
project.Descendants("PackageReference")
.Select(element => (string?)element.Attribute("Include"));

Assert.Contains("CommunityToolkit.WinUI.Converters", packageNames);
}

[Fact]
public void AppDoesNotRetainCustomBoolToVisibilityConverter() {
var converterPath = RepositoryLayout.AppPath(
"Converters", "BoolToVisibilityConverter.cs");

Assert.False(
File.Exists(converterPath),
$"Replace the custom converter with CommunityToolkit.WinUI.Converters: {converterPath}");
}
}
105 changes: 105 additions & 0 deletions app/JustHostMC.App.ResourceTests/FeatureFiniteStateTests.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,105 @@
using Xunit;

namespace JustHostMC.App.ResourceTests;

public sealed class FeatureFiniteStateTests {
[Fact]
public void ModsFiniteLabelsUseSemanticStateAndXamlResources() {
var viewModel =
RepositoryLayout.ReadAppFile("ViewModels", "ModsViewModel.cs");
var xaml = RepositoryLayout.ReadAppFile("Controls", "Server",
"ServerModsPanel.xaml");

Assert.Contains("ModsWorkflowStatus", viewModel,
StringComparison.Ordinal);
Assert.DoesNotContain("KindLabel", viewModel, StringComparison.Ordinal);
Assert.DoesNotContain("_localizer.Get(\"Mods_Export", viewModel,
StringComparison.Ordinal);
Assert.Contains("x:Uid=\"ServerModsTitleConverter\"", xaml,
StringComparison.Ordinal);
Assert.Contains("x:Uid=\"ModsStatusExported\"", xaml,
StringComparison.Ordinal);
Assert.Contains("x:Uid=\"ModsStatusExportFailed\"", xaml,
StringComparison.Ordinal);
}

[Fact]
public void SettingsFiniteLabelsUseSemanticStateAndXamlResources() {
var viewModel =
RepositoryLayout.ReadAppFile("ViewModels", "SettingsViewModel.cs");
var xaml = RepositoryLayout.ReadAppFile("Views", "SettingsPage.xaml");

Assert.Contains("SettingsWorkflowStatus", viewModel,
StringComparison.Ordinal);
Assert.Contains("ShopKeyConfiguration", viewModel,
StringComparison.Ordinal);
Assert.Contains("BackendMode", viewModel, StringComparison.Ordinal);
Assert.DoesNotContain("ActiveModeText", viewModel,
StringComparison.Ordinal);
Assert.DoesNotContain("CurseForgeKeyStatus", viewModel,
StringComparison.Ordinal);

foreach (var uid in new[] {
"SettingsBackendModeDocker",
"SettingsBackendModeOnMachine",
"SettingsDockerUnavailable",
"SettingsShopKeyNone",
"SettingsShopKeyUser",
"SettingsShopKeyBuiltin",
"SettingsStatusSaved",
"SettingsStatusSaveFailed",
}) {
Assert.Contains($"x:Uid=\"{uid}\"", xaml, StringComparison.Ordinal);
}
}

[Fact]
public void ShopFiniteLabelsUseSemanticStateAndXamlResources() {
var shop =
RepositoryLayout.ReadAppFile("ViewModels", "ShopViewModel.cs");
var detail = RepositoryLayout.ReadAppFile("ViewModels",
"ShopDetailViewModel.cs");
var window = RepositoryLayout.ReadAppFile("Views", "ShopWindow.xaml");
var detailXaml =
RepositoryLayout.ReadAppFile("Views", "ShopDetailPage.xaml");

Assert.Contains("HasLoadFailure", shop, StringComparison.Ordinal);
Assert.DoesNotContain("_localizer.Get(\"Shop_LoadFailed\")", shop,
StringComparison.Ordinal);
Assert.Contains("ShopDetailStatus", detail, StringComparison.Ordinal);
Assert.DoesNotContain("_localizer.Get(\"Shop_InstallDone\")", detail,
StringComparison.Ordinal);
Assert.DoesNotContain("_localizer.Get(\"Shop_InstallAction\")", detail,
StringComparison.Ordinal);
Assert.Contains("x:Uid=\"ShopLoadFailedBar\"", window,
StringComparison.Ordinal);
Assert.Contains("x:Uid=\"ShopInstallActionText\"", detailXaml,
StringComparison.Ordinal);
Assert.Contains("x:Uid=\"ShopStatusInstallDone\"", detailXaml,
StringComparison.Ordinal);
}

[Fact]
public void ScriptLogFiniteLabelsAreRenderedByXaml() {
var viewModel =
RepositoryLayout.ReadAppFile("ViewModels", "ScriptsViewModel.cs");
var xaml =
RepositoryLayout.ReadAppFile("Views", "ScriptLogsWindow.xaml");

foreach (var key in new[] {
"Scripts_SystemLogName",
"Scripts_LogEntryFallbackTitle",
"Scripts_CurrentSessionTitle",
"Scripts_PreviousSessionTitle",
}) {
Assert.DoesNotContain($"_localizer.Get(\"{key}\")", viewModel,
StringComparison.Ordinal);
}
Assert.Contains("x:Uid=\"ScriptLogsSystemName\"", xaml,
StringComparison.Ordinal);
Assert.Contains("x:Uid=\"ScriptLogsCurrentSessionTitle\"", xaml,
StringComparison.Ordinal);
Assert.Contains("x:Uid=\"ScriptLogsPreviousSessionTitle\"", xaml,
StringComparison.Ordinal);
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
<Project Sdk="Microsoft.NET.Sdk">

<PropertyGroup>
<TargetFramework>net9.0</TargetFramework>
<Nullable>enable</Nullable>
<ImplicitUsings>enable</ImplicitUsings>
<LangVersion>latest</LangVersion>
<IsPackable>false</IsPackable>
<IsTestProject>true</IsTestProject>
</PropertyGroup>

<ItemGroup>
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.11.1" />
<PackageReference Include="xunit" Version="2.9.2" />
<PackageReference Include="xunit.runner.visualstudio" Version="2.8.2">
<PrivateAssets>all</PrivateAssets>
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
</PackageReference>
</ItemGroup>

</Project>
Loading