Sunder.Package.Templates 0.8.7

Sunder.Package.Templates

Sunder.Package.Templates provides the dotnet new sunder-package template for creating Sunder runtime package projects.

The template scaffolds a package project that references Sunder.Sdk, Sunder.Package.Build, and Avalonia, declares package metadata, includes a package module, and can optionally include a starter Avalonia view, public contracts project, runtime host dependency, and typed host contracts reference.

Install

Install the template package from NuGet.org:

dotnet new install Sunder.Package.Templates

Install a specific version:

dotnet new install Sunder.Package.Templates::<version>

Create A Package

Create a standard package with a default shell view:

dotnet new sunder-package --name MyPackage --packageId my.company.package --packageName "My Package"

Create package files directly in the specified output folder:

dotnet new sunder-package --name MyPackage --packageId my.company.package --packageName "My Package" --createInPlace --output .\MyPackage

Create a package with no default view:

dotnet new sunder-package --name MyHeadlessPackage --packageId my.company.headless --packageName "My Headless Package" --noDefaultView

Create a package that exposes public contracts:

dotnet new sunder-package --name MyPackage --packageId my.company.package --packageName "My Package" --withContracts

Create an extension package that depends on a host package:

dotnet new sunder-package --name MyExtension --packageId my.company.extension --packageName "My Extension" --withHostDependency --hostPackageId sunder.package.host

Create an extension package that also references a host contracts NuGet package:

dotnet new sunder-package --name MyTypedExtension --packageId my.company.typedextension --packageName "My Typed Extension" --withHostContracts --hostPackageId sunder.package.host --hostContractsPackageId Sunder.Host.Package.Contracts --hostContractsVersion <host-contracts-version>

Template Options

Generated Project

A standard generated package includes:

MyPackage/
  MyPackage.csproj
  PackageMetadata.cs
  PackageModule.cs
  Assets/
    icon.png
  PackageViews/
    DefaultPackageView.axaml
    DefaultPackageView.axaml.cs
    DefaultPackageViewModel.cs

Without --createInPlace, the template keeps the project under a child MyPackage/ folder in the selected output. With --createInPlace, the project files above are written directly into the selected output folder.

Generated package projects reference:

• Sunder.Sdk
• Sunder.Package.Build
• Avalonia

Generated projects use NuGet floating versions for Sunder.Sdk and Sunder.Package.Build, so restores resolve the latest stable Sunder SDK/build tooling from the configured package sources.

Package identity and dependencies are emitted from PackageMetadata.cs; Sunder.Package.Build generates sunder-package.json during build.

Build And Run

Build the generated package project:

dotnet build .\MyPackage\MyPackage.csproj

The build emits an unpacked development package under bin/Debug/net10.0/sunder-dev/.

Load the dev package into an installed Sunder App:

& "C:\Path\To\Sunder.App.exe" --dev-package ".\MyPackage\bin\Debug\net10.0\sunder-dev"

Publish

Publish the generated package project to create a .sunderpkg archive:

dotnet publish .\MyPackage\MyPackage.csproj -c Release

Validate before publishing to a registry:

sunder package validate .\MyPackage\bin\Release\net10.0\publish\MyPackage.1.0.0.sunderpkg

More Documentation

• Package author manual: https://github.com/Younics/sunder-core/blob/main/docs/SUNDER-PACKAGE-DEVELOPMENT.md
• Package standard: https://github.com/Younics/sunder-core/blob/main/docs/SUNDER-PACKAGE-STANDARD.md
• Sunder SDK: https://www.nuget.org/packages/Sunder.Sdk