Skip to content

Commit 4686c38

Browse files
committed
Refactor conditional compilation directives for improved readability and more stable/consistent consumption
- Updated conditional compilation directives in various project files to remove parentheses for consistency and clarity. - Adjusted project references and package references in .csproj files to align with new directive style. - Modified appsettings and documentation files to reflect the updated directive format. - Ensured all relevant files across the CoreEx, Relay, and Subscriber projects are updated accordingly.
1 parent 0260548 commit 4686c38

34 files changed

Lines changed: 150 additions & 150 deletions

src/CoreEx.Template/content/CoreEx.Api/src/app-name.Api/AGENTS.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -51,19 +51,19 @@ Consult `.github/docs/coreex/agents/CoreEx.Caching.FusionCache.md` for caching p
5151

5252
## This Host's Feature Configuration
5353

54-
<!-- #if (implement-sqlserver) -->
54+
<!-- #if implement-sqlserver -->
5555
- **Data provider:** SQL Server -- `builder.AddSqlClientConnection("SqlServer")` (Aspire connection name)
56-
<!-- #elif (implement-postgres) -->
56+
<!-- #elif implement-postgres -->
5757
- **Data provider:** PostgreSQL -- `builder.AddNpgsqlDataSource("Postgres")` (Aspire connection name)
5858
<!-- #else -->
5959
- **Data provider:** None -- this host uses no database; services call external systems directly
6060
<!-- #endif -->
61-
<!-- #if (outbox-enabled && !implement-none-data) -->
61+
<!-- #if outbox-enabled && !implement-none-data -->
6262
- **Transactional outbox:** Enabled -- events are written to the DB outbox by `domain-nameOutboxPublisher`; the Relay host reads and forwards them
6363
<!-- #else -->
6464
- **Transactional outbox:** Disabled -- events are published directly to the message broker
6565
<!-- #endif -->
66-
<!-- #if (refdata-enabled) -->
66+
<!-- #if refdata-enabled -->
6767
- **Reference data:** Enabled -- `ReferenceDataOrchestrator<ReferenceDataService>` is registered; reference data is hydrated via `ReferenceDataRepository`
6868
<!-- #else -->
6969
- **Reference data:** Disabled
@@ -78,16 +78,16 @@ Consult `.github/docs/coreex/agents/CoreEx.Caching.FusionCache.md` for caching p
7878
| `CoreEx.AspNetCore` | Web API base types, middleware, `WebApiPublisher` |
7979
| `CoreEx.AspNetCore.NSwag` | NSwag OpenAPI integration |
8080
| `CoreEx.Caching.FusionCache` | FusionCache `IHybridCache` integration |
81-
<!-- #if (implement-sqlserver) -->
81+
<!-- #if implement-sqlserver -->
8282
| `CoreEx.Database.SqlServer` | SQL Server database access |
8383
<!-- #endif -->
84-
<!-- #if (implement-postgres) -->
84+
<!-- #if implement-postgres -->
8585
| `CoreEx.Database.Postgres` | PostgreSQL database access |
8686
<!-- #endif -->
87-
<!-- #if (!implement-none-data) -->
87+
<!-- #if !implement-none-data -->
8888
| `CoreEx.EntityFrameworkCore` | EF Core integration (`EfDb`, `IEfDbContext`) |
8989
<!-- #endif -->
90-
<!-- #if (refdata-enabled) -->
90+
<!-- #if refdata-enabled -->
9191
| `CoreEx.RefData` | Reference data orchestration |
9292
<!-- #endif -->
9393

@@ -101,9 +101,9 @@ Consult `.github/docs/coreex/agents/CoreEx.Caching.FusionCache.md` for caching p
101101
- `.github/docs/coreex/local-dev.md` -- running locally with .NET Aspire
102102
- `.github/docs/coreex/agents/CoreEx.AspNetCore.md` -- Web API patterns
103103
- `.github/docs/coreex/agents/CoreEx.Caching.FusionCache.md` -- caching
104-
<!-- #if (!implement-none-data) -->
104+
<!-- #if !implement-none-data -->
105105
- `.github/docs/coreex/agents/CoreEx.EntityFrameworkCore.md` -- EF Core patterns
106106
<!-- #endif -->
107-
<!-- #if (refdata-enabled) -->
107+
<!-- #if refdata-enabled -->
108108
- `.github/docs/coreex/agents/CoreEx.RefData.md` -- reference data patterns
109109
<!-- #endif -->

