feat: Create stub generator in public project

Author: linkdotnet

bunit.sln

@@ -72,6 +72,8 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "bunit.generators.internal",
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "bunit.generators.tests", "tests\bunit.generators.tests\bunit.generators.tests.csproj", "{09046981-D9EC-4295-8502-721AC54E1F12}"
 EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "bunit.generators", "src\bunit.generators\bunit.generators.csproj", "{A7C6A2AA-FF8F-4ED1-8590-5324FC566059}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -126,6 +128,10 @@ Global
 		{09046981-D9EC-4295-8502-721AC54E1F12}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{09046981-D9EC-4295-8502-721AC54E1F12}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{09046981-D9EC-4295-8502-721AC54E1F12}.Release|Any CPU.Build.0 = Release|Any CPU
+		{A7C6A2AA-FF8F-4ED1-8590-5324FC566059}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{A7C6A2AA-FF8F-4ED1-8590-5324FC566059}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{A7C6A2AA-FF8F-4ED1-8590-5324FC566059}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{A7C6A2AA-FF8F-4ED1-8590-5324FC566059}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
@@ -144,6 +150,7 @@ Global
 		{DE975A0C-0672-4248-913E-D267C1001801} = {6EA09ED4-B714-4E6F-B0E1-4D987F8AE520}
 		{AE3DFB52-2BF4-4806-AD82-7FB7B38AC17F} = {9A2B3B34-D41C-43E8-BC7D-246BEBE48D59}
 		{09046981-D9EC-4295-8502-721AC54E1F12} = {6EA09ED4-B714-4E6F-B0E1-4D987F8AE520}
+		{A7C6A2AA-FF8F-4ED1-8590-5324FC566059} = {9A2B3B34-D41C-43E8-BC7D-246BEBE48D59}
 	EndGlobalSection
 	GlobalSection(ExtensibilityGlobals) = postSolution
 		SolutionGuid = {24106918-1C86-4769-BDA6-9C80E64CD260}

src/bunit.generators.internal/Directory.Build.props

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="utf-8"?>
+<Project xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
+	<!-- here to stop props inheritance from folders above -->
+</Project>

src/bunit.generators.internal/README.md

@@ -0,0 +1,13 @@
+# Tips for developing with the generator
+
+When changing the source generator, to see the effect, clearing the build cache may be necessary:
+
+```
+dotnet build-server shutdown
+```
+
+A good way to quickly see if the generate is producing output:
+
+```
+dotnet build-server shutdown && dotnet clean && dotnet test -p:TargetFramework=net8.0
+```

src/bunit.generators.internal/Web.AngleSharp/GeneratorConfig.cs

@@ -0,0 +1,40 @@
+using Microsoft.CodeAnalysis;
+
+namespace Bunit.Web.AngleSharp;
+
+internal static class GeneratorConfig
+{
+	internal static readonly SymbolDisplayFormat SymbolFormat = new SymbolDisplayFormat(
+		globalNamespaceStyle: SymbolDisplayGlobalNamespaceStyle.Included,
+		typeQualificationStyle: SymbolDisplayTypeQualificationStyle.NameAndContainingTypesAndNamespaces,
+		genericsOptions:
+			SymbolDisplayGenericsOptions.IncludeTypeParameters |
+			SymbolDisplayGenericsOptions.IncludeTypeConstraints |
+			SymbolDisplayGenericsOptions.IncludeVariance,
+		memberOptions:
+			SymbolDisplayMemberOptions.IncludeType |
+			SymbolDisplayMemberOptions.IncludeModifiers |
+			SymbolDisplayMemberOptions.IncludeAccessibility |
+			SymbolDisplayMemberOptions.IncludeParameters |
+			SymbolDisplayMemberOptions.IncludeConstantValue |
+			SymbolDisplayMemberOptions.IncludeRef,
+		kindOptions: SymbolDisplayKindOptions.IncludeMemberKeyword,
+		parameterOptions:
+			SymbolDisplayParameterOptions.IncludeName |
+			SymbolDisplayParameterOptions.IncludeType |
+			SymbolDisplayParameterOptions.IncludeParamsRefOut |
+			SymbolDisplayParameterOptions.IncludeDefaultValue |
+			SymbolDisplayParameterOptions.IncludeModifiers,
+		localOptions: SymbolDisplayLocalOptions.IncludeType,
+		miscellaneousOptions:
+			SymbolDisplayMiscellaneousOptions.EscapeKeywordIdentifiers |
+			SymbolDisplayMiscellaneousOptions.UseSpecialTypes |
+			SymbolDisplayMiscellaneousOptions.IncludeNullableReferenceTypeModifier |
+			SymbolDisplayMiscellaneousOptions.AllowDefaultLiteral);
+
+	internal static readonly SymbolDisplayFormat SymbolFormatDefaultValue = new SymbolDisplayFormat(
+		globalNamespaceStyle: SymbolDisplayGlobalNamespaceStyle.Included,
+		typeQualificationStyle: SymbolDisplayTypeQualificationStyle.NameAndContainingTypesAndNamespaces,
+		memberOptions: SymbolDisplayMemberOptions.IncludeType,
+		parameterOptions: SymbolDisplayParameterOptions.IncludeType);
+}

