Skip to content

Instantly share code, notes, and snippets.

@weehong

weehong/README.md

Last active February 5, 2026 14:56
Show Gist options

  • Select an option

    Learn more about clone URLs
  • Save weehong/69b63249165a4373204e82c88b211a78 to your computer and use it in GitHub Desktop.

Select an option

Learn more about clone URLs
Save weehong/69b63249165a4373204e82c88b211a78 to your computer and use it in GitHub Desktop.
Download ZIP
.NET Scaffold Script
Raw
README.md

How to use

🍎 Linux / macOS

Run the following command in your terminal. Replace MyProjectName with your desired solution name.

# Syntax: curl [url] | bash -s -- [ProjectName]
curl -fsSL https://gist.githubusercontent.com/weehong/69b63249165a4373204e82c88b211a78/raw/scaffold.sh | bash -s -- MyCleanApp

🪟 Windows (PowerShell)

Run this command to scaffold the solution.

# Syntax: irm [url] | % { & ([scriptblock]::Create($_)) [ProjectName] }
irm "https://gist.githubusercontent.com/weehong/69b63249165a4373204e82c88b211a78/raw/scaffold.ps1" | % { & ([scriptblock]::Create($_)) Tidverse }
Raw
scaffold.ps1
param(
[string]$ProjectName,
[ValidateSet("slnx", "sln")]
[string]$Format = "slnx",
[switch]$SkipPackages = $false
)
# --- 1. Setup & Validation ---
if ([string]::IsNullOrWhiteSpace($ProjectName)) {
$ProjectName = Read-Host "Please enter a project name"
}
if ([string]::IsNullOrWhiteSpace($ProjectName)) {
Write-Host "❌ Name required." -ForegroundColor Red; exit 1
}
if (Test-Path $ProjectName) {
Write-Host "❌ Directory '$ProjectName' already exists. Aborting to prevent overwrite." -ForegroundColor Red; exit 1
}
$SlnFile = "$ProjectName.$Format"
Write-Host "🚀 Scaffolding Clean Architecture for: $ProjectName" -ForegroundColor Cyan
# Create Root Directory
New-Item -ItemType Directory -Path $ProjectName | Out-Null
Set-Location $ProjectName
# --- 2. Smart SDK Detection ---
$LatestSdk = dotnet --list-sdks | Select-Object -Last 1 | ForEach-Object { $_.Split(' ')[0] }
if ($LatestSdk) {
Write-Host "ℹ️ Detected SDK: $LatestSdk. Pinning global.json..." -ForegroundColor Gray
dotnet new globaljson --sdk-version $LatestSdk --roll-forward latestFeature
} else {
Write-Host "⚠️ No SDK detected. Skipping global.json." -ForegroundColor Yellow
}
dotnet new gitignore
# --- 3. Create Solution & Fix NuGet ---
if ($Format -eq "slnx") { dotnet new sln -n $ProjectName --format slnx }
else { dotnet new sln -n $ProjectName }
# [FIX] Create a local nuget.config to ensure we can find packages
Write-Host "📦 Configuring NuGet sources..." -ForegroundColor Cyan
dotnet new nugetconfig --force
# Add nuget.org only if it's missing
$CurrentSources = dotnet nuget list source --configfile "nuget.config"
if ($CurrentSources -notmatch "nuget.org") {
dotnet nuget add source "https://api.nuget.org/v3/index.json" -n "nuget.org" --configfile "nuget.config"
}
# --- 4. Create Projects (Src & Tests) ---
Write-Host "🔨 Creating projects..." -ForegroundColor Cyan
# Source Projects
dotnet new classlib -n "$ProjectName.Shared" -o "src/$ProjectName.Shared"
dotnet new classlib -n "$ProjectName.Core" -o "src/$ProjectName.Core"
dotnet new classlib -n "$ProjectName.Application" -o "src/$ProjectName.Application"
dotnet new classlib -n "$ProjectName.Infrastructure" -o "src/$ProjectName.Infrastructure"
dotnet new webapi -n "$ProjectName.Api" -o "src/$ProjectName.Api" --use-controllers
# Test Projects
dotnet new xunit -n "$ProjectName.Core.Tests" -o "tests/$ProjectName.Core.Tests"
dotnet new xunit -n "$ProjectName.Application.Tests" -o "tests/$ProjectName.Application.Tests"
dotnet new xunit -n "$ProjectName.IntegrationTests" -o "tests/$ProjectName.IntegrationTests"
# --- 4.1 CLEANUP BOILERPLATE ---
Write-Host "🧹 Removing default template files..." -ForegroundColor Cyan
$FilesToRemove = @(
"src/$ProjectName.Shared/Class1.cs",
"src/$ProjectName.Core/Class1.cs",
"src/$ProjectName.Application/Class1.cs",
"src/$ProjectName.Infrastructure/Class1.cs",
"tests/$ProjectName.Core.Tests/UnitTest1.cs",
"tests/$ProjectName.Application.Tests/UnitTest1.cs",
"tests/$ProjectName.IntegrationTests/UnitTest1.cs",
"src/$ProjectName.Api/WeatherForecast.cs",
"src/$ProjectName.Api/Controllers/WeatherForecastController.cs",
"src/$ProjectName.Api/$ProjectName.Api.http"
)
foreach ($File in $FilesToRemove) {
if (Test-Path $File) {
Remove-Item $File -Force
Write-Host " - Deleted $File" -ForegroundColor DarkGray
}
}
# --- 5. Add to Solution ---
Write-Host "📂 Organizing solution structure..." -ForegroundColor Cyan
# Add Src
dotnet sln $SlnFile add "src/$ProjectName.Shared/$ProjectName.Shared.csproj" -s "src"
dotnet sln $SlnFile add "src/$ProjectName.Core/$ProjectName.Core.csproj" -s "src"
dotnet sln $SlnFile add "src/$ProjectName.Application/$ProjectName.Application.csproj" -s "src"
dotnet sln $SlnFile add "src/$ProjectName.Infrastructure/$ProjectName.Infrastructure.csproj" -s "src"
dotnet sln $SlnFile add "src/$ProjectName.Api/$ProjectName.Api.csproj" -s "src"
# Add Tests
dotnet sln $SlnFile add "tests/$ProjectName.Core.Tests/$ProjectName.Core.Tests.csproj" -s "tests"
dotnet sln $SlnFile add "tests/$ProjectName.Application.Tests/$ProjectName.Application.Tests.csproj" -s "tests"
dotnet sln $SlnFile add "tests/$ProjectName.IntegrationTests/$ProjectName.IntegrationTests.csproj" -s "tests"
# --- 6. Add References ---
Write-Host "🔗 Wiring up dependencies..." -ForegroundColor Cyan
# Shared References (Everyone depends on Shared)
dotnet add "src/$ProjectName.Core/$ProjectName.Core.csproj" reference "src/$ProjectName.Shared/$ProjectName.Shared.csproj"
dotnet add "src/$ProjectName.Application/$ProjectName.Application.csproj" reference "src/$ProjectName.Shared/$ProjectName.Shared.csproj"
dotnet add "src/$ProjectName.Infrastructure/$ProjectName.Infrastructure.csproj" reference "src/$ProjectName.Shared/$ProjectName.Shared.csproj"
dotnet add "src/$ProjectName.Api/$ProjectName.Api.csproj" reference "src/$ProjectName.Shared/$ProjectName.Shared.csproj"
# Application -> Core
dotnet add "src/$ProjectName.Application/$ProjectName.Application.csproj" reference "src/$ProjectName.Core/$ProjectName.Core.csproj"
# Infrastructure -> Application & Core
dotnet add "src/$ProjectName.Infrastructure/$ProjectName.Infrastructure.csproj" reference "src/$ProjectName.Application/$ProjectName.Application.csproj"
dotnet add "src/$ProjectName.Infrastructure/$ProjectName.Infrastructure.csproj" reference "src/$ProjectName.Core/$ProjectName.Core.csproj"
# API -> Application & Infrastructure
dotnet add "src/$ProjectName.Api/$ProjectName.Api.csproj" reference "src/$ProjectName.Application/$ProjectName.Application.csproj"
dotnet add "src/$ProjectName.Api/$ProjectName.Api.csproj" reference "src/$ProjectName.Infrastructure/$ProjectName.Infrastructure.csproj"
# Tests
dotnet add "tests/$ProjectName.Core.Tests/$ProjectName.Core.Tests.csproj" reference "src/$ProjectName.Core/$ProjectName.Core.csproj"
dotnet add "tests/$ProjectName.Core.Tests/$ProjectName.Core.Tests.csproj" reference "src/$ProjectName.Shared/$ProjectName.Shared.csproj"
dotnet add "tests/$ProjectName.Application.Tests/$ProjectName.Application.Tests.csproj" reference "src/$ProjectName.Application/$ProjectName.Application.csproj"
dotnet add "tests/$ProjectName.Application.Tests/$ProjectName.Application.Tests.csproj" reference "src/$ProjectName.Shared/$ProjectName.Shared.csproj"
dotnet add "tests/$ProjectName.IntegrationTests/$ProjectName.IntegrationTests.csproj" reference "src/$ProjectName.Api/$ProjectName.Api.csproj"
dotnet add "tests/$ProjectName.IntegrationTests/$ProjectName.IntegrationTests.csproj" reference "src/$ProjectName.Infrastructure/$ProjectName.Infrastructure.csproj"
dotnet add "tests/$ProjectName.IntegrationTests/$ProjectName.IntegrationTests.csproj" reference "src/$ProjectName.Application/$ProjectName.Application.csproj"
dotnet add "tests/$ProjectName.IntegrationTests/$ProjectName.IntegrationTests.csproj" reference "src/$ProjectName.Shared/$ProjectName.Shared.csproj"
# --- 7. Install Nuget Packages (Optional) ---
if (-not $SkipPackages) {
Write-Host "📦 Installing standard Clean Architecture packages..." -ForegroundColor Cyan
# Helper function to add package safely
function Add-Package {
param ($Project, $Package)
Write-Host " + Adding $Package..." -ForegroundColor Gray
dotnet add $Project package $Package
if ($LASTEXITCODE -ne 0) {
Write-Host " ⚠️ Failed to add $Package. Check connection." -ForegroundColor Yellow
}
}
# Application Layer
Add-Package "src/$ProjectName.Application/$ProjectName.Application.csproj" "MediatR"
Add-Package "src/$ProjectName.Application/$ProjectName.Application.csproj" "FluentValidation"
Add-Package "src/$ProjectName.Application/$ProjectName.Application.csproj" "FluentValidation.DependencyInjectionExtensions"
Add-Package "src/$ProjectName.Application/$ProjectName.Application.csproj" "Microsoft.Extensions.Logging.Abstractions"
# Infrastructure Layer
Add-Package "src/$ProjectName.Infrastructure/$ProjectName.Infrastructure.csproj" "Microsoft.EntityFrameworkCore"
Add-Package "src/$ProjectName.Infrastructure/$ProjectName.Infrastructure.csproj" "Microsoft.EntityFrameworkCore.SqlServer"
Add-Package "src/$ProjectName.Infrastructure/$ProjectName.Infrastructure.csproj" "Microsoft.EntityFrameworkCore.Design"
# API Layer
Add-Package "src/$ProjectName.Api/$ProjectName.Api.csproj" "Microsoft.EntityFrameworkCore.Tools"
# Test Projects
$TestProjects = @(
"tests/$ProjectName.Core.Tests/$ProjectName.Core.Tests.csproj",
"tests/$ProjectName.Application.Tests/$ProjectName.Application.Tests.csproj",
"tests/$ProjectName.IntegrationTests/$ProjectName.IntegrationTests.csproj"
)
foreach ($proj in $TestProjects) {
Add-Package $proj "FluentAssertions"
Add-Package $proj "Moq"
}
# Integration Test Specifics
Add-Package "tests/$ProjectName.IntegrationTests/$ProjectName.IntegrationTests.csproj" "Microsoft.AspNetCore.Mvc.Testing"
}
# --- 8. Final Verification ---
Write-Host "🏗️ Verifying build..." -ForegroundColor Cyan
dotnet build
if ($LASTEXITCODE -eq 0) {
Write-Host "✅ $ProjectName scaffolded successfully (Boilerplate Removed)!" -ForegroundColor Green
Write-Host " 👉 cd $ProjectName" -ForegroundColor Gray
} else {
Write-Host "⚠️ Scaffolding finished, but build failed. Run 'dotnet restore' manually." -ForegroundColor Yellow
}
Raw
scaffold.sh
#!/bin/bash
# Usage: ./scaffold.sh MyProjectName [slnx|sln] [true|false for packages]
# Example: ./scaffold.sh MyCleanApp slnx
# --- 1. Setup & Validation ---
if [ -z "$1" ]; then
echo "❌ Please provide a project name."
echo "Usage: ./scaffold.sh MyProjectName [slnx|sln]"
exit 1
fi
PROJECT_NAME=$1
FORMAT=${2:-slnx}
INSTALL_PACKAGES=${3:-true} # Default to true
SLN_FILE="$PROJECT_NAME.$FORMAT"
# Check if directory exists to avoid overwriting
if [ -d "$PROJECT_NAME" ]; then
echo "❌ Directory '$PROJECT_NAME' already exists. Aborting."
exit 1
fi
echo "🚀 Scaffolding $FORMAT solution for: $PROJECT_NAME (Clean Architecture)"
# Create Root Directory and enter it
mkdir "$PROJECT_NAME"
cd "$PROJECT_NAME" || exit
# --- 2. Smart SDK Detection ---
# Get the latest installed SDK version (e.g. 10.0.102)
LATEST_SDK=$(dotnet --list-sdks | tail -n 1 | awk '{print $1}')
if [ -n "$LATEST_SDK" ]; then
echo "ℹ️ Detected SDK: $LATEST_SDK. Pinning global.json..."
dotnet new globaljson --sdk-version "$LATEST_SDK" --roll-forward latestFeature
else
echo "⚠️ No SDK detected. Skipping global.json."
fi
dotnet new gitignore
# --- 3. Create Solution & Fix NuGet ---
if [ "$FORMAT" == "slnx" ]; then
dotnet new sln -n "$PROJECT_NAME" --format slnx
else
dotnet new sln -n "$PROJECT_NAME"
fi
# [FIX] Create a local nuget.config to ensure we can find packages
echo "📦 Configuring NuGet sources..."
dotnet new nugetconfig --force
# Check if nuget.org is already there (dotnet new nugetconfig usually adds it)
if ! dotnet nuget list source --configfile "nuget.config" | grep -q "nuget.org"; then
dotnet nuget add source "https://api.nuget.org/v3/index.json" -n "nuget.org" --configfile "nuget.config"
fi
# --- 4. Create Projects ---
echo "🔨 Creating projects..."
dotnet new classlib -n "$PROJECT_NAME.Shared" -o "src/$PROJECT_NAME.Shared"
dotnet new classlib -n "$PROJECT_NAME.Core" -o "src/$PROJECT_NAME.Core"
dotnet new classlib -n "$PROJECT_NAME.Application" -o "src/$PROJECT_NAME.Application"
dotnet new classlib -n "$PROJECT_NAME.Infrastructure" -o "src/$PROJECT_NAME.Infrastructure"
dotnet new webapi -n "$PROJECT_NAME.Api" -o "src/$PROJECT_NAME.Api" --use-controllers
mkdir -p tests
dotnet new xunit -n "$PROJECT_NAME.Core.Tests" -o "tests/$PROJECT_NAME.Core.Tests"
dotnet new xunit -n "$PROJECT_NAME.Application.Tests" -o "tests/$PROJECT_NAME.Application.Tests"
dotnet new xunit -n "$PROJECT_NAME.IntegrationTests" -o "tests/$PROJECT_NAME.IntegrationTests"
# --- 4.1 CLEANUP BOILERPLATE ---
echo "🧹 Removing default template files..."
# Define array of files to remove relative to solution root
FILES_TO_REMOVE=(
"src/$PROJECT_NAME.Shared/Class1.cs"
"src/$PROJECT_NAME.Core/Class1.cs"
"src/$PROJECT_NAME.Application/Class1.cs"
"src/$PROJECT_NAME.Infrastructure/Class1.cs"
"tests/$PROJECT_NAME.Core.Tests/UnitTest1.cs"
"tests/$PROJECT_NAME.Application.Tests/UnitTest1.cs"
"tests/$PROJECT_NAME.IntegrationTests/UnitTest1.cs"
"src/$PROJECT_NAME.Api/WeatherForecast.cs"
"src/$PROJECT_NAME.Api/Controllers/WeatherForecastController.cs"
"src/$PROJECT_NAME.Api/$PROJECT_NAME.Api.http"
)
for file in "${FILES_TO_REMOVE[@]}"; do
if [ -f "$file" ]; then
rm "$file"
echo " - Deleted $file"
fi
done
# --- 5. Add to Solution (With Visual Folders) ---
echo "📂 Organizing solution structure..."
# Source
dotnet sln "$SLN_FILE" add "src/$PROJECT_NAME.Shared/$PROJECT_NAME.Shared.csproj" -s "src"
dotnet sln "$SLN_FILE" add "src/$PROJECT_NAME.Core/$PROJECT_NAME.Core.csproj" -s "src"
dotnet sln "$SLN_FILE" add "src/$PROJECT_NAME.Application/$PROJECT_NAME.Application.csproj" -s "src"
dotnet sln "$SLN_FILE" add "src/$PROJECT_NAME.Infrastructure/$PROJECT_NAME.Infrastructure.csproj" -s "src"
dotnet sln "$SLN_FILE" add "src/$PROJECT_NAME.Api/$PROJECT_NAME.Api.csproj" -s "src"
# Tests
dotnet sln "$SLN_FILE" add "tests/$PROJECT_NAME.Core.Tests/$PROJECT_NAME.Core.Tests.csproj" -s "tests"
dotnet sln "$SLN_FILE" add "tests/$PROJECT_NAME.Application.Tests/$PROJECT_NAME.Application.Tests.csproj" -s "tests"
dotnet sln "$SLN_FILE" add "tests/$PROJECT_NAME.IntegrationTests/$PROJECT_NAME.IntegrationTests.csproj" -s "tests"
# --- 6. Add References ---
echo "🔗 Wiring up dependencies..."
# Shared References (Everyone depends on Shared)
dotnet add "src/$PROJECT_NAME.Core/$PROJECT_NAME.Core.csproj" reference "src/$PROJECT_NAME.Shared/$PROJECT_NAME.Shared.csproj"
dotnet add "src/$PROJECT_NAME.Application/$PROJECT_NAME.Application.csproj" reference "src/$PROJECT_NAME.Shared/$PROJECT_NAME.Shared.csproj"
dotnet add "src/$PROJECT_NAME.Infrastructure/$PROJECT_NAME.Infrastructure.csproj" reference "src/$PROJECT_NAME.Shared/$PROJECT_NAME.Shared.csproj"
dotnet add "src/$PROJECT_NAME.Api/$PROJECT_NAME.Api.csproj" reference "src/$PROJECT_NAME.Shared/$PROJECT_NAME.Shared.csproj"
# Application -> Core
dotnet add "src/$PROJECT_NAME.Application/$PROJECT_NAME.Application.csproj" reference "src/$PROJECT_NAME.Core/$PROJECT_NAME.Core.csproj"
# Infrastructure -> Application AND Core
dotnet add "src/$PROJECT_NAME.Infrastructure/$PROJECT_NAME.Infrastructure.csproj" reference "src/$PROJECT_NAME.Application/$PROJECT_NAME.Application.csproj"
dotnet add "src/$PROJECT_NAME.Infrastructure/$PROJECT_NAME.Infrastructure.csproj" reference "src/$PROJECT_NAME.Core/$PROJECT_NAME.Core.csproj"
# API -> Application AND Infrastructure
dotnet add "src/$PROJECT_NAME.Api/$PROJECT_NAME.Api.csproj" reference "src/$PROJECT_NAME.Application/$PROJECT_NAME.Application.csproj"
dotnet add "src/$PROJECT_NAME.Api/$PROJECT_NAME.Api.csproj" reference "src/$PROJECT_NAME.Infrastructure/$PROJECT_NAME.Infrastructure.csproj"
# Tests
dotnet add "tests/$PROJECT_NAME.Core.Tests/$PROJECT_NAME.Core.Tests.csproj" reference "src/$PROJECT_NAME.Core/$PROJECT_NAME.Core.csproj"
dotnet add "tests/$PROJECT_NAME.Core.Tests/$PROJECT_NAME.Core.Tests.csproj" reference "src/$PROJECT_NAME.Shared/$PROJECT_NAME.Shared.csproj"
dotnet add "tests/$PROJECT_NAME.Application.Tests/$PROJECT_NAME.Application.Tests.csproj" reference "src/$PROJECT_NAME.Application/$PROJECT_NAME.Application.csproj"
dotnet add "tests/$PROJECT_NAME.Application.Tests/$PROJECT_NAME.Application.Tests.csproj" reference "src/$PROJECT_NAME.Shared/$PROJECT_NAME.Shared.csproj"
dotnet add "tests/$PROJECT_NAME.IntegrationTests/$PROJECT_NAME.IntegrationTests.csproj" reference "src/$PROJECT_NAME.Api/$PROJECT_NAME.Api.csproj"
dotnet add "tests/$PROJECT_NAME.IntegrationTests/$PROJECT_NAME.IntegrationTests.csproj" reference "src/$PROJECT_NAME.Infrastructure/$PROJECT_NAME.Infrastructure.csproj"
dotnet add "tests/$PROJECT_NAME.IntegrationTests/$PROJECT_NAME.IntegrationTests.csproj" reference "src/$PROJECT_NAME.Application/$PROJECT_NAME.Application.csproj"
dotnet add "tests/$PROJECT_NAME.IntegrationTests/$PROJECT_NAME.IntegrationTests.csproj" reference "src/$PROJECT_NAME.Shared/$PROJECT_NAME.Shared.csproj"
# --- 7. Install Nuget Packages (Optional) ---
if [ "$INSTALL_PACKAGES" = true ]; then
echo "📦 Installing standard Clean Architecture packages..."
# Helper function to add packages safely
add_package() {
local proj=$1
local pkg=$2
echo " + Adding $pkg..."
dotnet add "$proj" package "$pkg" > /dev/null 2>&1
if [ $? -ne 0 ]; then
echo " ⚠️ Failed to add $pkg. Check connection."
fi
}
# Application Layer
add_package "src/$PROJECT_NAME.Application/$PROJECT_NAME.Application.csproj" "MediatR"
add_package "src/$PROJECT_NAME.Application/$PROJECT_NAME.Application.csproj" "FluentValidation"
add_package "src/$PROJECT_NAME.Application/$PROJECT_NAME.Application.csproj" "FluentValidation.DependencyInjectionExtensions"
add_package "src/$PROJECT_NAME.Application/$PROJECT_NAME.Application.csproj" "Microsoft.Extensions.Logging.Abstractions"
# Infrastructure Layer
add_package "src/$PROJECT_NAME.Infrastructure/$PROJECT_NAME.Infrastructure.csproj" "Microsoft.EntityFrameworkCore"
add_package "src/$PROJECT_NAME.Infrastructure/$PROJECT_NAME.Infrastructure.csproj" "Microsoft.EntityFrameworkCore.SqlServer"
add_package "src/$PROJECT_NAME.Infrastructure/$PROJECT_NAME.Infrastructure.csproj" "Microsoft.EntityFrameworkCore.Design"
# API Layer
add_package "src/$PROJECT_NAME.Api/$PROJECT_NAME.Api.csproj" "Microsoft.EntityFrameworkCore.Tools"
# Tests
TEST_PROJECTS=(
"tests/$PROJECT_NAME.Core.Tests/$PROJECT_NAME.Core.Tests.csproj"
"tests/$PROJECT_NAME.Application.Tests/$PROJECT_NAME.Application.Tests.csproj"
"tests/$PROJECT_NAME.IntegrationTests/$PROJECT_NAME.IntegrationTests.csproj"
)
for proj in "${TEST_PROJECTS[@]}"; do
add_package "$proj" "FluentAssertions"
add_package "$proj" "Moq"
done
add_package "tests/$PROJECT_NAME.IntegrationTests/$PROJECT_NAME.IntegrationTests.csproj" "Microsoft.AspNetCore.Mvc.Testing"
fi
# --- 8. Final Verification ---
echo "🏗️ Verifying build..."
dotnet build
if [ $? -eq 0 ]; then
echo "✅ $PROJECT_NAME scaffolded successfully!"
echo "👉 cd $PROJECT_NAME"
else
echo "⚠️ Scaffolding finished, but build failed. Run 'dotnet restore' manually."
fi
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment