Configuration
The proxy generator is configured through MSBuild properties and item groups in your .csproj file. Configuration is split into the following topics:
- Basic Options — output path, segments to skip, source file output, decorator metadata
- Library Mode — generate TypeScript for every public type in the assembly
- Type Exclusions — exclude specific types or namespaces from generation
- Namespace Roots — pin a namespace as the folder root
- Assembly-to-Package Mappings — import from external npm packages instead of regenerating
- Routing — control how API routes are built
- Output Behavior — incremental vs. full regeneration
Quick Reference
Section titled “Quick Reference”| Property / Item | Default | Topic |
|---|---|---|
CratisProxiesOutputPath | (required) | Basic |
CratisProxiesSegmentsToSkip | 0 | Basic |
CratisProxiesUseSourceFileAsOutputFile | false | Basic |
CratisProxiesLibraryMode | false | Library Mode |
<ExcludeType TypeName="..."/> | — | Type Exclusions |
<ExcludeNamespace Namespace="..."/> | — | Type Exclusions |
<NamespaceRoot Namespace="..."/> | — | Namespace Roots |
<AssemblyToPackageMapping .../> | — | Assembly-to-Package |
CratisProxiesSkipCommandNameInRoute | false | Routing |
CratisProxiesSkipQueryNameInRoute | false | Routing |
CratisProxiesApiPrefix | api | Routing |
CratisProxiesSkipIndexGeneration | false | Output Behavior |
CratisProxiesSkipOutputDeletion | true | Output Behavior |
CratisProxiesSkipFileIndexTracking | false | Output Behavior |