Code Generation

To get started with code generation install the Xcst.Compiler NuGet package.


Generating code for your C# project can done in a pre-build event. Add the following script to your project (e.g. xcst.ps1):

$ErrorActionPreference = "Stop"
Push-Location (Split-Path $script:MyInvocation.MyCommand.Path)

function GeneratePackages {

   $startDirectory = Get-Item .
   $pkgFileExtension = "xcst"
   $nugetPackages = Resolve-Path ..\..\packages

   # AssemblyResolve is used to enable loading newer versions of Xcst.Compiler's dependencies

   $onAssemblyResolve = [ResolveEventHandler] {
      param($sender, $e)
      $assemblyName = $e.Name.Substring(0, $e.Name.IndexOf(","))
      $assemblyPath = "$nugetPackages\$assemblyName.*\lib\net46\$assemblyName.dll"

      if ($assemblyName.StartsWith("saxon9he") -or $assemblyName.StartsWith("IKVM.")) {
         $assemblyPath = "$nugetPackages\Saxon-HE.*\lib\net40\$assemblyName.dll"
      } elseif ($assemblyName.StartsWith("Newtonsoft.Json")) {
         $assemblyPath = "$nugetPackages\$assemblyName.*\lib\net45\$assemblyName.dll"

      return [Reflection.Assembly]::LoadFrom((Resolve-Path $assemblyPath))

   try {
      Add-Type -Path $nugetPackages\Xcst.Compiler.*\lib\net46\Xcst.Compiler.dll

      $compilerFactory = New-Object Xcst.Compiler.XcstCompilerFactory
      $compilerFactory.PackagesLocation = $startDirectory.FullName
      $compilerFactory.PackageFileExtension = $pkgFileExtension

      # Enable Application Extension

      Add-Type -Path $nugetPackages\Xcst.AspNet.*\lib\net46\Xcst.AspNet.dll
      $compilerFactory.EnableExtensions = $true

      foreach ($file in ls $startDirectory.FullName *.$pkgFileExtension -Recurse) {

         # Treat files starting with underscore as non-principal modules

         if ($file.Name[0] -eq '_') {

         $compiler = $compilerFactory.CreateCompiler()
         $compiler.NamedPackage = $true

         $xcstResult = $compiler.Compile((New-Object Uri $file.FullName))

         foreach ($src in $xcstResult.CompilationUnits) {
            write $src
   } finally {
      # Detach the event handler (not detaching can lead to stack overflow issues when closing PS)

try {
   GeneratePackages | Out-File xcst.generated.cs -Encoding utf8
} finally {

…and add the following to your project file (.csproj):

   <PreBuildEvent>powershell -NoProfile -ExecutionPolicy RemoteSigned -File $(ProjectDir)\xcst.ps1</PreBuildEvent>

When you build your project a xcst.generated.cs file will be generated. This file will include the code for all the named packages in any subdirectory starting from the location of the powershell script.

Next, add xcst.generated.cs to your project. Note that, because we are using a pre-build event, this file does not need to exist when you build and generate code for the first time.

Lastly, make sure your project references the Xcst.Runtime NuGet package.