Scaffolding extension (#5723)

Supports Azure/azure-sdk-for-net#47071 by adding extensibility so we can generate csprojs in the azure plugin that are different. Partially fixes #4065
microsoft · Jan 23, 2025 · cd0880d · cd0880d
1 parent 6d9761d
commit cd0880d
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 13 deletions.
diff --git a/packages/http-client-csharp/generator/Microsoft.Generator.CSharp/src/CSharpGen.cs b/packages/http-client-csharp/generator/Microsoft.Generator.CSharp/src/CSharpGen.cs
@@ -80,8 +80,7 @@ public async Task ExecuteAsync()
             // Write project scaffolding files
             if (CodeModelPlugin.Instance.IsNewProject)
             {
-                var scaffolding = new NewProjectScaffolding();
-                await scaffolding.Execute();
+                await CodeModelPlugin.Instance.TypeFactory.CreateNewProjectScaffolding().Execute();
             }
         }
 

diff --git a/...lient-csharp/generator/Microsoft.Generator.CSharp/src/Primitives/NewProjectScaffolding.cs b/...lient-csharp/generator/Microsoft.Generator.CSharp/src/Primitives/NewProjectScaffolding.cs
@@ -9,8 +9,8 @@
 
 namespace Microsoft.Generator.CSharp.Primitives
 {
-    //TODO Keeping internal for now until we define the extensibility points https://github.com/microsoft/typespec/issues/4065
-    internal class NewProjectScaffolding
+    //TODO Need to define the rest of the extensibility points https://github.com/microsoft/typespec/issues/4065
+    public class NewProjectScaffolding
     {
         public async Task<bool> Execute()
         {
@@ -35,7 +35,7 @@ private async Task WriteProjectFiles()
         {
             await File.WriteAllBytesAsync(
                 Path.Combine(CodeModelPlugin.Instance.Configuration.ProjectDirectory, $"{CodeModelPlugin.Instance.Configuration.RootNamespace}.csproj"),
-                Encoding.UTF8.GetBytes(NormalizeLineEndings(GetSrcCSProj())));
+                Encoding.UTF8.GetBytes(NormalizeLineEndings(GetSourceProjectFileContent())));
         }
 
         private string NormalizeLineEndings(string content)
@@ -47,12 +47,12 @@ private async Task WriteSolutionFiles()
         {
             await File.WriteAllBytesAsync(
                 Path.Combine(CodeModelPlugin.Instance.Configuration.OutputDirectory, $"{CodeModelPlugin.Instance.Configuration.RootNamespace}.sln"),
-                Encoding.UTF8.GetBytes(NormalizeLineEndings(GetSln())));
+                Encoding.UTF8.GetBytes(NormalizeLineEndings(GetSolutionFileContent())));
         }
 
-        private string GetSrcCSProj()
+        protected virtual string GetSourceProjectFileContent()
         {
-            var builder = new CSProjWriter()
+            var builder = new CSharpProjectWriter()
             {
                 Description = $"This is the {CodeModelPlugin.Instance.Configuration.RootNamespace} client library for developing .NET applications with rich experience.",
                 AssemblyTitle = $"SDK Code Generation {CodeModelPlugin.Instance.Configuration.RootNamespace}",
@@ -70,13 +70,13 @@ private string GetSrcCSProj()
             return builder.Write();
         }
 
-        private static readonly IReadOnlyList<CSProjWriter.CSProjDependencyPackage> _unbrandedDependencyPackages = new CSProjWriter.CSProjDependencyPackage[]
+        private static readonly IReadOnlyList<CSharpProjectWriter.CSProjDependencyPackage> _unbrandedDependencyPackages = new CSharpProjectWriter.CSProjDependencyPackage[]
         {
             new("System.ClientModel", "1.1.0-beta.4"),
             new("System.Text.Json", "8.0.5")
         };
 
-        private string GetSln()
+        protected virtual string GetSolutionFileContent()
         {
             string slnContent = @"Microsoft Visual Studio Solution File, Format Version 12.00
 # Visual Studio Version 16

diff --git a/packages/http-client-csharp/generator/Microsoft.Generator.CSharp/src/TypeFactory.cs b/packages/http-client-csharp/generator/Microsoft.Generator.CSharp/src/TypeFactory.cs
@@ -311,6 +311,11 @@ protected virtual IReadOnlyList<TypeProvider> CreateSerializationsCore(InputType
             return [];
         }
 
+        public virtual NewProjectScaffolding CreateNewProjectScaffolding()
+        {
+            return new NewProjectScaffolding();
+        }
+
         private readonly struct EnumCacheKey
         {
             public InputEnumType EnumType { get; }

diff --git a/...erator.CSharp/src/Writers/CSProjWriter.cs → ...CSharp/src/Writers/CSharpProjectWriter.cs b/...erator.CSharp/src/Writers/CSProjWriter.cs → ...CSharp/src/Writers/CSharpProjectWriter.cs
@@ -8,9 +8,9 @@
 
 namespace Microsoft.Generator.CSharp;
 
-internal class CSProjWriter
+public class CSharpProjectWriter
 {
-    public CSProjWriter()
+    public CSharpProjectWriter()
     {
         ProjectReferences = new List<CSProjDependencyPackage>();
         PackageReferences = new List<CSProjDependencyPackage>();
@@ -137,7 +137,7 @@ public string Write()
         return builder.ToString();
     }
 
-    private static readonly IEnumerable<PropertyInfo> _properties = typeof(CSProjWriter).GetProperties(BindingFlags.Public | BindingFlags.Instance);
+    private static readonly IEnumerable<PropertyInfo> _properties = typeof(CSharpProjectWriter).GetProperties(BindingFlags.Public | BindingFlags.Instance);
 
     private void WriteProperties(XmlWriter writer)
     {