refactor(godot): 重构源代码生成器依赖结构

- 将CommonDiagnostics移至GFramework.SourceGenerators.Common模块 - 添加PathContests常量类统一管理路径常量 - 更新GodotLoggerGenerator使用新的路径常量和诊断引用 - 修改项目引用以包含GFramework.SourceGenerators.Common依赖 - 更新NuGet包配置以包含Common模块的DLL和XML文档 - 在解决方案文件中添加GFramework.SourceGenerators.Common项目引用 - 为Common模块创建Analyzer发布跟踪文件
2026-03-22 02:24:30 +08:00 · 2025-12-28 08:54:52 +08:00 · 2025-12-28 08:54:52 +08:00 · 929ea6b2d6
commit 929ea6b2d6
parent 60a42a5f1e
19 changed files with 109 additions and 42 deletions
--- a/GFramework.Godot.SourceGenerators/AnalyzerReleases.Unshipped.md
+++ b/GFramework.Godot.SourceGenerators/AnalyzerReleases.Unshipped.md
@ -5,5 +5,4 @@

 Rule ID              | Category                 | Severity | Notes                  
 ----------------------|--------------------------|----------|------------------------
- GF_Common_Class_001  | GFramework.Common        | Error    | CommonDiagnostics      
 GF_Godot_Logging_001 | GFramework.Godot.Logging | Warning  | GodotLoggerDiagnostics 
--- a/GFramework.Godot.SourceGenerators/GFramework.Godot.SourceGenerators.csproj
+++ b/GFramework.Godot.SourceGenerators/GFramework.Godot.SourceGenerators.csproj
@ -29,6 +29,7 @@
    <!-- Generator 编译期引用 Attributes / Common，但不打包 -->
    <ItemGroup>
        <ProjectReference Include="..\GFramework.Godot.SourceGenerators.Abstractions\GFramework.Godot.SourceGenerators.Abstractions.csproj" PrivateAssets="all"/>
+        <ProjectReference Include="..\GFramework.SourceGenerators.Common\GFramework.SourceGenerators.Common.csproj" PrivateAssets="all"/>
    </ItemGroup>

    <!-- ★关键：只把 Generator DLL 放进 analyzers -->
@ -44,10 +45,17 @@
              Pack="true"
              PackagePath="analyzers/dotnet/cs"
              Visible="false"/>
+        <!-- ★ Generator 运行期依赖 -->
+        <None Include="$(OutputPath)\GFramework.SourceGenerators.Common.dll"
+              Pack="true"
+              PackagePath="analyzers/dotnet/cs"
+              Visible="false"/>
    </ItemGroup>
    <ItemGroup>
        <None Include="$(OutputPath)\$(AssemblyName).Abstractions.dll" Pack="true" PackagePath="lib\netstandard2.0" Visible="true"/>
        <None Include="$(OutputPath)\$(AssemblyName).Abstractions.xml" Pack="true" PackagePath="lib\netstandard2.0" Visible="true"/>
+        <None Include="$(OutputPath)\$(AssemblyName).Common.dll" Pack="true" PackagePath="lib\netstandard2.0" Visible="true"/>
+        <None Include="$(OutputPath)\$(AssemblyName).Common.xml" Pack="true" PackagePath="lib\netstandard2.0" Visible="true"/>
        <!-- 包含targets文件 -->
        <None Include="GeWuYou.GFramework.Godot.SourceGenerators.targets" Pack="true" PackagePath="build" Visible="false"/>
    </ItemGroup>
--- a/GFramework.Godot.SourceGenerators/GeWuYou.GFramework.Godot.SourceGenerators.targets
+++ b/GFramework.Godot.SourceGenerators/GeWuYou.GFramework.Godot.SourceGenerators.targets
@ -6,6 +6,7 @@
    <ItemGroup>
        <Analyzer Include="$(MSBuildThisFileDirectory)../analyzers/dotnet/cs/GFramework.Godot.SourceGenerators.dll"/>
        <Analyzer Include="$(MSBuildThisFileDirectory)../analyzers/dotnet/cs/GFramework.Godot.SourceGenerators.Abstractions.dll"/>
