feat(csharp): Let users customize MSBuild properties using props file (…

…#5130)

Let users customize MSBuild properties using props file

generators/csharp/codegen/src/AsIs.ts

@@ -32,5 +32,6 @@ export enum AsIsFiles {
     TemplateTestCsProj = "Template.Test.csproj",
     TemplateTestClientCs = "TemplateTestClient.cs",
     UsingCs = "Using.cs",
-    Extensions = "Extensions.cs"
+    Extensions = "Extensions.cs",
+    CustomProps = "Custom.props.Template"
 }

generators/csharp/codegen/src/asIs/Custom.props.Template

@@ -0,0 +1,20 @@
+<!--
+Configure additional MSBuild properties for your project in this file:
+- Step 1: Add this file to your .fernignore file to ensure it is not overwritten.
+- Step 2: Modify this file to your liking.
+-->
+<Project Sdk="Microsoft.NET.Sdk">
+  <!--
+    <PropertyGroup>
+        <Title>Contoso SDK</Title>
+        <Authors>Contoso</Authors>
+        <Company>Contoso</Company>
+        <AssemblyName>Contoso.Sdk</AssemblyName>
+        <AssemblyTitle>Contoso SDK</AssemblyTitle>
+        <PackageIcon>icon.png</PackageIcon>
+    </PropertyGroup>
+    <ItemGroup>
+        <None Include="..\..\icon.png" Pack="true" PackagePath="" />
+    </ItemGroup>
+    -->
+</Project>

generators/csharp/codegen/src/project/CsharpProject.ts

@@ -183,6 +183,7 @@ export class CsharpProject extends AbstractProject<AbstractCsharpGeneratorContex
         );
         const protobufSourceFilePaths = await this.sourceFetcher.copyProtobufSources(absolutePathToProtoDirectory);
         const csproj = new CsProj({
+            name: this.name,
             license: this.context.config.license,
             githubUrl: this.context.config.output?.mode._visit({
                 downloadFiles: () => undefined,
@@ -198,6 +199,12 @@ export class CsharpProject extends AbstractProject<AbstractCsharpGeneratorContex
             join(absolutePathToProjectDirectory, RelativeFilePath.of(`${this.name}.csproj`)),
             templateCsProjContents
         );
+
+        await writeFile(
+            join(absolutePathToProjectDirectory, RelativeFilePath.of(`${this.name}.Custom.props`)),
+            (await readFile(getAsIsFilepath(AsIsFiles.CustomProps))).toString()
+        );
+
         await loggingExeca(this.context.logger, "dotnet", ["sln", "add", `${this.name}/${this.name}.csproj`], {
             doNotPipeOutput: true,
             cwd: absolutePathToSrcDirectory
@@ -435,6 +442,7 @@ class CsharpProjectFilepaths {
 
 declare namespace CsProj {
     interface Args {
+        name: string;
         version?: string;
         license?: FernGeneratorExec.LicenseConfig;
         githubUrl?: string;
@@ -446,13 +454,15 @@ declare namespace CsProj {
 const FOUR_SPACES = "    ";
 
 class CsProj {
+    private name: string;
     private license: FernGeneratorExec.LicenseConfig | undefined;
     private githubUrl: string | undefined;
     private packageId: string | undefined;
     private context: AbstractCsharpGeneratorContext<BaseCsharpCustomConfigSchema>;
     private protobufSourceFilePaths: RelativeFilePath[];
 
-    public constructor({ license, githubUrl, context, protobufSourceFilePaths }: CsProj.Args) {
+    public constructor({ name, license, githubUrl, context, protobufSourceFilePaths }: CsProj.Args) {
+        this.name = name;
         this.license = license;
         this.githubUrl = githubUrl;
         this.context = context;
@@ -501,6 +511,7 @@ ${this.getAdditionalItemGroups().join(`\n${FOUR_SPACES}`)}
         </AssemblyAttribute>
     </ItemGroup>
 
+    <Import Project="${this.name}.Custom.props" />
 </Project>
 `;
     }

generators/csharp/sdk/src/SdkCustomConfig.ts

@@ -10,7 +10,12 @@ export const SdkCustomConfigSchema = z.strictObject({
     "root-namespace-for-core-classes": z.boolean().optional(),
     "pascal-case-environments": z.boolean().optional(),
     "generate-error-types": z.boolean().optional(),
-    "extra-dependencies": z.record(z.string()).optional(),
+    "extra-dependencies": z
+        .record(z.string())
+        .optional()
+        .describe(
+            "(Deprecated) The extra dependencies to add into the csproj file. Use the [ProjectName].Custom.props to configure additional dependencies instead."
+        ),
     "read-only-memory-types": z.optional(z.array(z.string())),
     "experimental-enable-forward-compatible-enums": z.boolean().optional(),
     "generate-mock-server-tests": z.boolean().optional(),

generators/csharp/sdk/versions.yml

@@ -6,6 +6,12 @@
 #         The C# SDK now uses forward-compatible enums which are not compatible with the previously generated enums.
 #         Set `enable-forward-compatible-enums` to `false` in the configuration to generate the old enums.
 #   irVersion: 53
+- version: 1.9.3
+  createdAt: "2024-11-07"
+  changelogEntry:
+    - type: feat
+      summary: Generate a ProjectName.Custom.props file for you to configure any MSBuild properties for your project.
+  irVersion: 53
 - version: 1.9.2-alpha.0
   createdAt: "2024-11-07"
   changelogEntry: