Skip to content

AGENTS.md

Latest commit

 

History

History
62 lines (45 loc) · 2.72 KB

AGENTS.md

File metadata and controls

62 lines (45 loc) · 2.72 KB

Blazor.Map — Project Agent Instructions

Project Overview

Spillgebees.Blazor.Map is a Blazor map component library powered by Leaflet. It supports Blazor Server, WebAssembly, and the unified .NET 8+ web app model.

Architecture

Solution structure

Spillgebees.Blazor.Map.slnx                                # XML solution (root)
├── src/Spillgebees.Blazor.Map/                            # Razor Class Library (NuGet package)
├── src/Spillgebees.Blazor.Map.Assets/                     # TypeScript/SCSS source (Vite + pnpm)
├── src/Spillgebees.Blazor.Map.Tests/                      # TUnit + bUnit tests
└── src/Spillgebees.Blazor.Map.Samples/
    ├── Spillgebees.Blazor.Map.Samples.Shared/             # Shared sample components
    ├── Spillgebees.Blazor.Map.Samples.Server/             # Blazor Server sample
    ├── Spillgebees.Blazor.Map.Samples.Wasm/               # Blazor WASM sample
    └── Spillgebees.Blazor.Map.Samples.WebApp/             # .NET 8+ unified web app sample

JS/CSS build pipeline

TypeScript source lives in src/Spillgebees.Blazor.Map.Assets/, which has its own .csproj using the Microsoft.Build.NoTargets SDK (single-targeted, netstandard2.0). It owns the MSBuild targets (PnpmInstall, PnpmBuild, PnpmClean) that invoke pnpm install and vite build, outputting to src/Spillgebees.Blazor.Map/wwwroot/.

The main Razor Class Library references the Assets project via <ProjectReference> with ReferenceOutputAssembly="false" to establish a build-order dependency. This ensures pnpm runs exactly once before any of the library's inner builds proceed.

  • Entry: src/index.ts (Blazor JS initializer lifecycle hooks)
  • Bundler: Vite (library mode, ES2022, ESM)
  • Output: Spillgebees.Blazor.Map.lib.module.{js,css}
  • Linter: Biome
  • Tests: Vitest + jsdom

JS interop pattern

Uses Blazor's JS initializer pattern with a global window.Spillgebees namespace. The C# side calls into Spillgebees.Map.mapFunctions.* via IJSRuntime.

.NET target

The library targets net10.0 (configured in src/General.targets). ASP.NET Core package versions are pinned in src/Directory.Packages.props.

Testing

  • .NET: TUnit + AwesomeAssertions + bUnit
  • TypeScript: Vitest + jsdom
  • Run .NET tests: dotnet test --solution Spillgebees.Blazor.Map.slnx
  • Run TS tests: pnpm run test (from src/Spillgebees.Blazor.Map.Assets/)

Dev tooling

  • CSharpier: formats .cs, .csproj, .props, .targets, .slnx, .xml
  • Husky.Net: pre-commit hook runs CSharpier on staged files
  • Biome: formats + lints TypeScript (configured in src/Spillgebees.Blazor.Map.Assets/biome.json)