src/CoreEx.Template/content/CoreEx.Api/src/app-name.Api/GlobalUsing.cs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,15 @@
22
global using CoreEx.AspNetCore.Mvc;
33
global using CoreEx.Caching;
44
global using CoreEx.Database;
5-
// #if (implement-sqlserver)
5+
// #if implement-sqlserver
66
global using CoreEx.Database.SqlServer;
7-
// #elif (implement-postgres)
7+
// #elif implement-postgres
88
global using CoreEx.Database.Postgres;
99
// #endif
1010
global using CoreEx.Entities;
1111
global using CoreEx.Http;
1212
global using CoreEx.Json;
13-
// #if (refdata-enabled)
13+
// #if refdata-enabled
1414
global using CoreEx.RefData;
1515
// #endif
1616
global using CoreEx.Validation;
@@ -28,6 +28,6 @@
2828
// NOTE: Application layer using statements will be added after CodeGen runs.
2929
// See: BOOTSTRAP_PHASE_2.md in your project root.
3030
// Add the following after generating application services:
31-
// // #if (refdata-enabled)
31+
// // #if refdata-enabled
3232
// global using solution-name.Application;
3333
// // #endif

src/CoreEx.Template/content/CoreEx.Api/src/app-name.Api/Program.cs

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ private static void Main(string[] args)
2828
// See: BOOTSTRAP_PHASE_2.md in your project root for the post-CodeGen setup steps.
2929
// The following will be uncommented and moved here after running: dotnet run --project tools/app-name.CodeGen
3030
//
31-
// // #if (refdata-enabled)
31+
// // #if refdata-enabled
3232
// builder.Services.AddReferenceDataOrchestrator<ReferenceDataService>();
3333
// builder.Services.AddDynamicServicesUsing<ReferenceDataService, ReferenceDataRepository>();
3434
// // #endif
@@ -51,24 +51,24 @@ private static void Main(string[] args)
5151
.AddHybridCacheIdempotencyProvider(); // Adds the CoreEx.Caching.Idempotency.IIdempotencyProvider.
5252

5353
// Add the repository and related database services.
54-
#if (implement-sqlserver)
54+
#if implement-sqlserver
5555
builder.AddSqlServerClient("SqlServer"); // Adds the SqlServerClient (using Aspire library).
5656
builder.Services
5757
.AddSqlServerDatabase() // Adds the SqlServerDatabase.
5858
.AddSqlServerUnitOfWork() // Adds the SqlServerUnitOfWork for the SqlServerDatabase.
5959
.AddEventFormatter() // Adds the EventFormatter to enable message formatting for publishing.
60-
#if (outbox-enabled)
60+
#if outbox-enabled
6161
.AddSqlServerOutboxPublisher() // Adds the SqlServerOutboxPublisher as the IEventPublisher.
6262
#endif
6363
.AddDbContext<domain-nameDbContext>() // Adds the standard EF DbContext.
6464
.AddEfDb<domain-nameEfDb>(); // Adds the CoreEx extended EF service.
65-
#elif (implement-postgres)
65+
#elif implement-postgres
6666
builder.AddNpgsqlDataSource("Postgres"); // Adds the NpgsqlDataSource (using Aspire library).
6767
builder.Services
6868
.AddPostgresDatabase() // Adds the PostgresDatabase.
6969
.AddPostgresUnitOfWork() // Adds the PostgresUnitOfWork for the PostgresDatabase.
7070
.AddEventFormatter() // Adds the EventFormatter to enable message formatting for publishing.
71-
#if (outbox-enabled)
71+
#if outbox-enabled
7272
.AddPostgresOutboxPublisher() // Adds the PostgresOutboxPublisher as the IEventPublisher.
7373
#endif
7474
.AddDbContext<domain-nameDbContext>() // Adds the standard EF DbContext.
@@ -90,9 +90,9 @@ private static void Main(string[] args)
9090

9191
// Add OpenTelemetry tracing.
9292
builder.WithCoreExTelemetry()
93-
#if (implement-sqlserver)
93+
#if implement-sqlserver
9494
.WithCoreExSqlServerTelemetry()
95-
#elif (implement-postgres)
95+
#elif implement-postgres
9696
.WithCoreExPostgresTelemetry()
9797
#endif
9898
.UseOtlpExporter();

