refactor: format code and add husky to project (#265)

* chore: add husky to project

* refactor: applied format

* chore: add husky tool-runner as a git-hook

* build: add husky to projects for an automated installation and disable husky on ci/cd

.config/dotnet-tools.json

@@ -0,0 +1,13 @@
+{
+  "version": 1,
+  "isRoot": true,
+  "tools": {
+    "husky": {
+      "version": "0.7.1",
+      "commands": [
+        "husky"
+      ],
+      "rollForward": false
+    }
+  }
+}

.github/workflows/container.yml

@@ -7,6 +7,8 @@ on:
     tags:
       - 'v[0-9]+.[0-9]+.[0-9]'
       - 'v[0-9]+.[0-9]+.[0-9]-**'
+env:
+  HUSKY: 0
 
 jobs:
   call_build-and-push-image_nightly:

.github/workflows/docker-build-push-matrix.yml

@@ -4,6 +4,9 @@ name: Create and publish Docker images for backend and backoffice
 # Note: DOLLAR in the field descriptions should of course be replaced with a dollar sign.
 #       GitHub parses the description, so we can't write it correctly :)
 
+env:
+  HUSKY: 0
+
 on:
   workflow_call:
     inputs:

.husky/pre-commit

@@ -0,0 +1,22 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+## husky task runner examples -------------------
+## Note : for local installation use 'dotnet' prefix. e.g. 'dotnet husky'
+
+## run all tasks
+#husky run
+
+### run all tasks with group: 'group-name'
+#husky run --group group-name
+
+## run task with name: 'task-name'
+#husky run --name task-name
+
+## pass hook arguments to task
+#husky run --args "$1" "$2"
+
+## or put your custom commands -------------------
+#echo 'Husky.Net is awesome!'
+
+dotnet husky run --group pre-commit

.husky/task-runner.json

@@ -0,0 +1,12 @@
+{
+   "$schema": "https://alirezanet.github.io/Husky.Net/schema.json",
+   "tasks": [
+      {
+         "name": "dotnet-format",
+         "group": "pre-commit",
+         "command": "dotnet",
+         "args": ["format","--no-restore", "--include", "${staged}"],
+         "include": ["**/*.cs"]
+      }
+   ]
+}

src/Eurofurence.App.Backoffice/Eurofurence.App.Backoffice.csproj

@@ -1,11 +1,9 @@
-<Project Sdk="Microsoft.NET.Sdk.BlazorWebAssembly">
-
+<Project Sdk="Microsoft.NET.Sdk.BlazorWebAssembly">
   <PropertyGroup>
     <TargetFramework>net8.0</TargetFramework>
     <Nullable>enable</Nullable>
     <ImplicitUsings>enable</ImplicitUsings>
   </PropertyGroup>
-
   <ItemGroup>
     <PackageReference Include="Markdig" Version="0.37.0" />
     <PackageReference Include="Microsoft.AspNetCore.Components.WebAssembly" Version="8.0.11" />
@@ -15,15 +13,16 @@
     <PackageReference Include="Microsoft.Extensions.Http" Version="8.0.0" />
     <PackageReference Include="MudBlazor" Version="7.8.0" />
   </ItemGroup>
-
   <ItemGroup>
     <ProjectReference Include="..\Eurofurence.App.Domain.Model\Eurofurence.App.Domain.Model.csproj" />
   </ItemGroup>
-
   <ItemGroup>
     <Content Update="wwwroot\appsettings.json">
       <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
     </Content>
   </ItemGroup>
-
+  <Target Name="Husky" BeforeTargets="Restore;CollectPackageReferences" Condition="'$(HUSKY)' != 0">
+    <Exec Command="dotnet tool restore" StandardOutputImportance="Low" StandardErrorImportance="High" />
+    <Exec Command="dotnet husky install" StandardOutputImportance="Low" StandardErrorImportance="High" WorkingDirectory="../.." />
+  </Target>
 </Project>

src/Eurofurence.App.Backoffice/Services/ArtistAlleyService.cs

@@ -34,7 +34,7 @@ public async Task<ArtistAlleySystemStatus> GetArtistAllaySystemStatus()
         {
             var options = new JsonSerializerOptions();
             options.Converters.Add(new JsonStringEnumConverter());
-            return await http.GetFromJsonAsync<ArtistAlleySystemStatus>("ArtistsAlley/SystemStatus",options);
+            return await http.GetFromJsonAsync<ArtistAlleySystemStatus>("ArtistsAlley/SystemStatus", options);
         }
     }
 }

