Skip to content

Commit 1cbc479

Browse files
ardalisardalis
authored
Add Single Project VSA Clean Architecture Template (#975)
* Update AspireHost name and Project file * add initial minimalclean template * Structured logging set up properly Updated reference to Ardalis.SharedKernel * update nuget version for minclean
1 parent fa5ec9c commit 1cbc479

File tree

105 files changed

+4394
-16
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

105 files changed

+4394
-16
lines changed

‎.github/workflows/dotnetcore.yml‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,9 @@ jobs:
1717
uses: actions/setup-dotnet@v5
1818
with:
1919
dotnet-version: '10.0.x'
20-
- name: Build with dotnet
20+
- name: Build Full Template
2121
run: dotnet build ./Clean.Architecture.slnx -c Release
22-
- name: Test with dotnet
22+
- name: Test Full Template
2323
run: dotnet test ./Clean.Architecture.slnx -c Release --no-build --verbosity normal
24+
- name: Build MinimalClean Template
25+
run: dotnet build ./MinimalClean/MinimalClean.Architecture.slnx -c Release

‎.github/workflows/publish-templates.yml‎

Lines changed: 132 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,132 @@
1+
name: Publish Templates to NuGet
2+
3+
on:
4+
workflow_dispatch:
5+
inputs:
6+
publish-full:
7+
description: 'Publish Full Clean Architecture Template'
8+
required: true
9+
type: boolean
10+
default: false
11+
publish-minimal:
12+
description: 'Publish Minimal Clean Architecture Template'
13+
required: true
14+
type: boolean
15+
default: false
16+
push:
17+
tags:
18+
- 'v*'
19+
release:
20+
types: [published]
21+
22+
env:
23+
DOTNET_VERSION: '10.0.x'
24+
PACK_OUTPUT: artifacts/packages
25+
26+
jobs:
27+
build-and-test:
28+
runs-on: ubuntu-latest
29+
30+
steps:
31+
- name: Checkout
32+
uses: actions/checkout@v4
33+
34+
- name: Setup .NET
35+
uses: actions/setup-dotnet@v4
36+
with:
37+
dotnet-version: ${{ env.DOTNET_VERSION }}
38+
39+
- name: Build Full Template Solution
40+
run: dotnet build ./Clean.Architecture.slnx -c Release
41+
42+
- name: Test Full Template
43+
run: dotnet test ./Clean.Architecture.slnx -c Release --no-build --verbosity normal
44+
45+
- name: Build MinimalClean Template Solution
46+
run: dotnet build ./MinimalClean/MinimalClean.Architecture.slnx -c Release
47+
48+
- name: Test Template Installations
49+
shell: pwsh
50+
run: |
51+
# Test Full Template
52+
Write-Host "Testing Full Clean Architecture Template..."
53+
dotnet new install .
54+
dotnet new clean-arch -o TestFullTemplate
55+
dotnet build TestFullTemplate/TestFullTemplate.slnx
56+
dotnet new uninstall Ardalis.CleanArchitecture.Template
57+
Remove-Item -Recurse -Force TestFullTemplate
58+
59+
# Test Minimal Template
60+
Write-Host "Testing Minimal Clean Architecture Template..."
61+
dotnet new install ./MinimalClean
62+
dotnet new min-clean -o TestMinimalTemplate
63+
dotnet build TestMinimalTemplate/TestMinimalTemplate.slnx
64+
dotnet new uninstall Ardalis.MinimalClean.Template
65+
Remove-Item -Recurse -Force TestMinimalTemplate
66+
67+
package:
68+
needs: build-and-test
69+
runs-on: ubuntu-latest
70+
71+
steps:
72+
- name: Checkout
73+
uses: actions/checkout@v4
74+
75+
- name: Setup NuGet
76+
uses: nuget/setup-nuget@v2
77+
with:
78+
nuget-version: 'latest'
79+
80+
- name: Create output directory
81+
run: mkdir -p ${{ env.PACK_OUTPUT }}
82+
83+
- name: Pack Full Template
84+
if: ${{ github.event_name == 'release' || github.event.inputs.publish-full == 'true' }}
85+
run: nuget pack CleanArchitecture.nuspec -OutputDirectory ${{ env.PACK_OUTPUT }} -NoDefaultExcludes
86+
87+
- name: Pack Minimal Template
88+
if: ${{ github.event_name == 'release' || github.event.inputs.publish-minimal == 'true' }}
89+
run: nuget pack MinimalClean.nuspec -OutputDirectory ${{ env.PACK_OUTPUT }} -NoDefaultExcludes
90+
91+
- name: Upload packages as artifacts
92+
uses: actions/upload-artifact@v4
93+
with:
94+
name: nuget-packages
95+
path: ${{ env.PACK_OUTPUT }}/*.nupkg
96+
97+
publish:
98+
needs: package
99+
runs-on: ubuntu-latest
100+
if: ${{ github.event_name == 'release' && github.event.action == 'published' }}
101+
permissions:
102+
contents: read
103+
id-token: write
104+
105+
steps:
106+
- name: Download packages
107+
uses: actions/download-artifact@v4
108+
with:
109+
name: nuget-packages
110+
path: ${{ env.PACK_OUTPUT }}
111+
112+
- name: Setup .NET
113+
uses: actions/setup-dotnet@v4
114+
with:
115+
dotnet-version: ${{ env.DOTNET_VERSION }}
116+
117+
- name: NuGet login (OIDC)
118+
uses: NuGet/login@v1
119+
id: login
120+
with:
121+
user: ${{ secrets.NUGET_USER }}
122+
123+
- name: Push packages to NuGet
124+
shell: pwsh
125+
run: |
126+
Get-ChildItem "${{ env.PACK_OUTPUT }}" -Filter *.nupkg | ForEach-Object {
127+
Write-Host "Publishing $($_.Name)..."
128+
dotnet nuget push $_.FullName `
129+
--api-key "${{ steps.login.outputs.NUGET_API_KEY }}" `
130+
--source https://api.nuget.org/v3/index.json `
131+
--skip-duplicate
132+
}

‎MinimalClean.nuspec‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<package xmlns="http://schemas.microsoft.com/packaging/2010/07/nuspec.xsd">
3+
<metadata>
4+
<id>Ardalis.MinimalClean.Template</id>
5+
<title>ASP.NET Minimal Clean Architecture Solution</title>
6+
<version>1.0.0-beta1</version>
7+
<authors>Steve Smith</authors>
8+
<description>
9+
A simplified Clean Architecture template using vertical slice architecture in a single project.
10+
Perfect for MVPs, smaller applications, or teams wanting architectural guidance without multi-project complexity.
11+
Features Domain-Driven Design patterns, FastEndpoints, Entity Framework Core, and optional Aspire support.
12+
Built with .NET 10 and C# 13.
13+
</description>
14+
<language>en-US</language>
15+
<license type="expression">MIT</license>
16+
<projectUrl>https://github.com/ardalis/CleanArchitecture</projectUrl>
17+
<releaseNotes>
18+
* Initial release of Minimal Clean Architecture template
19+
* Single-project vertical slice architecture
20+
* Built with .NET 10 and C# 13
21+
* FastEndpoints for REPR pattern
22+
* Pragmatic DDD with simplified patterns
23+
* Optional Aspire support
24+
</releaseNotes>
25+
<packageTypes>
26+
<packageType name="Template" />
27+
</packageTypes>
28+
<tags>Web ASP.NET "Clean Architecture" "Vertical Slice" minimal ddd domain-driven-design clean-architecture ardalis FastEndpoints</tags>
29+
<icon>./content/icon.png</icon>
30+
<readme>README.md</readme>
31+
</metadata>
32+
<files>
33+
<file src="MinimalClean\**" target="content" exclude="**\bin\**;**\obj\**;**\.git\**;**\.vs\**;**\.vscode\**;**\*.user" />
34+
<file src="README.md" />
35+
<file src="icon.png" target="content" />
36+
</files>
37+
</package>

‎MinimalClean/.editorconfig‎

Lines changed: 151 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,151 @@
1+
###############################
2+
# Core EditorConfig Options #
3+
###############################
4+
root = true
5+
# All files
6+
[*]
7+
indent_style = space
8+
9+
# XML project files
10+
[*.{csproj,vbproj,vcxproj,vcxproj.filters,proj,projitems,shproj}]
11+
indent_size = 2
12+
13+
# XML config files
14+
[*.{props,targets,ruleset,config,nuspec,resx,vsixmanifest,vsct}]
15+
indent_size = 2
16+
17+
# Code files
18+
[*.{cs,csx,vb,vbx}]
19+
indent_size = 2
20+
insert_final_newline = true
21+
charset = utf-8-bom
22+
###############################
23+
# .NET Coding Conventions #
24+
###############################
25+
[*.{cs,vb}]
26+
# Organize usings
27+
dotnet_sort_system_directives_first = true
28+
# this. preferences
29+
dotnet_style_qualification_for_field = false:silent
30+
dotnet_style_qualification_for_property = false:silent
31+
dotnet_style_qualification_for_method = false:silent
32+
dotnet_style_qualification_for_event = false:silent
33+
# Language keywords vs BCL types preferences
34+
dotnet_style_predefined_type_for_locals_parameters_members = true:silent
35+
dotnet_style_predefined_type_for_member_access = true:silent
36+
# Parentheses preferences
37+
dotnet_style_parentheses_in_arithmetic_binary_operators = always_for_clarity:silent
38+
dotnet_style_parentheses_in_relational_binary_operators = always_for_clarity:silent
39+
dotnet_style_parentheses_in_other_binary_operators = always_for_clarity:silent
40+
dotnet_style_parentheses_in_other_operators = never_if_unnecessary:silent
41+
# Modifier preferences
42+
dotnet_style_require_accessibility_modifiers = for_non_interface_members:silent
43+
dotnet_style_readonly_field = true:suggestion
44+
# Expression-level preferences
45+
dotnet_style_object_initializer = true:suggestion
46+
dotnet_style_collection_initializer = true:suggestion
47+
dotnet_style_explicit_tuple_names = true:suggestion
48+
dotnet_style_null_propagation = true:suggestion
49+
dotnet_style_coalesce_expression = true:suggestion
50+
dotnet_style_prefer_is_null_check_over_reference_equality_method = true:silent
51+
dotnet_style_prefer_inferred_tuple_names = true:suggestion
52+
dotnet_style_prefer_inferred_anonymous_type_member_names = true:suggestion
53+
dotnet_style_prefer_auto_properties = true:silent
54+
dotnet_style_prefer_conditional_expression_over_assignment = true:silent
55+
dotnet_style_prefer_conditional_expression_over_return = true:silent
56+
###############################
57+
# Naming Conventions #
58+
###############################
59+
# Style Definitions
60+
dotnet_naming_style.pascal_case_style.capitalization = pascal_case
61+
# Use PascalCase for constant fields
62+
dotnet_naming_rule.constant_fields_should_be_pascal_case.severity = suggestion
63+
dotnet_naming_rule.constant_fields_should_be_pascal_case.symbols = constant_fields
64+
dotnet_naming_rule.constant_fields_should_be_pascal_case.style = pascal_case_style
65+
dotnet_naming_symbols.constant_fields.applicable_kinds = field
66+
dotnet_naming_symbols.constant_fields.applicable_accessibilities = *
67+
dotnet_naming_symbols.constant_fields.required_modifiers = const
68+
tab_width= 2
69+
dotnet_naming_rule.private_members_with_underscore.symbols = private_fields
70+
dotnet_naming_rule.private_members_with_underscore.style = prefix_underscore
71+
dotnet_naming_rule.private_members_with_underscore.severity = suggestion
72+
dotnet_naming_symbols.private_fields.applicable_kinds = field
73+
dotnet_naming_symbols.private_fields.applicable_accessibilities = private
74+
dotnet_naming_style.prefix_underscore.capitalization = camel_case
75+
dotnet_naming_style.prefix_underscore.required_prefix = _
76+
dotnet_style_operator_placement_when_wrapping = beginning_of_line
77+
end_of_line = crlf
78+
###############################
79+
# C# Coding Conventions #
80+
###############################
81+
[*.cs]
82+
# var preferences
83+
csharp_style_var_for_built_in_types = true:silent
84+
csharp_style_var_when_type_is_apparent = true:silent
85+
csharp_style_var_elsewhere = true:silent
86+
# Expression-bodied members
87+
csharp_style_expression_bodied_methods = false:silent
88+
csharp_style_expression_bodied_constructors = false:silent
89+
csharp_style_expression_bodied_operators = false:silent
90+
csharp_style_expression_bodied_properties = true:silent
91+
csharp_style_expression_bodied_indexers = true:silent
92+
csharp_style_expression_bodied_accessors = true:silent
93+
# Pattern matching preferences
94+
csharp_style_pattern_matching_over_is_with_cast_check = true:suggestion
95+
csharp_style_pattern_matching_over_as_with_null_check = true:suggestion
96+
# Null-checking preferences
97+
csharp_style_throw_expression = true:suggestion
98+
csharp_style_conditional_delegate_call = true:suggestion
99+
# Modifier preferences
100+
csharp_preferred_modifier_order = public,private,protected,internal,static,extern,new,virtual,abstract,sealed,override,readonly,unsafe,volatile,async:suggestion
101+
# Expression-level preferences
102+
csharp_prefer_braces = true:silent
103+
csharp_style_deconstructed_variable_declaration = true:suggestion
104+
csharp_prefer_simple_default_expression = true:suggestion
105+
csharp_style_pattern_local_over_anonymous_function = true:suggestion
106+
csharp_style_inlined_variable_declaration = true:suggestion
107+
# Namespaces
108+
csharp_style_namespace_declarations = file_scoped:warning
109+
###############################
110+
# C# Formatting Rules #
111+
###############################
112+
# New line preferences
113+
csharp_new_line_before_open_brace = all
114+
csharp_new_line_before_else = true
115+
csharp_new_line_before_catch = true
116+
csharp_new_line_before_finally = true
117+
csharp_new_line_before_members_in_object_initializers = true
118+
csharp_new_line_before_members_in_anonymous_types = true
119+
csharp_new_line_between_query_expression_clauses = true
120+
# Indentation preferences
121+
csharp_indent_case_contents = true
122+
csharp_indent_switch_labels = true
123+
csharp_indent_labels = flush_left
124+
# Space preferences
125+
csharp_space_after_cast = false
126+
csharp_space_after_keywords_in_control_flow_statements = true
127+
csharp_space_between_method_call_parameter_list_parentheses = false
128+
csharp_space_between_method_declaration_parameter_list_parentheses = false
129+
csharp_space_between_parentheses = false
130+
csharp_space_before_colon_in_inheritance_clause = true
131+
csharp_space_after_colon_in_inheritance_clause = true
132+
csharp_space_around_binary_operators = before_and_after
133+
csharp_space_between_method_declaration_empty_parameter_list_parentheses = false
134+
csharp_space_between_method_call_name_and_opening_parenthesis = false
135+
csharp_space_between_method_call_empty_parameter_list_parentheses = false
136+
# Wrapping preferences
137+
csharp_preserve_single_line_statements = true
138+
csharp_preserve_single_line_blocks = true
139+
csharp_using_directive_placement = outside_namespace:suggestion
140+
csharp_prefer_simple_using_statement = true:suggestion
141+
csharp_style_prefer_method_group_conversion = true:silent
142+
csharp_style_prefer_top_level_statements = true:silent
143+
csharp_style_prefer_primary_constructors = true:suggestion
144+
csharp_style_expression_bodied_lambdas = true:silent
145+
csharp_style_expression_bodied_local_functions = false:silent
146+
###############################
147+
# VB Coding Conventions #
148+
###############################
149+
[*.vb]
150+
# Modifier preferences
151+
visual_basic_preferred_modifier_order = Partial,Default,Private,Protected,Public,Friend,NotOverridable,Overridable,MustOverride,Overloads,Overrides,MustInherit,NotInheritable,Static,Shared,Shadows,ReadOnly,WriteOnly,Dim,Const,WithEvents,Widening,Narrowing,Custom,Async:suggestion

‎MinimalClean/.runsettings‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<RunSettings>
3+
<RunConfiguration>
4+
<!-- Enable parallel test execution at the assembly level -->
5+
<MaxCpuCount>0</MaxCpuCount>
6+
<!-- 0 means use all available processors -->
7+
<DisableParallelization>false</DisableParallelization>
8+
</RunConfiguration>
9+
10+
<xUnit>
11+
<!-- Configure xUnit-specific settings -->
12+
<ParallelizeAssembly>true</ParallelizeAssembly>
13+
<ParallelizeTestCollections>true</ParallelizeTestCollections>
14+
<MaxParallelThreads>0</MaxParallelThreads>
15+
<!-- 0 means use default algorithm (processors * 2) -->
16+
</xUnit>
17+
</RunSettings>

0 commit comments

Comments
 (0)