src/CoreEx.Template/content/CoreEx.Api/src/app-name.Api/app-name.Api.csproj

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<Project Sdk="Microsoft.NET.Sdk.Web">
22
<ItemGroup>
3-
<!--#if (refdata-enabled)-->
3+
<!--#if refdata-enabled-->
44
<ProjectReference Include="..\solution-name.Application\solution-name.Application.csproj" />
55
<!--#endif-->
66
<ProjectReference Include="..\solution-name.Infrastructure\solution-name.Infrastructure.csproj" />
@@ -9,11 +9,11 @@
99
<PackageReference Include="CoreEx.AspNetCore" />
1010
<PackageReference Include="CoreEx.AspNetCore.NSwag" />
1111
<PackageReference Include="CoreEx.Caching.FusionCache" />
12-
<!--#if (implement-sqlserver)-->
12+
<!--#if implement-sqlserver-->
1313
<PackageReference Include="CoreEx.Database.SqlServer" />
1414
<PackageReference Include="Aspire.Microsoft.Data.SqlClient" />
1515
<!--#endif-->
16-
<!--#if (implement-postgres)-->
16+
<!--#if implement-postgres-->
1717
<PackageReference Include="CoreEx.Database.Postgres" />
1818
<PackageReference Include="Aspire.Azure.Npgsql" />
1919
<!--#endif-->