+        <Analyzer Include="$(MSBuildThisFileDirectory)../analyzers/dotnet/cs/GFramework.SourceGenerators.Common.dll"/>
    </ItemGroup>

    <!-- Ensure the analyzers are loaded -->
--- a/GFramework.Godot.SourceGenerators/constants/PathContests.cs
+++ b/GFramework.Godot.SourceGenerators/constants/PathContests.cs
@ -0,0 +1,6 @@
+namespace GFramework.Godot.SourceGenerators.constants;
+
+public static class PathContests
+{
+    public const string RootAbstractionsPath = "GFramework.Godot.SourceGenerators.Abstractions";
+}
--- a/GFramework.Godot.SourceGenerators/logging/GodotLoggerGenerator.cs
+++ b/GFramework.Godot.SourceGenerators/logging/GodotLoggerGenerator.cs
@ -1,7 +1,8 @@
 using System;
 using System.Linq;
 using System.Text;
-using GFramework.Godot.SourceGenerators.diagnostics;
+using GFramework.Godot.SourceGenerators.constants;
+using GFramework.SourceGenerators.Common.diagnostics;
 using Microsoft.CodeAnalysis;
 using Microsoft.CodeAnalysis.CSharp;
 using Microsoft.CodeAnalysis.CSharp.Syntax;
