Expose Generator Visitors as a Plugin (Azure#51016)

jorgerangel-msft · JoshLove-msft · web-flow · commit 6965e20468a2 · 2025-07-03T13:53:49.000-05:00
* feat: move generator visitors to plugin

* debug artifacts

* package-lock

* undo temp artifacts

* remove unneeded test

* move IsGeneratorLibrary property

* cleanup

* refactor folder structure

* pr feedback

---------

Co-authored-by: jolov &lt;jolov@microsoft.com&gt;
diff --git a/eng/http-client-csharp-emitter-package-lock.json b/eng/http-client-csharp-emitter-package-lock.json
diff --git a/eng/http-client-csharp-emitter-package.json b/eng/http-client-csharp-emitter-package.json
@@ -1,7 +1,8 @@
 {
   "main": "dist/src/index.js",
   "dependencies": {
-    "@typespec/http-client-csharp": "1.0.0-alpha.20250703.1"
+    "@typespec/http-client-csharp": "1.0.0-alpha.20250703.1",
+    "client-plugin": "file:../../../../eng/packages/plugins/client"
   },
   "devDependencies": {
     "@azure-tools/typespec-azure-core": "0.57.0",
diff --git a/eng/packages/http-client-csharp/generator/Azure.Generator/src/Azure.Generator.csproj b/eng/packages/http-client-csharp/generator/Azure.Generator/src/Azure.Generator.csproj
@@ -55,6 +55,14 @@
       <LinkBase>Shared/Core</LinkBase>
       <CopyToOutputDirectory>Always</CopyToOutputDirectory>
     </Compile>
-	</ItemGroup>
+  </ItemGroup>
+
+  <!-- Include shared Visitors code -->
+  <ItemGroup>
+    <Compile Include="$(MSBuildThisFileDirectory)..\..\..\..\visitors\Visitors\src\Shared\**\*.cs">
+      <LinkBase>Shared/Visitors</LinkBase>
+      <CopyToOutputDirectory>Always</CopyToOutputDirectory>
+    </Compile>
+  </ItemGroup>
 
 </Project>
diff --git a/eng/packages/http-client-csharp/generator/Azure.Generator/src/AzureClientGenerator.cs b/eng/packages/http-client-csharp/generator/Azure.Generator/src/AzureClientGenerator.cs
@@ -8,6 +8,7 @@
 using System;
 using System.ComponentModel.Composition;
 using System.IO;
+using Visitors;
 
 namespace Azure.Generator;
 
diff --git a/eng/packages/http-client-csharp/generator/Azure.Generator/src/Providers/ClientBuilderExtensionsDefinition.cs b/eng/packages/http-client-csharp/generator/Azure.Generator/src/Providers/ClientBuilderExtensionsDefinition.cs
@@ -8,12 +8,12 @@
 using System.Linq;
 using Azure.Core;
 using Azure.Core.Extensions;
-using Azure.Generator.Utilities;
 using Microsoft.TypeSpec.Generator.ClientModel.Providers;
 using Microsoft.TypeSpec.Generator.Expressions;
 using Microsoft.TypeSpec.Generator.Primitives;
 using Microsoft.TypeSpec.Generator.Providers;
 using Microsoft.TypeSpec.Generator.Statements;
+using Visitors.Utilities;
 using static Microsoft.TypeSpec.Generator.Snippets.Snippet;
 
 namespace Azure.Generator.Providers
diff --git a/eng/packages/http-client-csharp/generator/Azure.Generator/src/Snippets/RequestSnippets.cs b/eng/packages/http-client-csharp/generator/Azure.Generator/src/Snippets/RequestSnippets.cs
@@ -1,4 +1,4 @@
-// Copyright (c) Microsoft Corporation. All rights reserved.
+﻿// Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
 
 using System.ClientModel.Primitives;
diff --git a/eng/packages/http-client-csharp/generator/Azure.Generator/src/Visitors/SpecialHeadersVisitor.cs b/eng/packages/http-client-csharp/generator/Azure.Generator/src/Visitors/SpecialHeadersVisitor.cs
@@ -1,4 +1,4 @@
-// Copyright (c) Microsoft Corporation. All rights reserved.
+﻿// Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
 
 using System.Collections.Generic;
diff --git a/eng/packages/http-client-csharp/generator/Azure.Generator/test/AzureClientGeneratorTests.cs b/eng/packages/http-client-csharp/generator/Azure.Generator/test/AzureClientGeneratorTests.cs
@@ -1,9 +1,9 @@
-// Copyright (c) Microsoft Corporation. All rights reserved.
+﻿// Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
 
 using Azure.Generator.Tests.TestHelpers;
-using Azure.Generator.Visitors;
 using NUnit.Framework;
+using Visitors;
 
 namespace Azure.Generator.Tests
 {
diff --git a/eng/packages/plugins/client/Client.Plugin/Client.Plugin.sln b/eng/packages/plugins/client/Client.Plugin/Client.Plugin.sln
@@ -0,0 +1,25 @@
+﻿
+Microsoft Visual Studio Solution File, Format Version 12.00
+# Visual Studio Version 17
+VisualStudioVersion = 17.13.35931.197
+MinimumVisualStudioVersion = 10.0.40219.1
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Client.Plugin", "src\Client.Plugin.csproj", "{45254A64-6143-2A86-8AE9-04942065190A}"
+EndProject
+Global
+	GlobalSection(SolutionConfigurationPlatforms) = preSolution
+		Debug|Any CPU = Debug|Any CPU
+		Release|Any CPU = Release|Any CPU
+	EndGlobalSection
+	GlobalSection(ProjectConfigurationPlatforms) = postSolution
+		{45254A64-6143-2A86-8AE9-04942065190A}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{45254A64-6143-2A86-8AE9-04942065190A}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{45254A64-6143-2A86-8AE9-04942065190A}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{45254A64-6143-2A86-8AE9-04942065190A}.Release|Any CPU.Build.0 = Release|Any CPU
+	EndGlobalSection
+	GlobalSection(SolutionProperties) = preSolution
+		HideSolutionNode = FALSE
+	EndGlobalSection
+	GlobalSection(ExtensibilityGlobals) = postSolution
+		SolutionGuid = {7DE7608F-D322-4ECA-819B-63791050504C}
+	EndGlobalSection
+EndGlobal
diff --git a/eng/packages/plugins/client/Client.Plugin/src/Client.Plugin.csproj b/eng/packages/plugins/client/Client.Plugin/src/Client.Plugin.csproj
@@ -0,0 +1,28 @@
+﻿<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <Version>1.0.0-beta.1</Version>
+    <!--Ensure all dependencies are copied to the output directory so that they can be packaged up for npm.-->
+    <CopyLocalLockFileAssemblies>true</CopyLocalLockFileAssemblies>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <PackageReference Include="Microsoft.TypeSpec.Generator.ClientModel" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <Compile Include="$(MSBuildThisFileDirectory)..\..\..\..\visitors\Visitors\src\Shared\**\*.cs">
+      <LinkBase>Shared/Visitors</LinkBase>
+      <CopyToOutputDirectory>Always</CopyToOutputDirectory>
+    </Compile>
+  </ItemGroup>
+
+  <!-- Copy output to package dist path  -->
+  <Target Name="CopyForNpmPackage" AfterTargets="Build">
+    <Message Text="Copying output to dist path" Importance="high" />
+    <ItemGroup>
+      <SourceDir Include="$(OutputPath)**\*.*" />
+    </ItemGroup>
+    <Copy SourceFiles="@(SourceDir)" DestinationFolder="$(MSBuildThisFileDirectory)..\..\dist\%(RecursiveDir)" />
+  </Target>
+</Project>
diff --git a/eng/packages/plugins/client/Client.Plugin/src/ClientPlugin.cs b/eng/packages/plugins/client/Client.Plugin/src/ClientPlugin.cs
@@ -0,0 +1,24 @@
+﻿// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+using Microsoft.TypeSpec.Generator;
+using Visitors;
+
+namespace Client.Plugin
+{
+    /// <summary>
+    /// ClientPlugin is a generator plugin that applies several visitors to mutate the generated client library.
+    /// </summary>
+    internal sealed class ClientPlugin : GeneratorPlugin
+    {
+        /// <inheritdoc />
+        public override void Apply(CodeModelGenerator generator)
+        {
+            // Visitors that do any renaming must be added first so that any visitors relying on custom code view will have the CustomCodeView set.
+            generator.AddVisitor(new ModelFactoryRenamerVisitor());
+
+            // Rest of the visitors can be added in any order.
+            generator.AddVisitor(new NamespaceVisitor());
+        }
+    }
+}
diff --git a/eng/packages/plugins/client/Client.Plugin/src/Properties/AssemblyInfo.cs b/eng/packages/plugins/client/Client.Plugin/src/Properties/AssemblyInfo.cs
@@ -0,0 +1,6 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+using System.Runtime.CompilerServices;
+
+[assembly: InternalsVisibleTo("Client.Plugin.Tests, PublicKey=0024000004800000940000000602000000240000525341310004000001000100d15ddcb29688295338af4b7686603fe614abd555e09efba8fb88ee09e1f7b1ccaeed2e8f823fa9eef3fdd60217fc012ea67d2479751a0b8c087a4185541b851bd8b16f8d91b840e51b1cb0ba6fe647997e57429265e85ef62d565db50a69ae1647d54d7bd855e4db3d8a91510e5bcbd0edfbbecaa20a7bd9ae74593daa7b11b4")]
diff --git a/eng/packages/plugins/client/Directory.Build.props b/eng/packages/plugins/client/Directory.Build.props
@@ -0,0 +1,14 @@
+<Project ToolsVersion="15.0" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
+  <PropertyGroup>
+    <Nullable>enable</Nullable>
+    <ImportDefaultReferences>false</ImportDefaultReferences>
+    <IsShippingLibrary>false</IsShippingLibrary>
+    <NoWarn>$(NoWarn);CS8002</NoWarn>
+    <ImportRepoCommonSettings>true</ImportRepoCommonSettings>
+    <IsGeneratorLibrary>true</IsGeneratorLibrary>
+  </PropertyGroup>
+  <!--
+  Add any shared properties you want for the projects under this package directory that need to be set before the auto imported Directory.Build.props
+  -->
+  <Import Project="$([MSBuild]::GetDirectoryNameOfFileAbove($(MSBuildThisFileDirectory).., Directory.Build.props))\Directory.Build.props" />
+</Project>
diff --git a/eng/packages/plugins/client/package.json b/eng/packages/plugins/client/package.json
@@ -0,0 +1,11 @@
+{
+  "name": "client-plugin",
+  "version": "1.0.0",
+  "main": "index.js",
+  "author": "",
+  "license": "ISC",
+  "description": "A client plugin for mutating a library generated with @typespec/http-client-csharp and related TypeSpec C# emitters.",
+  "files": [
+    "dist/**"
+  ]
+}
diff --git a/eng/packages/visitors/Visitors/Directory.Build.props b/eng/packages/visitors/Visitors/Directory.Build.props
@@ -0,0 +1,14 @@
+<Project ToolsVersion="15.0" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
+  <PropertyGroup>
+    <Nullable>enable</Nullable>
+    <ImportDefaultReferences>false</ImportDefaultReferences>
+    <IsShippingLibrary>false</IsShippingLibrary>
+    <NoWarn>$(NoWarn);CS8002</NoWarn>
+    <ImportRepoCommonSettings>true</ImportRepoCommonSettings>
+    <IsGeneratorLibrary>true</IsGeneratorLibrary>
+  </PropertyGroup>
+  <!--
+  Add any shared properties you want for the projects under this package directory that need to be set before the auto imported Directory.Build.props
+  -->
+  <Import Project="$([MSBuild]::GetDirectoryNameOfFileAbove($(MSBuildThisFileDirectory).., Directory.Build.props))\Directory.Build.props" />
+</Project>
diff --git a/eng/packages/visitors/Visitors/Visitors.sln b/eng/packages/visitors/Visitors/Visitors.sln
@@ -0,0 +1,37 @@
+﻿
+Microsoft Visual Studio Solution File, Format Version 12.00
+# Visual Studio Version 17
+VisualStudioVersion = 17.13.35931.197
+MinimumVisualStudioVersion = 10.0.40219.1
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Visitors", "src\Visitors.csproj", "{5471560D-B81F-4B35-A8BE-372C97FC6A91}"
+EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Visitors.Tests", "test\Visitors.Tests\Visitors.Tests.csproj", "{ABAB53AD-6053-422F-BC51-837AC143BDD1}"
+EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Visitors.Tests.Common", "test\Visitors.Tests.Common\Visitors.Tests.Common.csproj", "{A1AA2C63-2441-455F-AA47-26602DEE4304}"
+EndProject
+Global
+	GlobalSection(SolutionConfigurationPlatforms) = preSolution
+		Debug|Any CPU = Debug|Any CPU
+		Release|Any CPU = Release|Any CPU
+	EndGlobalSection
+	GlobalSection(ProjectConfigurationPlatforms) = postSolution
+		{5471560D-B81F-4B35-A8BE-372C97FC6A91}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{5471560D-B81F-4B35-A8BE-372C97FC6A91}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{5471560D-B81F-4B35-A8BE-372C97FC6A91}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{5471560D-B81F-4B35-A8BE-372C97FC6A91}.Release|Any CPU.Build.0 = Release|Any CPU
+		{ABAB53AD-6053-422F-BC51-837AC143BDD1}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{ABAB53AD-6053-422F-BC51-837AC143BDD1}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{ABAB53AD-6053-422F-BC51-837AC143BDD1}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{ABAB53AD-6053-422F-BC51-837AC143BDD1}.Release|Any CPU.Build.0 = Release|Any CPU
+		{A1AA2C63-2441-455F-AA47-26602DEE4304}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{A1AA2C63-2441-455F-AA47-26602DEE4304}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{A1AA2C63-2441-455F-AA47-26602DEE4304}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{A1AA2C63-2441-455F-AA47-26602DEE4304}.Release|Any CPU.Build.0 = Release|Any CPU
+	EndGlobalSection
+	GlobalSection(SolutionProperties) = preSolution
+		HideSolutionNode = FALSE
+	EndGlobalSection
+	GlobalSection(ExtensibilityGlobals) = postSolution
+		SolutionGuid = {109781BE-3091-42F8-A7C5-FA840F7FE4BC}
+	EndGlobalSection
+EndGlobal
diff --git a/eng/packages/visitors/Visitors/src/Properties/AssemblyInfo.cs b/eng/packages/visitors/Visitors/src/Properties/AssemblyInfo.cs
@@ -0,0 +1,6 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+using System.Runtime.CompilerServices;
+
+[assembly: InternalsVisibleTo("Visitors.Tests, PublicKey=0024000004800000940000000602000000240000525341310004000001000100d15ddcb29688295338af4b7686603fe614abd555e09efba8fb88ee09e1f7b1ccaeed2e8f823fa9eef3fdd60217fc012ea67d2479751a0b8c087a4185541b851bd8b16f8d91b840e51b1cb0ba6fe647997e57429265e85ef62d565db50a69ae1647d54d7bd855e4db3d8a91510e5bcbd0edfbbecaa20a7bd9ae74593daa7b11b4")]
diff --git a/eng/packages/visitors/Visitors/src/Shared/Extensions/ConfigurationExtensions.cs b/eng/packages/visitors/Visitors/src/Shared/Extensions/ConfigurationExtensions.cs
@@ -0,0 +1,22 @@
+﻿// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+using System;
+using System.Collections.Generic;
+using Microsoft.TypeSpec.Generator;
+
+namespace Visitors.Extensions
+{
+    internal static class ConfigurationExtensions
+    {
+        public static bool UseModelNamespace(this Configuration config) =>
+            UseModelNamespace(config.AdditionalConfigurationOptions);
+
+        internal static bool UseModelNamespace(IReadOnlyDictionary<string, BinaryData> options)
+        {
+            return options.TryGetValue("model-namespace", out var value) &&
+                   bool.TryParse(value.ToString(), out var parsed) &&
+                   parsed;
+        }
+    }
+}
diff --git a/eng/packages/visitors/Visitors/src/Shared/ModelFactoryRenamerVisitor.cs b/eng/packages/visitors/Visitors/src/Shared/ModelFactoryRenamerVisitor.cs
@@ -1,11 +1,11 @@
-// Copyright (c) Microsoft Corporation. All rights reserved.
+﻿// Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
 
-using Azure.Generator.Utilities;
 using Microsoft.TypeSpec.Generator.ClientModel;
 using Microsoft.TypeSpec.Generator.Providers;
+using Visitors.Utilities;
 
-namespace Azure.Generator.Visitors
+namespace Visitors
 {
     internal class ModelFactoryRenamerVisitor : ScmLibraryVisitor
     {
@@ -21,4 +21,4 @@ internal class ModelFactoryRenamerVisitor : ScmLibraryVisitor
             return type;
         }
     }
-}
+}
diff --git a/eng/packages/visitors/Visitors/src/Shared/NamespaceVisitor.cs b/eng/packages/visitors/Visitors/src/Shared/NamespaceVisitor.cs
@@ -2,13 +2,18 @@
 // Licensed under the MIT License.
 
 using System.IO;
+using Microsoft.TypeSpec.Generator;
 using Microsoft.TypeSpec.Generator.ClientModel;
 using Microsoft.TypeSpec.Generator.ClientModel.Providers;
 using Microsoft.TypeSpec.Generator.Input;
 using Microsoft.TypeSpec.Generator.Providers;
+using Visitors.Extensions;
 
-namespace Azure.Generator.Visitors
+namespace Visitors
 {
+    /// <summary>
+    /// Visitor that updates the namespace and file paths for model and enum types.
+    /// </summary>
     internal class NamespaceVisitor : ScmLibraryVisitor
     {
         protected override ModelProvider? PreVisitModel(InputModelType model, ModelProvider? type)
@@ -52,14 +57,14 @@ internal class NamespaceVisitor : ScmLibraryVisitor
 
         private static void UpdateModelsNamespace(TypeProvider type)
         {
-            if (AzureClientGenerator.Instance.Configuration.UseModelNamespace())
+            if (CodeModelGenerator.Instance.Configuration.UseModelNamespace())
             {
                 // If the type is customized, then we don't want to override the namespace.
                 if (type.CustomCodeView == null)
                 {
                     type.Update(
-                        @namespace: AzureClientGenerator.Instance.TypeFactory.GetCleanNameSpace(
-                            $"{AzureClientGenerator.Instance.TypeFactory.PrimaryNamespace}.Models"));
+                        @namespace: CodeModelGenerator.Instance.TypeFactory.GetCleanNameSpace(
+                            $"{CodeModelGenerator.Instance.TypeFactory.PrimaryNamespace}.Models"));
                 }
             }
             else
diff --git a/eng/packages/visitors/Visitors/src/Shared/Utilities/TypeNameUtilities.cs b/eng/packages/visitors/Visitors/src/Shared/Utilities/TypeNameUtilities.cs
@@ -1,24 +1,19 @@
-// Copyright (c) Microsoft Corporation. All rights reserved.
+﻿// Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
 
+using Microsoft.TypeSpec.Generator;
 using System.Linq;
 
-namespace Azure.Generator.Utilities
+namespace Visitors.Utilities
 {
     internal static class TypeNameUtilities
     {
         private const string AzurePackageNamespacePrefix = "Azure.";
         private const string AzureResourceManagerPackageNamespacePrefix = "Azure.ResourceManager.";
 
-        /// <summary>
-        /// Returns the name of the RP from the package name using the following:
-        /// If the package name starts with `Azure.ResourceManager`, returns every segment concatenating after the `Azure.ResourceManager` prefix.
-        /// If the package name starts with `Azure`, returns every segment concatenating together after the `Azure` prefix.
-        /// Returns the package name as the RP name if nothing matches.
-        /// </summary>
         public static string GetResourceProviderName()
         {
-            var packageName = AzureClientGenerator.Instance.Configuration.PackageName;
+            var packageName = CodeModelGenerator.Instance.Configuration.PackageName;
             var segments = packageName.Split('.');
             if (packageName.StartsWith(AzureResourceManagerPackageNamespacePrefix))
             {
@@ -37,4 +32,4 @@ public static string GetResourceProviderName()
             return string.Join("", segments);
         }
     }
-}
+}
diff --git a/eng/packages/visitors/Visitors/src/Visitors.csproj b/eng/packages/visitors/Visitors/src/Visitors.csproj
diff --git a/eng/packages/visitors/Visitors/test/Visitors.Tests.Common/InputFactory.cs b/eng/packages/visitors/Visitors/test/Visitors.Tests.Common/InputFactory.cs
diff --git a/eng/packages/visitors/Visitors/test/Visitors.Tests.Common/Visitors.Tests.Common.csproj b/eng/packages/visitors/Visitors/test/Visitors.Tests.Common/Visitors.Tests.Common.csproj
diff --git a/eng/packages/visitors/Visitors/test/Visitors.Tests/TestHelpers/Configuration.json b/eng/packages/visitors/Visitors/test/Visitors.Tests/TestHelpers/Configuration.json
diff --git a/eng/packages/visitors/Visitors/test/Visitors.Tests/TestHelpers/MockHelpers.cs b/eng/packages/visitors/Visitors/test/Visitors.Tests/TestHelpers/MockHelpers.cs
diff --git a/eng/packages/visitors/Visitors/test/Visitors.Tests/Visitors.Tests.csproj b/eng/packages/visitors/Visitors/test/Visitors.Tests/Visitors.Tests.csproj
diff --git a/eng/packages/visitors/Visitors/test/Visitors.Tests/Visitors/ModelFactoryRenamerVisitorTests.cs b/eng/packages/visitors/Visitors/test/Visitors.Tests/Visitors/ModelFactoryRenamerVisitorTests.cs
diff --git a/eng/packages/visitors/Visitors/test/Visitors.Tests/Visitors/NamespaceVisitorTests.cs b/eng/packages/visitors/Visitors/test/Visitors.Tests/Visitors/NamespaceVisitorTests.cs

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-// Copyright (c) Microsoft Corporation. All rights reserved.`
	`1`	`+// Copyright (c) Microsoft Corporation. All rights reserved.`
`2`	`2`	`// Licensed under the MIT License.`
`3`	`3`
`4`	`4`	`using System.ClientModel.Primitives;`