src/CoreEx.Template/content/CoreEx.Api/src/app-name.Api/appsettings.Development.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,15 @@
99
}
1010
},
1111
"Aspire": {
12-
//#if (implement-sqlserver)
12+
//#if implement-sqlserver
1313
"Microsoft": {
1414
"Data": {
1515
"SqlClient": {
1616
"ConnectionString": "Data Source=127.0.0.1,1433;Initial Catalog=domain-name;User id=sa;Password=yourStrong(!)Password;TrustServerCertificate=true"
1717
}
1818
}
1919
},
20-
//#elif (implement-postgres)
20+
//#elif implement-postgres
2121
"Npgsql": {
2222
"ConnectionString": "Server=127.0.0.1;Database=domain-name-lower;Username=postgres;Password=yourStrong#!Password"
2323
},

src/CoreEx.Template/content/CoreEx.Core/AGENTS.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -32,34 +32,34 @@ See `.github/docs/coreex/layers.md` for the full layered architecture and depend
3232

3333
## Feature Configuration
3434

35-
<!-- #if (implement-sqlserver) -->
35+
<!-- #if implement-sqlserver -->
3636
- **Data provider:** SQL Server (`CoreEx.Database.SqlServer`, `CoreEx.EntityFrameworkCore`)
37-
<!-- #elif (implement-postgres) -->
37+
<!-- #elif implement-postgres -->
3838
- **Data provider:** PostgreSQL (`CoreEx.Database.Postgres`, `CoreEx.EntityFrameworkCore`)
3939
<!-- #else -->
4040
- **Data provider:** None -- facade solution (e.g. over Dynamics 365 via HttpClient)
4141
<!-- #endif -->
42-
<!-- #if (refdata-enabled && !implement-none-data) -->
42+
<!-- #if refdata-enabled && !implement-none-data -->
4343
- **Reference data:** Enabled -- `src/app-name.Application/ReferenceDataService.cs` and `tools/app-name.CodeGen/`
4444
<!-- #else -->
4545
- **Reference data:** Disabled
4646
<!-- #endif -->
47-
<!-- #if (domain-driven-enabled) -->
47+
<!-- #if domain-driven-enabled -->
4848
- **Domain project:** Enabled -- `src/app-name.Domain/` (aggregates, value objects)
4949
<!-- #else -->
5050
- **Domain project:** Disabled -- domain logic lives in Application
5151
<!-- #endif -->
52-
<!-- #if (rop-enabled) -->
52+
<!-- #if rop-enabled -->
5353
- **Railway-Oriented Programming:** Enabled -- service methods return `Result`/`Result<T>`
5454
<!-- #else -->
5555
- **Railway-Oriented Programming:** Disabled -- standard exception-based error handling
5656
<!-- #endif -->
57-
<!-- #if (outbox-enabled && !implement-none-data) -->
57+
<!-- #if outbox-enabled && !implement-none-data -->
5858
- **Transactional outbox:** Enabled -- events committed atomically with data via the outbox table
5959
<!-- #else -->
6060
- **Transactional outbox:** Disabled
6161
<!-- #endif -->
62-
<!-- #if (implement-servicebus) -->
62+
<!-- #if implement-servicebus -->
6363
- **Messaging:** Azure Service Bus (`CoreEx.Azure.Messaging.ServiceBus`)
6464
<!-- #else -->
6565
- **Messaging:** None configured

src/CoreEx.Template/content/CoreEx.Core/BOOTSTRAP_PHASE_2.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ Find this commented block:
7373
// See: BOOTSTRAP_PHASE_2.md in your project root for the post-CodeGen setup steps.
7474
// The following will be uncommented and moved here after running: dotnet run --project tools/solution-name.CodeGen
7575
//
76-
// // #if (refdata-enabled)
76+
// // #if refdata-enabled
7777
// builder.Services.AddReferenceDataOrchestrator<ReferenceDataService>();
7878
// builder.Services.AddDynamicServicesUsing<ReferenceDataService, ReferenceDataRepository>();
7979
// // #endif
@@ -99,7 +99,7 @@ Find this commented block:
9999
// NOTE: Application layer using statements will be added after CodeGen runs.
100100
// See: BOOTSTRAP_PHASE_2.md in your project root.
101101
// Add the following after generating application services:
102-
// // #if (refdata-enabled)
102+
// // #if refdata-enabled
103103
// global using solution-name.Application;
104104
// // #endif
105105
```

src/CoreEx.Template/content/CoreEx.Core/_Directory.Packages.props

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -10,41 +10,41 @@
1010
<PackageVersion Include="CoreEx" Version="coreex-version" />
1111
<PackageVersion Include="CoreEx.AspNetCore" Version="coreex-version" />
1212
<PackageVersion Include="CoreEx.AspNetCore.NSwag" Version="coreex-version" />
13-
<!--#if (implement-servicebus)-->
13+
<!--#if implement-servicebus-->
1414
<PackageVersion Include="CoreEx.Azure.Messaging.ServiceBus" Version="coreex-version" />
1515
<!--#endif-->
1616
<PackageVersion Include="CoreEx.Caching.FusionCache" Version="coreex-version" />
1717
<PackageVersion Include="CoreEx.Data" Version="coreex-version" />
18-
<!--#if (implement-postgres)-->
18+
<!--#if implement-postgres-->
1919
<PackageVersion Include="CoreEx.Database" Version="coreex-version" />
2020
<PackageVersion Include="CoreEx.Database.Postgres" Version="coreex-version" />
2121
<!--#endif-->
22-
<!--#if (implement-sqlserver)-->
22+
<!--#if implement-sqlserver-->
2323
<PackageVersion Include="CoreEx.Database" Version="coreex-version" />
2424
<PackageVersion Include="CoreEx.Database.SqlServer" Version="coreex-version" />
2525
<!--#endif-->
26-
<!--#if (domain-driven-enabled)-->
26+
<!--#if domain-driven-enabled-->
2727
<PackageVersion Include="CoreEx.DomainDriven" Version="coreex-version" />
2828
<!--#endif-->
29-
<!--#if (implement-sqlserver || implement-postgres)-->
29+
<!--#if implement-sqlserver || implement-postgres-->
3030
<PackageVersion Include="CoreEx.EntityFrameworkCore" Version="coreex-version" />
3131
<!--#endif-->
3232
<PackageVersion Include="CoreEx.Events" Version="coreex-version" />
33-
<!--#if (refdata-enabled)-->
33+
<!--#if refdata-enabled-->
3434
<PackageVersion Include="CoreEx.RefData" Version="coreex-version" />
3535
<!--#endif-->
3636
<PackageVersion Include="CoreEx.Validation" Version="coreex-version" />
3737
</ItemGroup>
3838

3939
<!-- Aspire client integration packages. -->
4040
<ItemGroup>
41-
<!--#if (implement-servicebus)-->
41+
<!--#if implement-servicebus-->
4242
<PackageVersion Include="Aspire.Azure.Messaging.ServiceBus" Version="13.1.1" />
4343
<!--#endif-->
44-
<!--#if (implement-postgres)-->
44+
<!--#if implement-postgres-->
4545
<PackageVersion Include="Aspire.Azure.Npgsql" Version="13.1.1" />
4646
<!--#endif-->
47-
<!--#if (implement-sqlserver)-->
47+
<!--#if implement-sqlserver-->
4848
<PackageVersion Include="Aspire.Microsoft.Data.SqlClient" Version="13.1.1" />
4949
<!--#endif-->
5050
<PackageVersion Include="Aspire.StackExchange.Redis.DistributedCaching" Version="13.1.1" />
@@ -65,25 +65,25 @@
6565
<!-- Tool/Test packages. -->
6666
<ItemGroup>
6767
<PackageVersion Include="AwesomeAssertions" Version="9.4.0" />
68-
<!--#if (refdata-enabled)-->
68+
<!--#if refdata-enabled-->
6969
<PackageVersion Include="CoreEx.CodeGen" Version="coreex-version" />
7070
<!--#endif-->
7171
<PackageVersion Include="CoreEx.UnitTesting" Version="coreex-version" />
7272
<PackageVersion Include="coverlet.collector" Version="6.0.4" />
73-
<!--#if (implement-postgres)-->
73+
<!--#if implement-postgres-->
7474
<PackageVersion Include="DbEx.Postgres" Version="3.1.2" />
7575
<!--#endif-->
76-
<!--#if (implement-sqlserver)-->
76+
<!--#if implement-sqlserver-->
7777
<PackageVersion Include="DbEx.SqlServer" Version="3.1.2" />
7878
<!--#endif-->
79-
<!--#if (implement-sqlserver)-->
79+
<!--#if implement-sqlserver-->
8080
<PackageVersion Include="Microsoft.EntityFrameworkCore.SqlServer" Version="10.0.0" />
8181
<!--#endif-->
8282
<PackageVersion Include="Microsoft.NET.Test.Sdk" Version="17.14.1" />
8383
<PackageVersion Include="NUnit" Version="4.3.2" />
8484
<PackageVersion Include="NUnit.Analyzers" Version="4.9.0" />
8585
<PackageVersion Include="NUnit3TestAdapter" Version="5.0.0" />
86-
<!--#if (implement-postgres)-->
86+
<!--#if implement-postgres-->
8787
<PackageVersion Include="Npgsql.EntityFrameworkCore.PostgreSQL" Version="10.0.1" />
8888
<!--#endif-->
8989
<PackageVersion Include="UnitTestEx.NUnit" Version="5.11.0" />

src/CoreEx.Template/content/CoreEx.Core/app-name.slnx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,16 @@
22
<Folder Name="/src/">
33
<Project Path="src\app-name.Contracts\app-name.Contracts.csproj" />
44
<Project Path="src\app-name.Application\app-name.Application.csproj" />
5-
<!--#if (domain-driven-enabled)-->
5+
<!--#if domain-driven-enabled-->
66
<Project Path="src\app-name.Domain\app-name.Domain.csproj" />
77
<!--#endif-->
88
<Project Path="src\app-name.Infrastructure\app-name.Infrastructure.csproj" />
99
</Folder>
1010
<Folder Name="/tools/">
11-
<!--#if (!implement-none-data)-->
11+
<!--#if !implement-none-data-->
1212
<Project Path="tools\app-name.Database\app-name.Database.csproj" />
1313
<!--#endif-->
14-
<!--#if (refdata-enabled && !implement-none-data)-->
14+
<!--#if refdata-enabled && !implement-none-data-->
1515
<Project Path="tools\app-name.CodeGen\app-name.CodeGen.csproj" />
1616
<!--#endif-->
1717
</Folder>

src/CoreEx.Template/content/CoreEx.Core/docker-compose.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
name: domain-name-lower
22

33
services:
4-
#if (implement-sqlserver || implement-servicebus)
4+
#if implement-sqlserver || implement-servicebus
55
db-sql-server:
66
image: mcr.microsoft.com/mssql/server:2022-latest
77
environment:
@@ -10,7 +10,7 @@ services:
1010
ports:
1111
- "1433:1433"
1212
#endif
13-
#if (implement-postgres)
13+
#if implement-postgres
1414
db-postgres:
1515
image: postgres
1616
environment:
@@ -30,7 +30,7 @@ services:
3030
ports:
3131
- "18888:18888"
3232
- "4317:18889"
33-
#if (implement-servicebus)
33+
#if implement-servicebus
3434
servicebus-emulator:
3535
image: mcr.microsoft.com/azure-messaging/servicebus-emulator:latest
3636
depends_on:

0 commit comments

Comments
 (0)