src/bunit.generators.internal/Web.AngleSharp/IElementWrapper.cs

@@ -0,0 +1,18 @@
+#nullable enable
+using AngleSharp.Dom;
+using System.CodeDom.Compiler;
+
+namespace Bunit.Web.AngleSharp;
+
+/// <summary>
+/// Represents a wrapper around an <typeparamref name="TElement"/>.
+/// </summary>
+[GeneratedCodeAttribute("Bunit.Web.AngleSharp", "1.0.0.0")]
+internal interface IElementWrapper<out TElement> where TElement : class, IElement
+{
+	/// <summary>
+	/// Gets the wrapped element.
+	/// </summary>
+	TElement WrappedElement { get; }
+}
+#nullable restore

src/bunit.generators.internal/Web.AngleSharp/IElementWrapperFactory.cs

@@ -0,0 +1,27 @@
+#nullable enable
+using AngleSharp.Dom;
+using System;
+using System.CodeDom.Compiler;
+
+namespace Bunit.Web.AngleSharp;
+
+/// <summary>
+/// Represents an <see cref="IElement"/> factory, used by a <see cref="WrapperBase{TElement}"/>.
+/// </summary>
+[GeneratedCodeAttribute("Bunit.Web.AngleSharp", "1.0.0.0")]
+internal interface IElementWrapperFactory
+{
+	/// <summary>
+	/// A method that returns the latest version of the element to wrap.
+	/// </summary>
+	/// <remarks>
+	/// This method should throw if the element is not found or is not of the correct type (<typeparamref name="TElement"/>).
+	/// </remarks>
+	TElement GetElement<TElement>() where TElement : class, IElement;
+
+	/// <summary>
+	/// Subscribe to updates to the wrapped elements.
+	/// </summary>
+	Action? OnElementReplaced { get; set; }
+}
+#nullable restore

src/bunit.generators.internal/Web.AngleSharp/WrapperBase.cs

@@ -0,0 +1,83 @@
+#nullable enable
+using System.CodeDom.Compiler;
+using System.Diagnostics;
+using System.Runtime.CompilerServices;
+using AngleSharp.Dom;
+
+namespace Bunit.Web.AngleSharp;
+
+/// <summary>
+/// Represents a wrapper <see cref="IElement"/>.
+/// </summary>
+[DebuggerNonUserCode]
+[GeneratedCodeAttribute("Bunit.Web.AngleSharp", "1.0.0.0")]
+internal abstract class WrapperBase<TElement> : IElementWrapper<TElement>
+	where TElement : class, IElement
+{
+	private readonly IElementWrapperFactory elementFactory;
+	private TElement? element;
+
+	/// <summary>
+	/// Gets the wrapped element.
+	/// </summary>
+	[DebuggerNonUserCode]
+	public TElement WrappedElement
+	{
+		[MethodImpl(MethodImplOptions.AggressiveInlining)]
+		get
+		{
+			if (element is null)
+				element = elementFactory.GetElement<TElement>();
+
+			return element;
+		}
+	}
+
+	/// <summary>
+	/// Creates an instance of the <see cref="WrapperBase{T}"/> class.
+	/// </summary>
+	protected WrapperBase(
+		TElement element,
+		IElementWrapperFactory elementFactory)
+	{
+		this.element = element;
+		this.elementFactory = elementFactory;
+		elementFactory.OnElementReplaced = () => this.element = null;
+	}
+
+	/// <inheritdoc/>
+	public override bool Equals(object? obj)
+		=> WrappedElement.Equals(obj);
+
+	/// <inheritdoc/>
+	public override int GetHashCode() => WrappedElement.GetHashCode();
+
+	/// <inheritdoc/>
+	public static bool operator ==(WrapperBase<TElement> x, TElement y)
+	{
+		if (x is null)
+			return y is null;
+		return x.WrappedElement == y;
+	}
+
+	/// <inheritdoc/>
+	public static bool operator !=(WrapperBase<TElement> x, TElement y)
+	{
+		return !(x == y);
+	}
+
+	/// <inheritdoc/>
+	public static bool operator ==(TElement x, WrapperBase<TElement> y)
+	{
+		if (y is null)
+			return x is null;
+		return x == y.WrappedElement;
+	}
+
+	/// <inheritdoc/>
+	public static bool operator !=(TElement x, WrapperBase<TElement> y)
+	{
+		return !(x == y);
+	}
+}
+#nullable restore