✨ 53 dotnet cli template (#55)

* Added assembly name and namespaces to all libraries * Fixed up namespaces * Trying to get integration tests to work * Added nuget nuspec file * Added GitHub package workflow * Added read me instructions for publishing the nuget package * Allow manual workflow trigger * Update action trigger * Remove skip duplicate package * Add manual trigger back * Updated version * Fixed build * Update package version * Reverted build pipeline settings * Removed angular from nuspec * Update nuspec description Co-authored-by: William Liebenberg <[email protected]> * Update src/Application/Application.csproj Co-authored-by: William Liebenberg <[email protected]> * Update src/Application/Application.csproj Co-authored-by: William Liebenberg <[email protected]> * Update src/Application/Common/Behaviours/LoggingBehaviour.cs Co-authored-by: William Liebenberg <[email protected]> * Added SSW to namespaces and assembly names --------- Co-authored-by: William Liebenberg <[email protected]>
SSWConsulting · May 22, 2023 · 591fdc5 · 591fdc5
1 parent aafbadf
commit 591fdc5
Show file tree

Hide file tree

Showing 64 changed files with 380 additions and 248 deletions.
diff --git a/.github/workflows/package.yml b/.github/workflows/package.yml
@@ -0,0 +1,23 @@
+name: Package
+on:
+ push:
+ branches:
+ - main
+ paths:
+ - 'CleanArchitecture.nuspec'
+jobs:
+ publish:
+ name: Publish to NuGet.org
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@v2
+
+ - uses: nuget/setup-nuget@v1
+ with:
+ nuget-version: '6.x'
+
+ - name: Create the package
+ run: nuget pack CleanArchitecture.nuspec -NoDefaultExcludes
+
+ - name: Publish the package
+ run: nuget push *.nupkg -Source 'https://api.nuget.org/v3/index.json' -ApiKey ${{secrets.NUGET_API_KEY}} 
diff --git a/.template.config/template.json b/.template.config/template.json
@@ -0,0 +1,44 @@
+{
+ "$schema": "http://json.schemastore.org/template",
+ "author": "SSW",
+ "classifications": [
+ "Web",
+ "SPA",
+ "API",
+ ".NET",
+ "ASP.NET Core",
+ "EF Core",
+ "SSW",
+ "Clean Architecture"
+ ],
+ "name": "SSW Clean Architecture Solution",
+ "description": "",
+ "identity": "SSW.Clean.Architecture.Solution.CSharp",
+ "groupIdentity": "SSW.Clean.Architecture.Solution",
+ "shortName": "ssw-ca",
+ "tags": {
+ "language": "C#",
+ "type": "project"
+ },
+ "sourceName": "SSW.CleanArchitecture",
+ "preferNameDirectory": true,
+ "sources": [
+ {
+ "source": "./",
+ "target": "./",
+ "exclude": [
+ "README.md",
+ "**/[Bb]in/**",
+ "**/[Oo]bj/**",
+ ".template.config/**/*",
+ ".vs/**/*",
+ "**/*.filelist",
+ "**/*.user",
+ "**/*.lock.json",
+ "**/.git/**",
+ "*.nuspec",
+ "**/node_modules/**"
+ ]
+ }
+ ]
+}
diff --git a/CleanArchitecture.nuspec b/CleanArchitecture.nuspec
@@ -0,0 +1,35 @@
+<?xml version="1.0" encoding="utf-8"?>
+<package xmlns="http://schemas.microsoft.com/packaging/2012/06/nuspec.xsd">
+ <metadata>
+
+ <id>SSW.CleanArchitecture.Template</id>
+ <version>0.2.3</version>
+ <title>SSW Clean Architecture Template</title>
+ <authors>SSW</authors>
+ <description>SSW Clean Architecture Solution Template for .NET.</description>
+ <summary>
+ This is a solution template for creating a WebAPI with ASP.NET Core following the principles of Clean Architecture.
+ </summary>
+ <releaseNotes>
+ </releaseNotes>
+
+ <projectUrl>https://github.com/SSWConsulting/CleanArchitectureV2</projectUrl>
+ <repository type="git" url="https://github.com/SSWConsulting/CleanArchitectureV2.git" branch="main" />
+
+ <license type="expression">MIT</license>
+ <requireLicenseAcceptance>false</requireLicenseAcceptance>
+ <tags>clean-architecture project template csharp dotnet ssw</tags>
+ <readme>README.md</readme>
+
+ <packageTypes>
+ <packageType name="Template" />
+ </packageTypes>
+
+ </metadata>
+
+ <files>
+ <file src="README.md" />
+ <file src=".\**" target="content" exclude="**\bin\**;**\obj\**;**\.vs\**;**\.vscode\**;**\.git\**;**\.github\**;**\LICENSE;" />
+ </files>
+
+</package>
diff --git a/CleanArchitecture.sln b/CleanArchitecture.sln
@@ -15,6 +15,7 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution
  ProjectSection(SolutionItems) = preProject
  .editorconfig = .editorconfig
  .gitignore = .gitignore
+ CleanArchitecture.nuspec = CleanArchitecture.nuspec
  Directory.Build.Props = Directory.Build.Props
  docker-compose.yml = docker-compose.yml
  global.json = global.json

diff --git a/README.md b/README.md
@@ -102,3 +102,13 @@
  - you will know when your tests pass when they should have failed
  - Inserts bugs into the production code to make sure our tests are effective and testing the right behavior
  - Using [Stryker Mutator](https://stryker-mutator.io/)
+
+## Publishing Template
+
+Template will be published to NuGet.org when changes are made to `CleanArchitecture.nuspec` on the `main` branch.
+
+### Process
+
+1. Update the `version` attribute in `CleanArchitecture.nuspec`
+2. Merge your PR
+3. `package` GitHub Action will run and publish the new version to NuGet.org
diff --git a/src/Application/Application.csproj b/src/Application/Application.csproj
@@ -2,6 +2,8 @@
 
  <PropertyGroup>
  <TargetFramework>net7.0</TargetFramework>
+ <RootNamespace>SSW.CleanArchitecture.Application</RootNamespace>
+ <AssemblyName>SSW.CleanArchitecture.Application</AssemblyName>
  <ImplicitUsings>enable</ImplicitUsings>
  <Nullable>enable</Nullable>
  </PropertyGroup>

diff --git a/src/Application/Common/Behaviours/LoggingBehaviour.cs b/src/Application/Common/Behaviours/LoggingBehaviour.cs
@@ -1,8 +1,8 @@
-using Application.Common.Interfaces;
+using SSW.CleanArchitecture.Application.Common.Interfaces;
 using MediatR.Pipeline;
 using Microsoft.Extensions.Logging;
 
-namespace CleanArchitecture.Application.Common.Behaviours;
+namespace SSW.CleanArchitecture.Application.Common.Behaviours;
 
 public class LoggingBehaviour<TRequest> : IRequestPreProcessor<TRequest> where TRequest : notnull
 {

diff --git a/src/Application/Common/Behaviours/PerformanceBehaviour.cs b/src/Application/Common/Behaviours/PerformanceBehaviour.cs
@@ -1,8 +1,8 @@
 using System.Diagnostics;
-using Application.Common.Interfaces;
 using Microsoft.Extensions.Logging;
+using SSW.CleanArchitecture.Application.Common.Interfaces;
 
-namespace CleanArchitecture.Application.Common.Behaviours;
+namespace SSW.CleanArchitecture.Application.Common.Behaviours;
 
 public class PerformanceBehaviour<TRequest, TResponse> : IPipelineBehavior<TRequest, TResponse> where TRequest : notnull
 {

diff --git a/src/Application/Common/Behaviours/UnhandledExceptionBehaviour.cs b/src/Application/Common/Behaviours/UnhandledExceptionBehaviour.cs
@@ -1,6 +1,6 @@
 using Microsoft.Extensions.Logging;
 
-namespace CleanArchitecture.Application.Common.Behaviours;
+namespace SSW.CleanArchitecture.Application.Common.Behaviours;
 
 public class UnhandledExceptionBehaviour<TRequest, TResponse> : IPipelineBehavior<TRequest, TResponse> where TRequest : notnull
 {

diff --git a/src/Application/Common/Behaviours/ValidationBehaviour.cs b/src/Application/Common/Behaviours/ValidationBehaviour.cs
@@ -1,4 +1,4 @@
-namespace CleanArchitecture.Application.Common.Behaviours;
+namespace SSW.CleanArchitecture.Application.Common.Behaviours;
 
 public class ValidationBehaviour<TRequest, TResponse> : IPipelineBehavior<TRequest, TResponse>
  where TRequest : notnull

diff --git a/src/Application/Common/Exceptions/NotFoundException.cs b/src/Application/Common/Exceptions/NotFoundException.cs
@@ -1,4 +1,4 @@
-namespace CleanArchitecture.Application.Common.Exceptions;
+namespace SSW.CleanArchitecture.Application.Common.Exceptions;
 
 public class NotFoundException : Exception
 {

diff --git a/src/Application/Common/Exceptions/ValidationException.cs b/src/Application/Common/Exceptions/ValidationException.cs
@@ -1,6 +1,6 @@
 using FluentValidation.Results;
 
-namespace CleanArchitecture.Application.Common.Exceptions;
+namespace SSW.CleanArchitecture.Application.Common.Exceptions;
 
 public class ValidationException : Exception
 {

diff --git a/src/Application/Common/Interfaces/ICurrentUserService.cs b/src/Application/Common/Interfaces/ICurrentUserService.cs
@@ -1,4 +1,4 @@
-namespace Application.Common.Interfaces;
+namespace SSW.CleanArchitecture.Application.Common.Interfaces;
 
 public interface ICurrentUserService
 {

diff --git a/src/Application/Common/Interfaces/IDateTime.cs b/src/Application/Common/Interfaces/IDateTime.cs
@@ -1,4 +1,4 @@
-namespace Application.Common.Interfaces;
+namespace SSW.CleanArchitecture.Application.Common.Interfaces;
 
 public interface IDateTime
 {

diff --git a/src/Application/DependencyInjection.cs b/src/Application/DependencyInjection.cs
@@ -1,7 +1,7 @@
-using CleanArchitecture.Application.Common.Behaviours;
-using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.DependencyInjection;
+using SSW.CleanArchitecture.Application.Common.Behaviours;
 
-namespace Application;
+namespace SSW.CleanArchitecture.Application;
 
 public static class DependencyInjection
 {

diff --git a/src/Application/Features/TodoItems/Commands/CreateTodoItem/CreateTodoItemCommand.cs b/src/Application/Features/TodoItems/Commands/CreateTodoItem/CreateTodoItemCommand.cs
@@ -1,9 +1,9 @@
-using Application.Features.TodoItems.Specifications;
-using Ardalis.Specification;
-using Domain.Entities;
-using Domain.Events;
+using Ardalis.Specification;
+using SSW.CleanArchitecture.Application.Features.TodoItems.Specifications;
+using SSW.CleanArchitecture.Domain.Events;
+using SSW.CleanArchitecture.Domain.Entities;
 
-namespace Application.Features.TodoItems.Commands.CreateTodoItem;
+namespace SSW.CleanArchitecture.Application.Features.TodoItems.Commands.CreateTodoItem;
 
 public record CreateTodoItemCommand(string? Title) : IRequest<Guid>;
 

diff --git a/src/Application/Features/TodoItems/Commands/CreateTodoItem/CreateTodoItemMapping.cs b/src/Application/Features/TodoItems/Commands/CreateTodoItem/CreateTodoItemMapping.cs
@@ -1,9 +1,11 @@
-namespace Application.Features.TodoItems.Commands.CreateTodoItem;
+using SSW.CleanArchitecture.Domain.Entities;
+
+namespace SSW.CleanArchitecture.Application.Features.TodoItems.Commands.CreateTodoItem;
 
 public class CreateTodoItemMapping : Profile
 {
  public CreateTodoItemMapping()
  {
- CreateMap<CreateTodoItemCommand, Domain.Entities.TodoItem>();
+ CreateMap<CreateTodoItemCommand, TodoItem>();
  }
 }
diff --git a/src/Application/Features/TodoItems/EventHandlers/TodoItemCreatedEventHandler.cs b/src/Application/Features/TodoItems/EventHandlers/TodoItemCreatedEventHandler.cs
@@ -1,8 +1,7 @@
-using Application.Features.TodoItems.Commands.CreateTodoItem;
-using Domain.Events;
-using Microsoft.Extensions.Logging;
+using Microsoft.Extensions.Logging;
+using SSW.CleanArchitecture.Domain.Events;
 
-namespace Application.Features.TodoItems.EventHandlers;
+namespace SSW.CleanArchitecture.Application.Features.TodoItems.EventHandlers;
 
 public class TodoItemCreatedEventHandler : INotificationHandler<TodoItemCreatedEvent>
 {

diff --git a/src/Application/Features/TodoItems/Queries/GetAllTodoItems/GetAllTodoItemsMapping.cs b/src/Application/Features/TodoItems/Queries/GetAllTodoItems/GetAllTodoItemsMapping.cs
@@ -1,10 +1,12 @@
-namespace Application.Features.TodoItems.Queries.GetAllTodoItems;
+using SSW.CleanArchitecture.Domain.Entities;
+
+namespace SSW.CleanArchitecture.Application.Features.TodoItems.Queries.GetAllTodoItems;
 
 public class GetAllTodoItemsMapping : Profile
 {
  public GetAllTodoItemsMapping()
  {
- CreateMap<Domain.Entities.TodoItem, TodoItemDto>()
+ CreateMap<TodoItem, TodoItemDto>()
  .ForMember(d => d.Id, opt => opt.MapFrom(s => s.Id.Value));
  }
 }
diff --git a/src/Application/Features/TodoItems/Queries/GetAllTodoItems/GetAllTodoItemsQuery.cs b/src/Application/Features/TodoItems/Queries/GetAllTodoItems/GetAllTodoItemsQuery.cs
@@ -1,8 +1,8 @@
-using Application.Features.TodoItems.Specifications;
 using Ardalis.Specification;
-using Domain.Entities;
+using SSW.CleanArchitecture.Application.Features.TodoItems.Specifications;
+using SSW.CleanArchitecture.Domain.Entities;
 
-namespace Application.Features.TodoItems.Queries.GetAllTodoItems;
+namespace SSW.CleanArchitecture.Application.Features.TodoItems.Queries.GetAllTodoItems;
 
 public record GetAllTodoItemsQuery : IRequest<IReadOnlyList<TodoItemDto>>;
 

diff --git a/src/Application/Features/TodoItems/Queries/GetAllTodoItems/TodoItemDto.cs b/src/Application/Features/TodoItems/Queries/GetAllTodoItems/TodoItemDto.cs
@@ -1,4 +1,4 @@
-namespace Application.Features.TodoItems.Queries.GetAllTodoItems;
+namespace SSW.CleanArchitecture.Application.Features.TodoItems.Queries.GetAllTodoItems;
 
 public class TodoItemDto
 {

diff --git a/src/Application/Features/TodoItems/Specifications/AllTodoItemSpec.cs b/src/Application/Features/TodoItems/Specifications/AllTodoItemSpec.cs
@@ -1,7 +1,7 @@
 using Ardalis.Specification;
-using Domain.Entities;
+using SSW.CleanArchitecture.Domain.Entities;
 
-namespace Application.Features.TodoItems.Specifications;
+namespace SSW.CleanArchitecture.Application.Features.TodoItems.Specifications;
 
 public sealed class AllTodoItemSpec : Specification<TodoItem>
 {

diff --git a/src/Application/Features/TodoItems/Specifications/TodoItemByTitleSpec.cs b/src/Application/Features/TodoItems/Specifications/TodoItemByTitleSpec.cs
@@ -1,7 +1,7 @@
 using Ardalis.Specification;
-using Domain.Entities;
+using SSW.CleanArchitecture.Domain.Entities;
 
-namespace Application.Features.TodoItems.Specifications;
+namespace SSW.CleanArchitecture.Application.Features.TodoItems.Specifications;
 
 public sealed class TodoItemByTitleSpec : Specification<TodoItem>
 {

diff --git a/src/Domain/Common/AuditableEntity.cs b/src/Domain/Common/AuditableEntity.cs
@@ -1,4 +1,4 @@
-namespace Domain.Common;
+namespace SSW.CleanArchitecture.Domain.Common;
 
 public abstract class AuditableEntity
 {

diff --git a/src/Domain/Common/BaseEntity.cs b/src/Domain/Common/BaseEntity.cs
@@ -1,6 +1,6 @@
 using System.ComponentModel.DataAnnotations.Schema;
 
-namespace Domain.Common;
+namespace SSW.CleanArchitecture.Domain.Common;
 
 public abstract class BaseEntity<TId> : AuditableEntity, IDomainEvents
 {

diff --git a/src/Domain/Common/BaseEvent.cs b/src/Domain/Common/BaseEvent.cs
@@ -1,5 +1,5 @@
 using MediatR;
 
-namespace Domain.Common;
+namespace SSW.CleanArchitecture.Domain.Common;
 
 public record BaseEvent : INotification;
diff --git a/src/Domain/Common/IDomainEvents.cs b/src/Domain/Common/IDomainEvents.cs
@@ -1,4 +1,4 @@
-namespace Domain.Common;
+namespace SSW.CleanArchitecture.Domain.Common;
 
 public interface IDomainEvents
 {

diff --git a/src/Domain/Domain.csproj b/src/Domain/Domain.csproj
@@ -3,6 +3,8 @@
  <PropertyGroup>
  <TargetFramework>net7.0</TargetFramework>
  <ImplicitUsings>enable</ImplicitUsings>
+ <RootNamespace>SSW.CleanArchitecture.Domain</RootNamespace>
+ <AssemblyName>SSW.CleanArchitecture.Domain</AssemblyName>
  <Nullable>enable</Nullable>
  </PropertyGroup>
 

diff --git a/src/Domain/Entities/TodoItem.cs b/src/Domain/Entities/TodoItem.cs
@@ -1,4 +1,7 @@
-namespace Domain.Entities;
+using SSW.CleanArchitecture.Domain.Common;
+using SSW.CleanArchitecture.Domain.Enum;
+
+namespace SSW.CleanArchitecture.Domain.Entities;
 
 
 public record TodoItemId(Guid Value);

diff --git a/src/Domain/Enum/PriorityLevel.cs b/src/Domain/Enum/PriorityLevel.cs
@@ -1,4 +1,4 @@
-namespace Domain.Enum;
+namespace SSW.CleanArchitecture.Domain.Enum;
 
 public enum PriorityLevel
 {

diff --git a/src/Domain/Events/TodoItemCreatedEvent.cs b/src/Domain/Events/TodoItemCreatedEvent.cs
@@ -1,5 +1,6 @@
-using Domain.Entities;
+using SSW.CleanArchitecture.Domain.Common;
+using SSW.CleanArchitecture.Domain.Entities;
 
-namespace Domain.Events;
+namespace SSW.CleanArchitecture.Domain.Events;
 
 public record TodoItemCreatedEvent(TodoItem Item) : BaseEvent;
diff --git a/src/Domain/GlobalUsing.cs b/src/Domain/GlobalUsing.cs
@@ -1,2 +1,2 @@
-global using Domain.Common;
-global using Domain.Enum;
+global using SSW.CleanArchitecture.Domain.Common;
+global using SSW.CleanArchitecture.Domain.Enum;
diff --git a/src/Infrastructure/DependencyInjection.cs b/src/Infrastructure/DependencyInjection.cs
@@ -1,13 +1,13 @@
-using Application.Common.Interfaces;
-using Ardalis.Specification;
-using Infrastructure.Persistence;
-using Infrastructure.Persistence.Interceptors;
-using Infrastructure.Services;
+using Ardalis.Specification;
 using Microsoft.EntityFrameworkCore;
 using Microsoft.Extensions.Configuration;
 using Microsoft.Extensions.DependencyInjection;
+using SSW.CleanArchitecture.Application.Common.Interfaces;
+using SSW.CleanArchitecture.Infrastructure.Persistence;
+using SSW.CleanArchitecture.Infrastructure.Persistence.Interceptors;
+using SSW.CleanArchitecture.Infrastructure.Services;
 
-namespace Infrastructure;
+namespace SSW.CleanArchitecture.Infrastructure;
 
 public static class DependencyInjection
 {