💬 Added links to specification rule (#444)

danielmackay · web-flow · commit dda317ccb40c · 2024-11-19T10:47:44.000+11:00
diff --git a/src/Domain/Common/Base/AggregateRoot.cs b/src/Domain/Common/Base/AggregateRoot.cs
@@ -1,7 +1,4 @@
-﻿using SSW.CleanArchitecture.Domain.Common.Interfaces;
-using System.ComponentModel.DataAnnotations.Schema;
-
-namespace SSW.CleanArchitecture.Domain.Common.Base;
+﻿namespace SSW.CleanArchitecture.Domain.Common.Base;
 
 /// <summary>
 /// Cluster of objects treated as a single unit.
diff --git a/src/Domain/Common/Base/Auditable.cs b/src/Domain/Common/Base/Auditable.cs
@@ -1,6 +1,4 @@
-﻿using SSW.CleanArchitecture.Domain.Common.Interfaces;
-
-namespace SSW.CleanArchitecture.Domain.Common.Base;
+﻿namespace SSW.CleanArchitecture.Domain.Common.Base;
 
 /// <summary>
 /// Tracks creation and modification of objects.
diff --git a/src/Domain/Common/EventualConsistency/EventualConsistencyError.cs b/src/Domain/Common/EventualConsistency/EventualConsistencyError.cs
@@ -1,5 +1,3 @@
-using ErrorOr;
-
 namespace SSW.CleanArchitecture.Domain.Common.EventualConsistency;
 
 public static class EventualConsistencyError
diff --git a/src/Domain/Common/EventualConsistency/EventualConsistencyException.cs b/src/Domain/Common/EventualConsistency/EventualConsistencyException.cs
@@ -1,5 +1,3 @@
-using ErrorOr;
-
 namespace SSW.CleanArchitecture.Domain.Common.EventualConsistency;
 
 public class EventualConsistencyException : Exception
diff --git a/src/Domain/GlobalUsings.cs b/src/Domain/GlobalUsings.cs
@@ -1,9 +1,11 @@
 // Global using directives
 
+global using Ardalis.Specification;
 global using static System.ArgumentException;
 global using static System.ArgumentNullException;
 global using static System.ArgumentOutOfRangeException;
 global using SSW.CleanArchitecture.Domain.Common.Base;
 global using SSW.CleanArchitecture.Domain.Common.EventualConsistency;
 global using SSW.CleanArchitecture.Domain.Common.Interfaces;
-global using ErrorOr;
+global using ErrorOr;
+global using Vogen;
diff --git a/src/Domain/Heroes/Hero.cs b/src/Domain/Heroes/Hero.cs
@@ -1,5 +1,4 @@
 ﻿using SSW.CleanArchitecture.Domain.Teams;
-using Vogen;
 
 namespace SSW.CleanArchitecture.Domain.Heroes;
 
diff --git a/src/Domain/Heroes/HeroErrors.cs b/src/Domain/Heroes/HeroErrors.cs
@@ -1,5 +1,3 @@
-using ErrorOr;
-
 namespace SSW.CleanArchitecture.Domain.Heroes;
 
 public static class HeroErrors
diff --git a/src/Domain/Heroes/PowerLevelUpdatedEvent.cs b/src/Domain/Heroes/PowerLevelUpdatedEvent.cs
@@ -1,8 +1,4 @@
-﻿using ErrorOr;
-using SSW.CleanArchitecture.Domain.Common.EventualConsistency;
-using SSW.CleanArchitecture.Domain.Common.Interfaces;
-
-namespace SSW.CleanArchitecture.Domain.Heroes;
+﻿namespace SSW.CleanArchitecture.Domain.Heroes;
 
 public record PowerLevelUpdatedEvent(Hero Hero) : IDomainEvent
 {
diff --git a/src/Domain/Heroes/TeamByIdSpec.cs b/src/Domain/Heroes/TeamByIdSpec.cs
@@ -1,7 +1,6 @@
-﻿using Ardalis.Specification;
-
-namespace SSW.CleanArchitecture.Domain.Heroes;
+﻿namespace SSW.CleanArchitecture.Domain.Heroes;
 
+// For more on the Specification Pattern see: https://www.ssw.com.au/rules/use-specification-pattern/
 public sealed class HeroByIdSpec : SingleResultSpecification<Hero>
 {
     public HeroByIdSpec(HeroId heroId)
diff --git a/src/Domain/Teams/Mission.cs b/src/Domain/Teams/Mission.cs
@@ -1,6 +1,4 @@
-﻿using Vogen;
-
-namespace SSW.CleanArchitecture.Domain.Teams;
+﻿namespace SSW.CleanArchitecture.Domain.Teams;
 
 // For strongly typed IDs, check out the rule: https://www.ssw.com.au/rules/do-you-use-strongly-typed-ids/
 [ValueObject<Guid>]
diff --git a/src/Domain/Teams/MissionErrors.cs b/src/Domain/Teams/MissionErrors.cs
@@ -1,5 +1,3 @@
-using ErrorOr;
-
 namespace SSW.CleanArchitecture.Domain.Teams;
 
 public static class MissionErrors
diff --git a/src/Domain/Teams/Team.cs b/src/Domain/Teams/Team.cs
@@ -1,5 +1,4 @@
 ﻿using SSW.CleanArchitecture.Domain.Heroes;
-using Vogen;
 
 namespace SSW.CleanArchitecture.Domain.Teams;
 
diff --git a/src/Domain/Teams/TeamByIdSpec.cs b/src/Domain/Teams/TeamByIdSpec.cs
@@ -1,7 +1,6 @@
-﻿using Ardalis.Specification;
-
-namespace SSW.CleanArchitecture.Domain.Teams;
+﻿namespace SSW.CleanArchitecture.Domain.Teams;
 
+// For more on the Specification Pattern see: https://www.ssw.com.au/rules/use-specification-pattern/
 public sealed class TeamByIdSpec : SingleResultSpecification<Team>
 {
     public TeamByIdSpec(TeamId teamId)
diff --git a/src/Domain/Teams/TeamErrors.cs b/src/Domain/Teams/TeamErrors.cs
@@ -1,5 +1,3 @@
-using ErrorOr;
-
 namespace SSW.CleanArchitecture.Domain.Teams;
 
 public static class TeamErrors
diff --git a/src/Infrastructure/Middleware/EventualConsistencyMiddleware.cs b/src/Infrastructure/Middleware/EventualConsistencyMiddleware.cs
@@ -1,11 +1,9 @@
 using MediatR;
 using Microsoft.AspNetCore.Http;
 using Microsoft.EntityFrameworkCore;
-using Microsoft.EntityFrameworkCore.Storage;
 using SSW.CleanArchitecture.Domain.Common.EventualConsistency;
 using SSW.CleanArchitecture.Domain.Common.Interfaces;
 using SSW.CleanArchitecture.Infrastructure.Persistence;
-using System.Transactions;
 
 namespace SSW.CleanArchitecture.Infrastructure.Middleware;
 
diff --git a/tools/MigrationService/Worker.cs b/tools/MigrationService/Worker.cs
@@ -1,5 +1,4 @@
 using MigrationService.Initializers;
-using OpenTelemetry.Trace;
 using System.Diagnostics;
 
 namespace MigrationService;

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,3 @@`
`1`		`-using ErrorOr;`
`2`		`-`
`3`	`1`	`namespace SSW.CleanArchitecture.Domain.Common.EventualConsistency;`
`4`	`2`
`5`	`3`	`public static class EventualConsistencyError`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,4 @@`
`1`	`1`	`using SSW.CleanArchitecture.Domain.Teams;`
`2`		`-using Vogen;`
`3`	`2`
`4`	`3`	`namespace SSW.CleanArchitecture.Domain.Heroes;`
`5`	`4`
Original file line number	Diff line number	Diff line change
`@@ -1,8 +1,4 @@`
`1`		`-using ErrorOr;`
`2`		`-using SSW.CleanArchitecture.Domain.Common.EventualConsistency;`
`3`		`-using SSW.CleanArchitecture.Domain.Common.Interfaces;`
`4`		`-`
`5`		`-namespace SSW.CleanArchitecture.Domain.Heroes;`
	`1`	`+namespace SSW.CleanArchitecture.Domain.Heroes;`
`6`	`2`
`7`	`3`	`public record PowerLevelUpdatedEvent(Hero Hero) : IDomainEvent`
`8`	`4`	`{`
Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,6 @@`
`1`		`-using Ardalis.Specification;`
`2`		`-`
`3`		`-namespace SSW.CleanArchitecture.Domain.Heroes;`
	`1`	`+namespace SSW.CleanArchitecture.Domain.Heroes;`
`4`	`2`
	`3`	`+// For more on the Specification Pattern see: https://www.ssw.com.au/rules/use-specification-pattern/`
`5`	`4`	`public sealed class HeroByIdSpec : SingleResultSpecification<Hero>`
`6`	`5`	`{`
`7`	`6`	`public HeroByIdSpec(HeroId heroId)`