@ -16,7 +17,7 @@ namespace GFramework.Godot.SourceGenerators.logging;
 public sealed class GodotLoggerGenerator : IIncrementalGenerator
 {
    private const string AttributeMetadataName =
-        "GFramework.Godot.SourceGenerators.Abstractions.logging.GodotLogAttribute";
+        $"{PathContests.RootAbstractionsPath}.logging.GodotLogAttribute";

    private const string AttributeShortName = "GodotLogAttribute";
    private const string AttributeShortNameWithoutSuffix = "GodotLog";
--- a/GFramework.SourceGenerators.Common/AnalyzerReleases.Shipped.md
+++ b/GFramework.SourceGenerators.Common/AnalyzerReleases.Shipped.md
@ -0,0 +1,3 @@
+; Shipped analyzer releases
+; https://github.com/dotnet/roslyn-analyzers/blob/main/src/Microsoft.CodeAnalysis.Analyzers/ReleaseTrackingAnalyzers.Help.md
+
--- a/GFramework.SourceGenerators.Common/AnalyzerReleases.Unshipped.md
+++ b/GFramework.SourceGenerators.Common/AnalyzerReleases.Unshipped.md
@ -0,0 +1,8 @@
+; Unshipped analyzer release
+; https://github.com/dotnet/roslyn-analyzers/blob/main/src/Microsoft.CodeAnalysis.Analyzers/ReleaseTrackingAnalyzers.Help.md
+
+### New Rules
+
+ Rule ID             | Category          | Severity | Notes             
+---------------------|-------------------|----------|-------------------
+ GF_Common_Class_001 | GFramework.Common | Error    | CommonDiagnostics 
--- a/GFramework.SourceGenerators.Common/Directory.Build.props
+++ b/GFramework.SourceGenerators.Common/Directory.Build.props
@ -0,0 +1,24 @@
+<Project>
+    <!-- import parent: https://docs.microsoft.com/en-us/visualstudio/msbuild/customize-your-build -->
+    <PropertyGroup>
+        <TargetFramework>netstandard2.0</TargetFramework>
+        <ContinuousIntegrationBuild>true</ContinuousIntegrationBuild>
+        <EmbedUntrackedSources>true</EmbedUntrackedSources>
+        <!--
+        we use a higher version than supported by the target framework to have nullable types and other nice features
+        (a lot of features get polyfilled by Meziantou.Polyfill)
+        however we need to be careful with the available features!
+        -->
+        <LangVersion>preview</LangVersion>
+    </PropertyGroup>
+    <ItemGroup>
+        <PackageReference Include="Meziantou.Analyzer" Version="2.0.264">
+            <PrivateAssets>all</PrivateAssets>
+            <IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
+        </PackageReference>
+        <PackageReference Include="Meziantou.Polyfill" Version="1.0.71">
+            <PrivateAssets>all</PrivateAssets>
+            <IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
+        </PackageReference>
+    </ItemGroup>
+</Project>
--- a/GFramework.SourceGenerators.Common/GFramework.SourceGenerators.Common.csproj
+++ b/GFramework.SourceGenerators.Common/GFramework.SourceGenerators.Common.csproj
@ -0,0 +1,24 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+    <!-- 
+    配置项目构建属性
+    设置项目不可打包、生成文档文件，并包含特定的Polyfill
+    -->
+    <PropertyGroup>
+        <IsPackable>false</IsPackable>
+        <GenerateDocumentationFile>true</GenerateDocumentationFile>
+        <MeziantouPolyfill_IncludedPolyfills>T:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute</MeziantouPolyfill_IncludedPolyfills>
+    </PropertyGroup>
+
+    <!-- 引入必要的命名空间 -->
+    <ItemGroup>
+        <Using Include="GFramework.SourceGenerators.Common"/>
+    </ItemGroup>
+    <ItemGroup>
+        <PackageReference Include="Microsoft.CodeAnalysis.Common" Version="4.14.0" PrivateAssets="all"/>
+    </ItemGroup>
+    <ItemGroup>
+        <AdditionalFiles Include="AnalyzerReleases.Shipped.md"/>
+        <AdditionalFiles Include="AnalyzerReleases.Unshipped.md"/>
+    </ItemGroup>
+</Project>
--- a/GFramework.SourceGenerators.Common/diagnostics/CommonDiagnostics.cs
+++ b/GFramework.SourceGenerators.Common/diagnostics/CommonDiagnostics.cs
@ -1,6 +1,6 @@
 using Microsoft.CodeAnalysis;

-namespace GFramework.Godot.SourceGenerators.diagnostics;
+namespace GFramework.SourceGenerators.Common.diagnostics;

 /// <summary>
 /// 提供通用诊断描述符的静态类
--- a/GFramework.SourceGenerators/AnalyzerReleases.Unshipped.md
+++ b/GFramework.SourceGenerators/AnalyzerReleases.Unshipped.md
@ -5,6 +5,5 @@

 Rule ID             | Category                         | Severity | Notes                  
 ---------------------|----------------------------------|----------|------------------------
- GF_Common_Class_001 | GFramework.Common                | Error    | CommonDiagnostics      
 GF_Logging_001      | GFramework.Godot.Logging         | Warning  | LoggerDiagnostics      
 GF_Rule_001         | GFramework.SourceGenerators.rule | Error    | ContextAwareDiagnostic 
--- a/GFramework.SourceGenerators/GFramework.SourceGenerators.csproj
+++ b/GFramework.SourceGenerators/GFramework.SourceGenerators.csproj
@ -29,6 +29,7 @@
    <!-- Generator 编译期引用 Attributes / Common，但不打包 -->
    <ItemGroup>
        <ProjectReference Include="..\GFramework.SourceGenerators.Abstractions\GFramework.SourceGenerators.Abstractions.csproj" PrivateAssets="all"/>
+        <ProjectReference Include="..\GFramework.SourceGenerators.Common\GFramework.SourceGenerators.Common.csproj" PrivateAssets="all"/>
    </ItemGroup>

    <!-- ★关键：只把 Generator DLL 放进 analyzers -->
@ -44,12 +45,18 @@
              Pack="true"
              PackagePath="analyzers/dotnet/cs"
              Visible="false"/>
+        <!-- ★ Generator 运行期依赖 -->
+        <None Include="$(OutputPath)\GFramework.SourceGenerators.Common.dll"
+              Pack="true"
+              PackagePath="analyzers/dotnet/cs"
+              Visible="false"/>

    </ItemGroup>
    <ItemGroup>
        <None Include="$(OutputPath)\$(AssemblyName).Abstractions.dll" Pack="true" PackagePath="lib\netstandard2.0" Visible="true"/>
        <None Include="$(OutputPath)\$(AssemblyName).Abstractions.xml" Pack="true" PackagePath="lib\netstandard2.0" Visible="true"/>
-        <!-- 包含targets文件 -->
+        <None Include="$(OutputPath)\$(AssemblyName).Common.dll" Pack="true" PackagePath="lib\netstandard2.0" Visible="true"/>
+        <None Include="$(OutputPath)\$(AssemblyName).Common.xml" Pack="true" PackagePath="lib\netstandard2.0" Visible="true"/>
        <None Include="GeWuYou.GFramework.SourceGenerators.targets" Pack="true" PackagePath="build" Visible="false"/>
    </ItemGroup>
 </Project>
--- a/GFramework.SourceGenerators/GeWuYou.GFramework.SourceGenerators.targets
+++ b/GFramework.SourceGenerators/GeWuYou.GFramework.SourceGenerators.targets
@ -6,6 +6,7 @@
    <ItemGroup>
        <Analyzer Include="$(MSBuildThisFileDirectory)../analyzers/dotnet/cs/GFramework.SourceGenerators.dll"/>
        <Analyzer Include="$(MSBuildThisFileDirectory)../analyzers/dotnet/cs/GFramework.SourceGenerators.Abstractions.dll"/>
+        <Analyzer Include="$(MSBuildThisFileDirectory)../analyzers/dotnet/cs/GFramework.SourceGenerators.Common.dll"/>
    </ItemGroup>

    <!-- Ensure the analyzers are loaded -->
--- a/GFramework.SourceGenerators/constants/PathContests.cs
+++ b/GFramework.SourceGenerators/constants/PathContests.cs
@ -0,0 +1,6 @@
+namespace GFramework.SourceGenerators.constants;
+
+public static class PathContests
+{
+    public const string RootAbstractionsPath = "GFramework.SourceGenerators.Abstractions";
+}
--- a/GFramework.SourceGenerators/diagnostics/CommonDiagnostics.cs
+++ b/GFramework.SourceGenerators/diagnostics/CommonDiagnostics.cs
@ -1,29 +0,0 @@
-using Microsoft.CodeAnalysis;
-
-namespace GFramework.SourceGenerators.diagnostics;
-
-/// <summary>
-/// 提供通用诊断描述符的静态类
-/// </summary>
-public static class CommonDiagnostics
-{
-    /// <summary>
-    /// 定义类必须为partial的诊断描述符
-    /// </summary>
-    /// <remarks>
-    /// 诊断ID: GF001
-    /// 诊断消息: "Class '{0}' must be declared partial for code generation"
-    /// 分类: GFramework.Common
-    /// 严重性: Error
-    /// 是否启用: true
-    /// </remarks>
-    public static readonly DiagnosticDescriptor ClassMustBePartial =
-        new(
-            "GF_Common_Class_001",
-            "Class must be partial",
-            "Class '{0}' must be declared partial for code generation",
-            "GFramework.Common",
-            DiagnosticSeverity.Error,
-            true
-        );
-}
--- a/GFramework.SourceGenerators/enums/EnumExtensionsGenerator.cs
+++ b/GFramework.SourceGenerators/enums/EnumExtensionsGenerator.cs
@ -1,6 +1,7 @@
 using System;
 using System.Linq;
 using System.Text;
+using GFramework.SourceGenerators.constants;
 using Microsoft.CodeAnalysis;
 using Microsoft.CodeAnalysis.CSharp.Syntax;
 using Microsoft.CodeAnalysis.Text;
@ -11,7 +12,7 @@ namespace GFramework.SourceGenerators.enums;
 public class EnumExtensionsGenerator : IIncrementalGenerator
 {
    private const string AttributeFullName =
-        "GFramework.SourceGenerators.Abstractions.generator.enums.GenerateEnumExtensionsAttribute";
+        $"{PathContests.RootAbstractionsPath}.enums.GenerateEnumExtensionsAttribute";

    public void Initialize(IncrementalGeneratorInitializationContext context)
    {
@ -35,9 +36,8 @@ public class EnumExtensionsGenerator : IIncrementalGenerator
            .Where(symbol => symbol != null)
            .Select((symbol, _) =>
            {
-                var hasAttr = symbol.GetAttributes().Any(ad =>
-                    ad.AttributeClass?.ToDisplayString() == AttributeFullName ||
-                    ad.AttributeClass?.ToDisplayString().EndsWith(".GenerateEnumExtensionsAttribute") == true);
+                var hasAttr = symbol!.GetAttributes().Any(ad =>
+                    ad.AttributeClass?.ToDisplayString() == AttributeFullName);
                return (Symbol: symbol, HasAttr: hasAttr);
            })
            .Where(x => x.HasAttr)
--- a/GFramework.SourceGenerators/logging/LoggerGenerator.cs
+++ b/GFramework.SourceGenerators/logging/LoggerGenerator.cs
@ -1,7 +1,8 @@
 using System;
 using System.Linq;
 using System.Text;
-using GFramework.SourceGenerators.diagnostics;
+using GFramework.SourceGenerators.Common.diagnostics;
+using GFramework.SourceGenerators.constants;
 using Microsoft.CodeAnalysis;
 using Microsoft.CodeAnalysis.CSharp;
 using Microsoft.CodeAnalysis.CSharp.Syntax;
@ -15,7 +16,7 @@ namespace GFramework.SourceGenerators.logging;
 [Generator]
 public sealed class LoggerGenerator : IIncrementalGenerator
 {
-    private const string AttributeMetadataName = "GFramework.SourceGenerators.Abstractions.logging.LogAttribute";
+    private const string AttributeMetadataName = $"{PathContests.RootAbstractionsPath}.logging.LogAttribute";
    private const string AttributeShortName = "LogAttribute";
    private const string AttributeShortNameWithoutSuffix = "Log";

--- a/GFramework.SourceGenerators/rule/ContextAwareGenerator.cs
+++ b/GFramework.SourceGenerators/rule/ContextAwareGenerator.cs
@ -1,5 +1,7 @@
 using System.Linq;
 using System.Text;
+using GFramework.SourceGenerators.Common.diagnostics;
+using GFramework.SourceGenerators.constants;
 using GFramework.SourceGenerators.diagnostics;
 using Microsoft.CodeAnalysis;
 using Microsoft.CodeAnalysis.CSharp;
@ -11,7 +13,7 @@ namespace GFramework.SourceGenerators.rule;
 public sealed class ContextAwareGenerator : IIncrementalGenerator
 {
    private const string AttributeMetadataName =
-        "GFramework.SourceGenerators.Abstractions.rule.ContextAwareAttribute";
+        $"{PathContests.RootAbstractionsPath}.rule.ContextAwareAttribute";

    public void Initialize(IncrementalGeneratorInitializationContext context)
    {
--- a/GFramework.sln
+++ b/GFramework.sln
@ -18,6 +18,8 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "GFramework.Godot.SourceGene
 EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "GFramework.SourceGenerators.Tests", "GFramework.SourceGenerators.Tests\GFramework.SourceGenerators.Tests.csproj", "{BB047F43-6AA0-4EA0-8AE9-E6B9784D9E8E}"
 EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "GFramework.SourceGenerators.Common", "GFramework.SourceGenerators.Common\GFramework.SourceGenerators.Common.csproj", "{B6511C9A-40E1-4E51-8D1F-18EAFB3C5BFC}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@ -60,5 +62,9 @@ Global
 		{BB047F43-6AA0-4EA0-8AE9-E6B9784D9E8E}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{BB047F43-6AA0-4EA0-8AE9-E6B9784D9E8E}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{BB047F43-6AA0-4EA0-8AE9-E6B9784D9E8E}.Release|Any CPU.Build.0 = Release|Any CPU
+		{B6511C9A-40E1-4E51-8D1F-18EAFB3C5BFC}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{B6511C9A-40E1-4E51-8D1F-18EAFB3C5BFC}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{B6511C9A-40E1-4E51-8D1F-18EAFB3C5BFC}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{B6511C9A-40E1-4E51-8D1F-18EAFB3C5BFC}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 EndGlobal