Merge branch 'stable'

Author: bUnitBot

.config/dotnet-tools.json

@@ -7,6 +7,12 @@
       "commands": [
         "dotnet-serve"
       ]
+    },
+    "docfx": {
+      "version": "2.67.0",
+      "commands": [
+        "docfx"
+      ]
     }
   }
 }

.github/workflows/docs-deploy.yml

@@ -81,9 +81,9 @@ jobs:
         run: dotnet test docs/samples/samples.sln
 
       - name: 🛠️ Building docs
-        uses: nikeee/docfx-action@v1.0.0
-        with:
-          args: docs/site/docfx.json
+        run: |
+          dotnet tool update -g docfx --version 2.67.0
+          docfx docs/site/docfx.json
 
       - name: 🛠️ Deploy to GitHub Pages
         if: success()

.github/workflows/verification.yml

@@ -67,6 +67,7 @@ jobs:
       - name: 🧪 Run unit tests (sync)
         run: |
           dotnet test --filter Category!=async -c release
+
       - name: 📛 Upload hang- and crash-dumps on test failure
         if: failure()
         uses: actions/upload-artifact@v3
@@ -108,7 +109,7 @@ jobs:
           dotnet restore ${{ github.workspace }}/TemplateTestMstest --source https://api.nuget.org/v3/index.json --source ${{ github.workspace }}/packages
           dotnet test ${{ github.workspace }}/TemplateTestMstest
 
-      # DocFx only works well on Windows currently
-      - name: 📄 Build documentation
-        if: matrix.os == 'windows-latest'
-        run: dotnet build docs/site/
+      - name: 📄 Building docs
+        run: |
+          dotnet tool update -g docfx --version 2.67.0
+          docfx docs/site/docfx.json

README.md

@@ -20,7 +20,7 @@
 - Pass parameters, cascading values and inject services into components under test
 - Mock `IJSRuntime`, Blazor authentication and authorization, and others
 
