new-module

New Module Scaffolding

When the user asks to create a new module, follow these steps exactly.

Required Input

• Module name (e.g., "Payments")

Steps

1. Create Contracts Project

Create modules/<Name>/src/SimpleModule.<Name>.Contracts/:

SimpleModule..Contracts.csproj:

<Project Sdk="Microsoft.NET.Sdk">
  <PropertyGroup>
    <TargetFramework>net10.0</TargetFramework>
    <OutputType>Library</OutputType>
  </PropertyGroup>
  <ItemGroup>
    <ProjectReference Include="..\..\..\..\framework\SimpleModule.Core\SimpleModule.Core.csproj" />
  </ItemGroup>
</Project>

Constants.cs:

namespace SimpleModule.<Name>.Contracts;

public static class <Name>Constants
{
    public const string ModuleName = "<Name>";
    public const string RoutePrefix = "/api/<name-lowercase>";
}

IContracts.cs:

using System.Diagnostics.CodeAnalysis;

namespace SimpleModule.<Name>.Contracts;

[SuppressMessage("Design", "CA1040:Avoid empty interfaces", Justification = "Contracts placeholder")]
public interface I<Name>Contracts
{
}

2. Create Implementation Project

Create modules/<Name>/src/SimpleModule.<Name>/:

SimpleModule..csproj:

<Project Sdk="Microsoft.NET.Sdk.StaticWebAssets">
  <PropertyGroup>
    <TargetFramework>net10.0</TargetFramework>
  </PropertyGroup>
  <ItemGroup>
    <FrameworkReference Include="Microsoft.AspNetCore.App" />
    <ProjectReference Include="..\..\..\..\framework\SimpleModule.Core\SimpleModule.Core.csproj" />
    <!-- Add only if the module owns a DbContext:
    <ProjectReference Include="..\..\..\..\framework\SimpleModule.Database\SimpleModule.Database.csproj" /> -->
    <ProjectReference Include="..\SimpleModule.<Name>.Contracts\SimpleModule.<Name>.Contracts.csproj" />
  </ItemGroup>
</Project>

Module.cs:

using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.DependencyInjection;
using SimpleModule.Core;
using SimpleModule.Core.Menu;
using SimpleModule.<Name>.Contracts;

namespace SimpleModule.<Name>;

[Module(<Name>Constants.ModuleName, RoutePrefix = <Name>Constants.RoutePrefix, ViewPrefix = "/<name-lowercase>")]
public class <Name>Module : IModule
{
    public void ConfigureServices(IServiceCollection services, IConfiguration configuration)
    {
        services.AddScoped<I<Name>Contracts, <Name>ContractsService>();
    }

    public void ConfigureMenu(IMenuBuilder menus)
    {
        menus.Add(
            new MenuItem
            {
                Label = "<Name>",
                Url = "/<name-lowercase>",
                Icon = """<svg class="w-4 h-4" fill="none" stroke="currentColor" stroke-width="2" viewBox="0 0 24 24"><path d="M4 6h16M4 12h16M4 18h16"/></svg>""",
                Order = 50,
                Section = MenuSection.AppSidebar,
            }
        );
    }
}