src/Eurofurence.App.Backoffice/Services/IUserService.cs

@@ -16,6 +16,6 @@ public interface IUserService
         /// <param name="changeRequest"></param>
         /// <returns></returns>
         public Task PutUserArtistAlleyStatusAsync(string userID, ArtistAlleyUserPenaltyChangeRequest changeRequest);
-        
+
     }
 }

src/Eurofurence.App.Common/DataDiffUtils/PatchDefinition.cs

@@ -98,7 +98,7 @@ public PatchDefinition<TSource, TTarget> Map<TField>(
                     if (sourceValue is ICollection &&
                         sourceValue.GetType().IsGenericType)
                         return CollectionsEqual((ICollection)sourceValue, (ICollection)targetValue);
-                     
+
                     return (bool)sourceValue?.Equals(targetValue);
                 },
                 ApplySourceValueToTarget =
@@ -129,7 +129,7 @@ public List<PatchOperation<TTarget>> Patch(IEnumerable<TSource> sources, IEnumer
             {
                 TTarget target;
 
-                var result = new PatchOperation<TTarget> {Action = ActionEnum.NotModified};
+                var result = new PatchOperation<TTarget> { Action = ActionEnum.NotModified };
 
                 var existingTarget = _targetItemLocator(sourceItem, unprocessedTargets);
                 if (existingTarget != null)

src/Eurofurence.App.Common/Eurofurence.App.Common.csproj

@@ -7,4 +7,8 @@
     <GenerateAssemblyCompanyAttribute>false</GenerateAssemblyCompanyAttribute>
     <GenerateAssemblyProductAttribute>false</GenerateAssemblyProductAttribute>
   </PropertyGroup>
+  <Target Name="Husky" BeforeTargets="Restore;CollectPackageReferences" Condition="'$(HUSKY)' != 0">
+    <Exec Command="dotnet tool restore" StandardOutputImportance="Low" StandardErrorImportance="High" />
+    <Exec Command="dotnet husky install" StandardOutputImportance="Low" StandardErrorImportance="High" WorkingDirectory="../.." />
+  </Target>
 </Project>

src/Eurofurence.App.Common/Results/Result.cs

@@ -5,20 +5,20 @@ public class Result : IResult
         public bool IsSuccessful { get; set; }
         public string ErrorMessage { get; set; }
         public string ErrorCode { get; set; }
-        
+
         public static explicit operator bool(Result r) => r.IsSuccessful;
 
-        public static Result Ok => new Result {IsSuccessful = true};
+        public static Result Ok => new Result { IsSuccessful = true };
         public static Result Error(string errorCode, string errorMessage = "")
-            => new Result {IsSuccessful = false, ErrorCode =  errorCode, ErrorMessage = errorMessage};
+            => new Result { IsSuccessful = false, ErrorCode = errorCode, ErrorMessage = errorMessage };
     }
 
     public class Result<T> : Result, IResult<T>
     {
         public T Value { get; set; }
         public static explicit operator T(Result<T> r) => r.Value;
 
-        public new static Result<T> Ok(T value) => new Result<T> {IsSuccessful = true, Value = value};
+        public new static Result<T> Ok(T value) => new Result<T> { IsSuccessful = true, Value = value };
         public new static Result<T> Error(string errorCode, string errorMessage = "")
             => new Result<T> { IsSuccessful = false, ErrorCode = errorCode, ErrorMessage = errorMessage };
     }

src/Eurofurence.App.Common/Validation/BadgeChecksum.cs

@@ -31,7 +31,7 @@ public static bool IsValid(string id)
         public static bool TryParse(string id, out int regNo)
         {
             var numberPart = id.Substring(0, id.Length - 1);
-            var checksumLetter = id[id.Length-1];
+            var checksumLetter = id[id.Length - 1];
 
             if (CHECKSUM_LETTER_MAP.IndexOf(checksumLetter) == -1)
             {

src/Eurofurence.App.Domain.Model/ArtistsAlley/UserStatus/ArtistAlleyUserPenaltyRecord.cs

@@ -61,7 +61,7 @@ public class StateChangeRecord : EntityBase
             [Required]
             [Column("ChangedBy")]
             public string ChangedBy { get; set; }
-        
+
             /// <summary>
             /// The new penalty which was set
             /// </summary>

src/Eurofurence.App.Domain.Model/Communication/PrivateMessageRecord.cs

@@ -9,7 +9,7 @@ public class PrivateMessageRecord : EntityBase
     {
         [DataMember]
         public string RecipientRegSysId { get; set; }
-        
+
         [DataMember]
         public string RecipientIdentityId { get; set; }
 

src/Eurofurence.App.Domain.Model/Eurofurence.App.Domain.Model.csproj

@@ -17,4 +17,8 @@
   <ItemGroup>
     <ProjectReference Include="..\Eurofurence.App.Common\Eurofurence.App.Common.csproj" />
   </ItemGroup>
+  <Target Name="Husky" BeforeTargets="Restore;CollectPackageReferences" Condition="'$(HUSKY)' != 0">
+    <Exec Command="dotnet tool restore" StandardOutputImportance="Low" StandardErrorImportance="High" />
+    <Exec Command="dotnet husky install" StandardOutputImportance="Low" StandardErrorImportance="High" WorkingDirectory="../.." />
+  </Target>
 </Project>

src/Eurofurence.App.Domain.Model/Events/EventRecord.cs

@@ -80,7 +80,7 @@ public class EventRecord : EntityBase
 
         [DataMember]
         public string[] Tags { get; set; }
-        
+
         [JsonIgnore]
         public virtual EventConferenceTrackRecord ConferenceTrack { get; set; }
 

src/Eurofurence.App.Domain.Model/Fragments/LinkFragment.cs

@@ -49,7 +49,7 @@ public override bool Equals(object obj)
             if (obj == null || GetType() != obj.GetType())
                 return false;
 
-            var f = (LinkFragment) obj;
+            var f = (LinkFragment)obj;
 
             return
                 f.FragmentType == FragmentType
@@ -62,7 +62,7 @@ public override int GetHashCode()
         {
             unchecked
             {
-                var hashCode = (int) FragmentType;
+                var hashCode = (int)FragmentType;
                 hashCode = (hashCode * 397) ^ (Name != null ? Name.GetHashCode() : 0);
                 hashCode = (hashCode * 397) ^ (Target != null ? Target.GetHashCode() : 0);
                 return hashCode;

src/Eurofurence.App.Domain.Model/Fursuits/FursuitBadgeRecord.cs

@@ -14,7 +14,7 @@ public class FursuitBadgeRecord : EntityBase
 
         [DataMember]
         [Required]
-        public string OwnerUid { get; set;  }
+        public string OwnerUid { get; set; }
 
         [DataMember]
         [Required]

src/Eurofurence.App.Domain.Model/Images/ImageWithRelationsResponse.cs

@@ -19,7 +19,7 @@ public class ImageWithRelationsResponse : ImageRecord
         [DataMember]
         public List<Guid> TableRegistrationIds { get; set; } = new();
 
-        [DataMember] 
+        [DataMember]
         public List<Guid> MapIds { get; set; } = new();
 
         [DataMember]

src/Eurofurence.App.Domain.Model/Knowledge/KnowledgeEntryRecord.cs

@@ -30,7 +30,7 @@ public class KnowledgeEntryRecord : EntityBase
         [JsonIgnore]
         public KnowledgeGroupRecord KnowledgeGroup { get; set; }
 
-        [DataMember] 
+        [DataMember]
         public virtual List<LinkFragment> Links { get; set; } = new();
 
         [JsonIgnore]

src/Eurofurence.App.Domain.Model/Maps/MapEntryRecord.cs

@@ -32,7 +32,7 @@ public class MapEntryRecord
         [DataMember]
         public int TapRadius { get; set; }
 
-        [DataMember] 
+        [DataMember]
         public List<LinkFragment> Links { get; set; } = new();
 
         [JsonIgnore]

src/Eurofurence.App.Infrastructure.EntityFramework/AppDbContext.cs

@@ -61,7 +61,7 @@ public AppDbContext(DbContextOptions<AppDbContext> options)
         public virtual DbSet<DeviceIdentityRecord> DeviceIdentities { get; set; }
         public virtual DbSet<RegistrationIdentityRecord> RegistrationIdentities { get; set; }
 
-        public virtual DbSet<ArtistAlleyUserPenaltyRecord> ArtistAlleyUserPenalties{ get; set; }
+        public virtual DbSet<ArtistAlleyUserPenaltyRecord> ArtistAlleyUserPenalties { get; set; }
 
         public virtual DbSet<ArtistAlleyUserPenaltyRecord.StateChangeRecord> ArtistAlleyUserPenaltyChanges { get; set; }
         protected override void OnModelCreating(ModelBuilder modelBuilder)

src/Eurofurence.App.Infrastructure.EntityFramework/Eurofurence.App.Infrastructure.EntityFramework.csproj

@@ -23,4 +23,8 @@
   <ItemGroup>
     <ProjectReference Include="..\Eurofurence.App.Domain.Model\Eurofurence.App.Domain.Model.csproj" />
   </ItemGroup>
+  <Target Name="Husky" BeforeTargets="Restore;CollectPackageReferences" Condition="'$(HUSKY)' != 0">
+    <Exec Command="dotnet tool restore" StandardOutputImportance="Low" StandardErrorImportance="High" />
+    <Exec Command="dotnet husky install" StandardOutputImportance="Low" StandardErrorImportance="High" WorkingDirectory="../.." />
+  </Target>
 </Project>

src/Eurofurence.App.Server.Services/Abstractions/Communication/IPrivateMessageService.cs

@@ -24,7 +24,7 @@ Task<Guid> SendPrivateMessageAsync(
             SendPrivateMessageByRegSysRequest request,
             string senderUid = "System",
             CancellationToken cancellationToken = default);
-        
+
         Task<Guid> SendPrivateMessageAsync(
             SendPrivateMessageByIdentityRequest request,
             string senderUid = "System",

src/Eurofurence.App.Server.Services/Abstractions/Fursuits/ICollectingGameService.cs

@@ -14,7 +14,7 @@ public interface ICollectingGameService
         Task<IResult> RegisterTokenForFursuitBadgeForOwnerAsync(string ownerUid, Guid fursuitBadgeId, string tokenValue);
         Task<IResult<CollectTokenResponse>> CollectTokenForPlayerAsync(string identityId, string tokenValue, string username);
 
-        Task<IResult<PlayerScoreboardEntry[]>>  GetPlayerScoreboardEntriesAsync(int top);
+        Task<IResult<PlayerScoreboardEntry[]>> GetPlayerScoreboardEntriesAsync(int top);
         Task<IResult<FursuitScoreboardEntry[]>> GetFursuitScoreboardEntriesAsync(int top);
 
         Task<IResult> CreateTokenFromValueAsync(string tokenValue);

src/Eurofurence.App.Server.Services/Abstractions/Fursuits/PlayerScoreboardEntry.cs

@@ -2,6 +2,6 @@
 {
     public class PlayerScoreboardEntry : ScoreboardEntry
     {
-        
+
     }
 }

src/Eurofurence.App.Server.Services/Abstractions/Lassie/LostAndFoundResponse.cs

@@ -13,7 +13,7 @@ public class LostAndFoundResponse
 
         [JsonPropertyName("title")]
         public string Title { get; set; }
-        
+
         [JsonPropertyName("description")]
         public string Description { get; set; }
 

src/Eurofurence.App.Server.Services/Abstractions/Security/PrincipalExtensions.cs

@@ -14,7 +14,7 @@ public static string[] GetRegSysIds(this ClaimsPrincipal principal)
     {
         return principal.FindAll("RegSysId").Select(x => x.Value).ToArray();
     }
-    
+
     public static string GetName(this ClaimsPrincipal principal)
     {
         return principal.FindFirst("name")?.Value;

src/Eurofurence.App.Server.Services/Abstractions/Telegram/IUserManager.cs

@@ -6,7 +6,7 @@ namespace Eurofurence.App.Server.Services.Abstractions.Telegram
 {
     public interface IUserManager
     {
-        Task<TEnum> GetAclForUserAsync<TEnum>(string username) where TEnum: struct;
+        Task<TEnum> GetAclForUserAsync<TEnum>(string username) where TEnum : struct;
 
         Task SetAclForUserAsync<TEnum>(string username, TEnum acl);
 

src/Eurofurence.App.Server.Services/ArtShow/AgentClosingResultService.cs

@@ -43,7 +43,7 @@ public async Task<ImportResult> ImportAgentClosingResultLogAsync(TextReader logR
             try
             {
                 await _semaphore.WaitAsync();
-                
+
                 var csv = new CsvReader(logReader, CultureInfo.InvariantCulture);
 
                 csv.Context.RegisterClassMap<AgentClosingResultImportRowClassMap>();

src/Eurofurence.App.Server.Services/ArtistsAlley/TableRegistrationService.cs

@@ -109,7 +109,7 @@ public async Task RegisterTableAsync(ClaimsPrincipal user, TableRegistrationRequ
 
             foreach (var registration in activeRegistrations)
             {
-                if (registration.ImageId is {} imageId) await _imageService.DeleteOneAsync(imageId);
+                if (registration.ImageId is { } imageId) await _imageService.DeleteOneAsync(imageId);
                 await DeleteOneAsync(registration.Id);
             }
 
@@ -191,7 +191,7 @@ private async Task BroadcastAsync(TableRegistrationRecord record)
             {
                 message.AppendLine($"Website: {record.WebsiteUrl.RemoveMarkdown()}");
             }
-            
+
             if (record.ImageId.HasValue)
             {
                 await _telegramMessageSender.SendImageToChatAsync(

src/Eurofurence.App.Server.Services/Communication/PrivateMessageQueueService.cs

@@ -23,7 +23,8 @@ public void EnqueueMessage(IPrivateMessageQueueService.QueuedNotificationParamet
             }
         }
 
-        public int GetQueueSize() {
+        public int GetQueueSize()
+        {
             lock (_notificationQueue)
                 return _notificationQueue.Count;
         }

src/Eurofurence.App.Server.Services/Eurofurence.App.Server.Services.csproj

@@ -35,4 +35,8 @@
   <ItemGroup>
     <Folder Include="Properties\" />
   </ItemGroup>
+  <Target Name="Husky" BeforeTargets="Restore;CollectPackageReferences" Condition="'$(HUSKY)' != 0">
+    <Exec Command="dotnet tool restore" StandardOutputImportance="Low" StandardErrorImportance="High" />
+    <Exec Command="dotnet husky install" StandardOutputImportance="Low" StandardErrorImportance="High" WorkingDirectory="../.." />
+  </Target>
 </Project>