-bUnit builds on top of existing unit testing frameworks such as xUnit, NUnit, and MSTest, which run the Blazor component tests in just the same way as any normal unit test. bUnit runs a test in milliseconds, compared to browser-based UI tests which usually take seconds to run. 
+bUnit builds on top of existing unit testing frameworks such as xUnit, NUnit, and MSTest, which run the Blazor component tests in just the same way as any normal unit test. bUnit runs a test in milliseconds, compared to browser-based UI tests which usually take seconds to run.
 
 **Go to [bUnit.dev](https://bunit.dev) to learn more.**
 
@@ -31,9 +31,9 @@ bUnit is available on NuGet in various incarnations. Most should just pick the [
 | Name | Description | NuGet Download Link |
 | ----- | ----- | ---- |
 | [bUnit](https://www.nuget.org/packages/bunit/) | Includes the bUnit.core and bUnit.web packages. | [![Nuget](https://img.shields.io/nuget/dt/bunit?logo=nuget&style=flat-square)](https://www.nuget.org/packages/bunit/) |
-| [bUnit.core](https://www.nuget.org/packages/bunit.core/) | Core library that enables rendering a Blazor component in a test context. | [![Nuget](https://img.shields.io/nuget/dt/bunit.core?logo=nuget&style=flat-square)](https://www.nuget.org/packages/bunit.core/) | 
-| [bUnit.web](https://www.nuget.org/packages/bunit.web/) | Adds support for testing Blazor components for the web. This includes bUnit.core. | [![Nuget](https://img.shields.io/nuget/dt/bunit.web?logo=nuget&style=flat-square)](https://www.nuget.org/packages/bunit.web/) | 
-| [bUnit.template](https://www.nuget.org/packages/bunit.template/) | Template, which currently creates xUnit-based bUnit test projects only | [![Nuget](https://img.shields.io/nuget/dt/bunit.template?logo=nuget&style=flat-square)](https://www.nuget.org/packages/bunit.template/) | 
+| [bUnit.core](https://www.nuget.org/packages/bunit.core/) | Core library that enables rendering a Blazor component in a test context. | [![Nuget](https://img.shields.io/nuget/dt/bunit.core?logo=nuget&style=flat-square)](https://www.nuget.org/packages/bunit.core/) |
+| [bUnit.web](https://www.nuget.org/packages/bunit.web/) | Adds support for testing Blazor components for the web. This includes bUnit.core. | [![Nuget](https://img.shields.io/nuget/dt/bunit.web?logo=nuget&style=flat-square)](https://www.nuget.org/packages/bunit.web/) |
+| [bUnit.template](https://www.nuget.org/packages/bunit.template/) | Template, which currently creates xUnit-based bUnit test projects only | [![Nuget](https://img.shields.io/nuget/dt/bunit.template?logo=nuget&style=flat-square)](https://www.nuget.org/packages/bunit.template/) |
 
 To get started, head to the [getting started documentation](https://bunit.dev/docs/getting-started) to learn more.
 
@@ -63,13 +63,6 @@ A huge thank you to the [sponsors of my work with bUnit](https://github.com/spon
 				<br />
 				Amazon Web Services
 			</a>
-		</td>			
-		<td align="center" width="120">
-			<a href="https://github.com/hassanhabib">
-				<img src="https://avatars.githubusercontent.com/u/1453985?s=460" alt="Hassan Rezk Habib (@hassanhabib)" width="72" height="72" class="avatar" />
-				<br />
-				Hassan Rezk Habib
-			</a>
 		</td>
 	</tr>
 </table>
@@ -87,7 +80,7 @@ These good people have contributed code or documentation to bUnit:
 ## Code of conduct
 
 This project has adopted the code of conduct defined by the Contributor Covenant to clarify expected behavior in our community.
-For more information see the [.NET Foundation Code of Conduct](https://dotnetfoundation.org/code-of-conduct). 
+For more information see the [.NET Foundation Code of Conduct](https://dotnetfoundation.org/code-of-conduct).
 
 ## .NET Foundation
 

docs/.editorconfig

@@ -1,8 +1,10 @@
 root = true
 
 [*]
+tab_size = 2
 indent_style = space
 indent_size = 2
+indent_width = 2
 charset = utf-8
 trim_trailing_whitespace = true
 insert_final_newline = false
@@ -11,6 +13,11 @@ insert_final_newline = false
 trim_trailing_whitespace = false
 
 [*.{cs,razor}]
+tab_size = 2
+indent_style = space
+indent_size = 2
+indent_width = 2
+
 dotnet_diagnostic.BL0001.severity = none
 dotnet_diagnostic.BL0002.severity = none
 dotnet_diagnostic.BL0003.severity = none

docs/site/docfx.json

@@ -7,18 +7,20 @@
             "bunit.core/bunit.core.csproj",
             "bunit.web/bunit.web.csproj"
           ],
-          "exclude": [ "**/bin/**", "**/obj/**", "../../src/AngleSharpWrappers", "../../src/bunit", "../../src/bunit.web.testcomponents", "../../src/bunit.template" ],
           "src": "../../src"
         }
       ],
       "dest": "api",
-      "properties": {
-        "TargetFramework": "net7.0"
-      },
+      "includePrivateMembers": false,
       "disableGitFeatures": false,
-      "disableDefaultFilter": false
+      "disableDefaultFilter": false,
+      "noRestore": true,
+      "namespaceLayout": "flattened",
+      "memberLayout": "samePage",
+      "allowCompilationErrors": false
     }
   ],
+
   "build": {
     "content": [
       {
@@ -44,19 +46,8 @@
           "site.webmanifest",
           "*.png",
           "CNAME",
-          "sponsors/**"
-        ]
-      }
-    ],
-    "overwrite": [
-      {
-        "files": [
-          "apidoc/**.md"
-        ],
-        "exclude": [
-          "obj/**",
-          "bin/**",
-          "_site/**"
+          "sponsors/**",
+          "favicon.ico"
         ]
       }
     ],
@@ -65,6 +56,7 @@
     "fileMetadataFiles": [],
     "template": [
       "default",
+      "modern",
       "templates/bunit"
     ],
     "globalMetadata": {
@@ -73,11 +65,11 @@
       "_description": "bUnit is a unit testing library for Blazor Components. You can easily define components under test in C# or Razor syntax and verify outcome using semantic HTML diffing/comparison logic. You can interact with and inspect components, trigger event handlers, provide cascading values, inject services, mock IJsRuntime, and perform snapshot testing.",
       "_enableSearch": true,
       "_appLogoPath": "/images/bunit-logo.png",
-      "_disableBreadcrumb": true,
-      "_disableFooter": false
+      "_disableBreadcrumb": false,
+      "_disableFooter": false,
+      "_appFooter": "<small>Documentation updated on #{NBGV_GitCommitDate}# in commit #{NBGV_GitCommitIdShort}#</small>"
     },
     "postProcessors": [],
-    "markdownEngineName": "markdig",
     "noLangKeyword": false,
     "keepFileLink": false,
     "cleanupCacheHistory": true,

docs/site/docs.csproj

@@ -7,7 +7,7 @@ title: Triggering a render life cycle on a component
 
 To trigger a re-render of a component under test, a reference to it through a <xref:Bunit.IRenderedComponent`1> type is needed. When using the <xref:Bunit.TestContext>'s `RenderComponent<TComponent>()` method, this is the type returned.
 
-In `.razor` based tests, using the <xref:Bunit.TestContext>'s <xref:Bunit.TestContext.Render``1(RenderFragment)> method also returns an <xref:Bunit.IRenderedComponent`1> (as opposed to the <xref:Bunit.TestContext.Render(Microsoft.AspNetCore.Components.RenderFragment)> method which returns the more simple <xref:Bunit.IRenderedFragment>).
+In `.razor` based tests, using the <xref:Bunit.TestContext>'s <xref:Bunit.TestContext.Render(Microsoft.AspNetCore.Components.RenderFragment)> method also returns an <xref:Bunit.IRenderedComponent`1> (as opposed to the <xref:Bunit.TestContext.Render(Microsoft.AspNetCore.Components.RenderFragment)> method which returns the more simple <xref:Bunit.IRenderedFragment>).
 
 If you have a <xref:Bunit.IRenderedFragment> or a <xref:Bunit.IRenderedComponent`1> in a test, but need a child component's <xref:Bunit.IRenderedComponent`1>, then use the `FindComponent<TComponent>()` or the `FindComponents<TComponent>()` methods, which traverse down the render tree and finds rendered components.
 

docs/site/docs.sln

@@ -9,7 +9,7 @@ Components are, by default in bUnit, instantiated in the exact same way the regu
 
 It is however possible to control how Blazor components build using .NET 5 or newer are instantiated by bUnit. This enables the possibility to replace one component during testing with another, e.g., to replace a 3rd party component during testing with a "[stub component](https://en.wikipedia.org/wiki/Test_stub)", to make the test easier to write and maintain.
 
-The following sections will describe how to use component factories to control instantiation of components during testing.
+The following sections will describe how to use component factories to control the instantiation of components during testing.
 
 ## Using component factories to control instantiation