Ajust code style + enforce in pipeline (#35)

* Adjust code style to better match official c# guidelines

* Enforce dotnet format

* Update gitattributes to commit with crlf

* fix gitattributes

* update check-format action

* again

.gitattributes

@@ -0,0 +1,5 @@
+*           text=auto
+
+*.cs        text eol=crlf
+*.csproj    text eol=crlf
+*.sln       text eol-crlf

.github/workflows/build.yml

@@ -1,4 +1,4 @@
-name: Dalamud plugin build
+name: Build and Test
 
 on:
   push:

.github/workflows/check-format.yml

@@ -0,0 +1,18 @@
+name: Check format
+
+on:
+  push:
+    branches: [ '*' ]
+
+jobs:
+  check-format:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+      - name: Setup .NET
+        uses: actions/setup-dotnet@v4
+        with:
+          dotnet-version: 8.x.x
+      - name: Run dotnet format
+        run: dotnet format --verify-no-changes

Directory.Build.props

@@ -0,0 +1,17 @@
+<Project>
+  <ItemGroup>
+    <PackageReference
+      Include="SonarAnalyzer.CSharp"
+      Version="9.25.1.91650"
+      PrivateAssets="all"
+      Condition="$(MSBuildProjectExtension) == '.csproj'"
+    />
+  </ItemGroup>
+
+  <PropertyGroup>
+    <DalamudLibPath Condition="$([MSBuild]::IsOSPlatform('Windows'))">$(appdata)\XIVLauncher\addon\Hooks\dev\</DalamudLibPath>
+    <DalamudLibPath Condition="$([MSBuild]::IsOSPlatform('Linux'))">$(HOME)/.xlcore/dalamud/Hooks/dev/</DalamudLibPath>
+    <DalamudLibPath Condition="$([MSBuild]::IsOSPlatform('OSX'))">$(HOME)/Library/Application Support/XIV on Mac/dalamud/Hooks/dev/</DalamudLibPath>
+    <DalamudLibPath Condition="$(DALAMUD_HOME) != ''">$(DALAMUD_HOME)/</DalamudLibPath>
+  </PropertyGroup>
+</Project>

EasyTranslate.DalamudPlugin/Attributes/EntryPointAttribute.cs

@@ -1,6 +1,6 @@
-namespace EasyTranslate.DalamudPlugin.Attributes;
+using System;
 
-using System;
+namespace EasyTranslate.DalamudPlugin.Attributes;
 
 [AttributeUsage(AttributeTargets.Class)]
 public class EntryPointAttribute : Attribute;

EasyTranslate.DalamudPlugin/Configuration/DalamudPluginModule.cs

@@ -1,62 +1,62 @@
-namespace EasyTranslate.DalamudPlugin.Configuration;
-
-using Dalamud.Interface.Windowing;
+using Dalamud.Interface.Windowing;
 using Dalamud.Plugin;
 using Dalamud.Plugin.Services;
-using Infrastructure.Configuration;
-using Localisation;
+using EasyTranslate.DalamudPlugin.Localisation;
+using EasyTranslate.DalamudPlugin.Search;
+using EasyTranslate.DalamudPlugin.Settings;
+using EasyTranslate.Infrastructure.Configuration;
+using EasyTranslate.UseCase.Configuration;
 using Lumina.Excel;
 using Microsoft.Extensions.DependencyInjection;
-using Search;
-using Settings;
-using UseCase.Configuration;
+
+namespace EasyTranslate.DalamudPlugin.Configuration;
 
 public static class DalamudPluginModule
 {
     public static ServiceProvider CreateServiceProvider(DalamudPluginInterface pluginInterface)
     {
         return new ServiceCollection()
-               .AddDalamudServices(pluginInterface)
-               .AddPluginServices()
-               .AddUseCaseServices()
-               .AddInfrastructureServices()
-               .BuildServiceProvider();
+            .AddDalamudServices(pluginInterface)
+            .AddPluginServices()
+            .AddUseCaseServices()
+            .AddInfrastructureServices()
+            .BuildServiceProvider();
     }
 
-    public static IServiceCollection AddDalamudServices(
+    private static IServiceCollection AddDalamudServices(
         this IServiceCollection serviceCollection,
         DalamudPluginInterface pluginInterface
     )
     {
         return serviceCollection
-               .AddExisting(pluginInterface)
-               .AddExisting(pluginInterface.UiBuilder)
-               .AddDalamudService<ICommandManager>()
-               .AddDalamudService<ITextureProvider>()
-               .AddDalamudService<IDataManager>()
-               .AddDalamudService<IGameConfig>()
-               .AddDalamudService<IContextMenu>()
-               .AddDalamudService<IDataManager>()
-               .AddSingleton<ExcelModule>(serviceProvider => serviceProvider.GetService<IDataManager>()!.Excel);
+            .AddExisting(pluginInterface)
+            .AddExisting(pluginInterface.UiBuilder)
+            .AddDalamudService<ICommandManager>()
+            .AddDalamudService<ITextureProvider>()
+            .AddDalamudService<IDataManager>()
+            .AddDalamudService<IGameConfig>()
+            .AddDalamudService<IContextMenu>()
+            .AddDalamudService<IDataManager>()
+            .AddSingleton<ExcelModule>(serviceProvider => serviceProvider.GetService<IDataManager>()!.Excel);
     }
 
-    public static IServiceCollection AddPluginServices(this IServiceCollection serviceCollection)
+    private static IServiceCollection AddPluginServices(this IServiceCollection serviceCollection)
     {
         return serviceCollection
-               .AddSingleton<LanguageSwitcher>()
-               .AddSingleton<WindowSystem>(_ => new WindowSystem("EasyTranslate"))
-               .AddSingleton<SearchView>()
-               .AddTransient<SearchViewModel>()
-               .AddSingleton<ContentMapper>()
-               .AddSingleton<OpenSearchCommand>()
-               .AddSingleton<UserSettingsRepository>()
-               .AddSingleton<OpenSettingsCommand>()
-               .AddSingleton<SettingsView>()
-               .AddTransient<SettingsViewModel>()
-               .AddSingleton<SearchContextMenuItem>();
+            .AddSingleton<LanguageSwitcher>()
+            .AddSingleton<WindowSystem>(_ => new WindowSystem("EasyTranslate"))
+            .AddSingleton<SearchView>()
+            .AddTransient<SearchViewModel>()
+            .AddSingleton<ContentMapper>()
+            .AddSingleton<OpenSearchCommand>()
+            .AddSingleton<UserSettingsRepository>()
+            .AddSingleton<OpenSettingsCommand>()
+            .AddSingleton<SettingsView>()
+            .AddTransient<SettingsViewModel>()
+            .AddSingleton<SearchContextMenuItem>();
     }
 
-    public static IServiceCollection AddExisting<T>(this IServiceCollection serviceCollection, T service)
+    private static IServiceCollection AddExisting<T>(this IServiceCollection serviceCollection, T service)
         where T : class
     {
         return serviceCollection.AddSingleton(service);
@@ -67,8 +67,8 @@ public static IServiceCollection AddExisting<T>(this IServiceCollection serviceC
         serviceCollection.AddSingleton(
             serviceProvider =>
             {
-                var pluginInterface = serviceProvider.GetService<DalamudPluginInterface>();
-                var wrapper = new DalamudServiceWrapper<T>(pluginInterface!);
+                DalamudPluginInterface? pluginInterface = serviceProvider.GetService<DalamudPluginInterface>();
+                DalamudServiceWrapper<T> wrapper = new(pluginInterface!);
                 return wrapper.Service;
             }
         );

EasyTranslate.DalamudPlugin/Configuration/DalamudServiceWrapper.cs

@@ -1,8 +1,8 @@
-namespace EasyTranslate.DalamudPlugin.Configuration;
-
-using Dalamud.IoC;
+using Dalamud.IoC;
 using Dalamud.Plugin;
 
+namespace EasyTranslate.DalamudPlugin.Configuration;
+
 #pragma warning disable CS8618
 
 public class DalamudServiceWrapper<T>

EasyTranslate.DalamudPlugin/EasyTranslate.DalamudPlugin.csproj

@@ -1,46 +1,45 @@
 <?xml version="1.0" encoding="utf-8"?>
 <Project Sdk="Microsoft.NET.Sdk">
-    <Import Project="../Dalamud.Libs.targets"/>
-    <Import Project="$(DalamudLibPath)/targets/Dalamud.Plugin.targets"/>
+  <Import Project="$(DalamudLibPath)/targets/Dalamud.Plugin.targets"/>
 
-    <PropertyGroup>
-        <Authors>Olaren</Authors>
-        <Company></Company>
-        <Version>2.1.0.0</Version>
-        <Description>Search for FFXIV translations right from the game!</Description>
-        <Copyright></Copyright>
-        <PackageProjectUrl>https://github.com/Olaren15/ffxiv-easy-translate</PackageProjectUrl>
-        <PackageLicenseExpression>AGPL-3.0-or-later</PackageLicenseExpression>
-        <IsPackable>false</IsPackable>
-        <RootNamespace>EasyTranslate.DalamudPlugin</RootNamespace>
-        <TargetFramework>net8.0-windows</TargetFramework>
-        <NeutralLanguage>en</NeutralLanguage>
-        <LangVersion>12</LangVersion>
-    </PropertyGroup>
+  <PropertyGroup>
+    <Authors>Olaren</Authors>
+    <Company></Company>
+    <Version>2.1.0.0</Version>
+    <Description>Search for FFXIV translations right from the game!</Description>
+    <Copyright></Copyright>
+    <PackageProjectUrl>https://github.com/Olaren15/ffxiv-easy-translate</PackageProjectUrl>
+    <PackageLicenseExpression>AGPL-3.0-or-later</PackageLicenseExpression>
+    <IsPackable>false</IsPackable>
+    <RootNamespace>EasyTranslate.DalamudPlugin</RootNamespace>
+    <TargetFramework>net8.0-windows</TargetFramework>
+    <NeutralLanguage>en</NeutralLanguage>
+    <LangVersion>12</LangVersion>
+  </PropertyGroup>
 
-    <ItemGroup>
-        <ProjectReference Include="..\EasyTranslate.Domain\EasyTranslate.Domain.csproj"/>
-        <ProjectReference Include="..\EasyTranslate.Infrastructure\EasyTranslate.Infrastructure.csproj"/>
-        <ProjectReference Include="..\EasyTranslate.UseCase\EasyTranslate.UseCase.csproj"/>
-    </ItemGroup>
+  <ItemGroup>
+    <ProjectReference Include="..\EasyTranslate.Domain\EasyTranslate.Domain.csproj"/>
+    <ProjectReference Include="..\EasyTranslate.Infrastructure\EasyTranslate.Infrastructure.csproj"/>
+    <ProjectReference Include="..\EasyTranslate.UseCase\EasyTranslate.UseCase.csproj"/>
+  </ItemGroup>
 
-    <ItemGroup>
-        <PackageReference Include="Microsoft.Extensions.DependencyInjection" Version="8.0.0"/>
-    </ItemGroup>
+  <ItemGroup>
+    <PackageReference Include="Microsoft.Extensions.DependencyInjection" Version="8.0.0"/>
+  </ItemGroup>
 
-    <ItemGroup>
-        <EmbeddedResource Update="Resources\Strings.fr.resx"/>
-        <EmbeddedResource Update="Resources\Strings.resx">
-            <Generator>ResXFileCodeGenerator</Generator>
-            <LastGenOutput>Strings.Designer.cs</LastGenOutput>
-        </EmbeddedResource>
-    </ItemGroup>
+  <ItemGroup>
+    <EmbeddedResource Update="Resources\Strings.fr.resx"/>
+    <EmbeddedResource Update="Resources\Strings.resx">
+      <Generator>ResXFileCodeGenerator</Generator>
+      <LastGenOutput>Strings.Designer.cs</LastGenOutput>
+    </EmbeddedResource>
+  </ItemGroup>
 
-    <ItemGroup>
-        <Compile Update="Resources\Strings.Designer.cs">
-            <DesignTime>True</DesignTime>
-            <AutoGen>True</AutoGen>
-            <DependentUpon>Strings.resx</DependentUpon>
-        </Compile>
-    </ItemGroup>
+  <ItemGroup>
+    <Compile Update="Resources\Strings.Designer.cs">
+      <DesignTime>True</DesignTime>
+      <AutoGen>True</AutoGen>
+      <DependentUpon>Strings.resx</DependentUpon>
+    </Compile>
+  </ItemGroup>
 </Project>

EasyTranslate.DalamudPlugin/EasyTranslatePlugin.cs

@@ -1,43 +1,43 @@
-namespace EasyTranslate.DalamudPlugin;
-
-using System;
+using System;
 using System.Linq;
 using System.Reflection;
-using Attributes;
-using Configuration;
 using Dalamud.Interface;
 using Dalamud.Interface.Windowing;
 using Dalamud.IoC;
 using Dalamud.Plugin;
+using EasyTranslate.DalamudPlugin.Attributes;
+using EasyTranslate.DalamudPlugin.Configuration;
 using Microsoft.Extensions.DependencyInjection;
 
+namespace EasyTranslate.DalamudPlugin;
+
 // ReSharper disable once UnusedType.Global
 public sealed class EasyTranslatePlugin : IDalamudPlugin
 {
-    private readonly ServiceProvider serviceProvider;
-    private readonly UiBuilder uiBuilder;
-    private readonly WindowSystem windowSystem;
+    private readonly ServiceProvider _serviceProvider;
+    private readonly UiBuilder _uiBuilder;
+    private readonly WindowSystem _windowSystem;
 
     public EasyTranslatePlugin([RequiredVersion("1.0")] DalamudPluginInterface pluginInterface)
     {
-        serviceProvider = DalamudPluginModule.CreateServiceProvider(pluginInterface);
-        windowSystem = serviceProvider.GetService<WindowSystem>()!;
-        uiBuilder = serviceProvider.GetService<UiBuilder>()!;
+        _serviceProvider = DalamudPluginModule.CreateServiceProvider(pluginInterface);
+        _windowSystem = _serviceProvider.GetService<WindowSystem>()!;
+        _uiBuilder = _serviceProvider.GetService<UiBuilder>()!;
 
-        uiBuilder.Draw += windowSystem.Draw;
+        _uiBuilder.Draw += _windowSystem.Draw;
 
         // Instantiate classes with [EntryPoint] attribute.
         Assembly.GetAssembly(typeof(EasyTranslatePlugin))!
-                .GetTypes()
-                .Where(type => type.GetCustomAttribute(typeof(EntryPointAttribute), false) is not null)
-                .ToList()
-                .ForEach(entryPoint => ActivatorUtilities.CreateInstance(serviceProvider, entryPoint));
+            .GetTypes()
+            .Where(type => type.GetCustomAttribute(typeof(EntryPointAttribute), false) is not null)
+            .ToList()
+            .ForEach(entryPoint => ActivatorUtilities.CreateInstance(_serviceProvider, entryPoint));
     }
 
     public void Dispose()
     {
-        uiBuilder.Draw -= windowSystem.Draw;
-        serviceProvider.Dispose();
+        _uiBuilder.Draw -= _windowSystem.Draw;
+        _serviceProvider.Dispose();
         GC.SuppressFinalize(this);
     }
 

EasyTranslate.DalamudPlugin/Localisation/ContentTypeTranslations.cs

@@ -1,8 +1,8 @@
-namespace EasyTranslate.DalamudPlugin.Localisation;
+using System.ComponentModel;
+using EasyTranslate.DalamudPlugin.Resources;
+using EasyTranslate.Domain.Entities;
 
-using System.ComponentModel;
-using Domain.Entities;
-using Resources;
+namespace EasyTranslate.DalamudPlugin.Localisation;
 
 public static class ContentTypeTranslations
 {
@@ -27,7 +27,7 @@ public static string LocalisedName(this ContentType contentType)
             ContentType.Title => Strings.Title,
             ContentType.Trait => Strings.Trait,
             ContentType.Weather => Strings.Weather,
-            _ => throw new InvalidEnumArgumentException(nameof(contentType), (int)contentType, typeof(ContentType)),
+            _ => throw new InvalidEnumArgumentException(nameof(contentType), (int)contentType, typeof(ContentType))
         };
     }
 }

EasyTranslate.DalamudPlugin/Localisation/LanguageSwitcher.cs

@@ -1,25 +1,25 @@
-namespace EasyTranslate.DalamudPlugin.Localisation;
-
-using System;
+using System;
 using System.Globalization;
 using Dalamud.Plugin;
-using Resources;
+using EasyTranslate.DalamudPlugin.Resources;
+
+namespace EasyTranslate.DalamudPlugin.Localisation;
 
 public sealed class LanguageSwitcher : IDisposable
 {
-    private readonly DalamudPluginInterface pluginInterface;
+    private readonly DalamudPluginInterface _pluginInterface;
 
     public LanguageSwitcher(DalamudPluginInterface pluginInterface)
     {
-        this.pluginInterface = pluginInterface;
+        _pluginInterface = pluginInterface;
 
         LanguageChangedHandler(pluginInterface.UiLanguage);
         pluginInterface.LanguageChanged += LanguageChangedHandler;
     }
 
     public void Dispose()
     {
-        pluginInterface.LanguageChanged -= LanguageChangedHandler;
+        _pluginInterface.LanguageChanged -= LanguageChangedHandler;
         GC.SuppressFinalize(this);
     }