Add v6 preview docs

.devcontainer/devcontainer.json

@@ -22,7 +22,7 @@
 
   // Use 'postCreateCommand' to run commands after the container is created.
   "postCreateCommand": "yarn install",
-  
+
   // Configure tool-specific properties.
   "customizations": {
     "vscode": {
@@ -33,7 +33,8 @@
         "dbaeumer.vscode-eslint",
         "unifiedjs.vscode-mdx",
         "ms-vscode.powershell",
-        "EditorConfig.EditorConfig"
+        "EditorConfig.EditorConfig",
+        "github.vscode-github-actions"
       ]
     }
   }

.editorconfig

@@ -9,5 +9,5 @@ trim_trailing_whitespace = true
 indent_size = 4
 max_line_length = 80
 
-[*.{json,ps1xml,props,xml,yaml,css}]
+[*.{js,jsx,ts,tsx,json,ps1xml,props,xml,yml,yaml,css}]
 indent_size = 2

.github/workflows/generate-pester-docs.yml

@@ -0,0 +1,98 @@
+name: Update Pester Docs
+run-name: Update Pester ${{ github.event.inputs.docs_version }} docs to v${{ github.event.inputs.pester_version }}
+
+on:
+  workflow_dispatch:
+    inputs:
+      docs_version:
+        description: 'Docs version to update'
+        required: true
+        default: 'v5'
+        type: choice
+        options:
+          - Current
+          - v5
+          - v4
+      pester_version:
+        description: 'Pester version to use for docs generation. Format: 5.6.0 or 6.0.0-alpha1'
+        required: true
+        type: string
+
+jobs:
+  generate_docs:
+    name: Docs PR
+    runs-on: ubuntu-latest
+    env:
+      PESTER: ${{ github.event.inputs.pester_version }}
+      DOCS: ${{ github.event.inputs.docs_version }}
+    permissions:
+      contents: write
+      pull-requests: write
+    steps:
+      - name: Validate Pester version input
+        run: |
+          echo "Validating that the provided pester_version input is a valid version-format (x.y.z or x.y.z-suffix)"
+          echo "${{ env.PESTER }}" | grep -P '^\d+.\d+.\d+(?:-\w+)?$'
+
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      # This step will also install and import modules incl. selected Pester-version
+      - name: Update Command Reference
+        id: commands
+        shell: pwsh
+        run: |
+          ./generate-command-reference.ps1 -PesterVersion '${{ env.PESTER }}' -DocsVersion '${{ env.DOCS }}'
+
+          # Output if any files were modified
+          $updated = $null -ne (git status -s | Select-String '/commands/')
+          "updated=$updated" >> $env:GITHUB_OUTPUT
+      - name: Update PesterConfiguration docs
+        if: ${{ env.DOCS != 'v4' }}
+        id: config
+        shell: pwsh
+        run: |
+          ./generate-pesterconfiguration-docs.ps1 -PesterVersion '${{ env.PESTER }}' -Style Table -DocsVersion '${{ env.DOCS }}'
+
+          # Output if any files were modified
+          $updated = $null -ne (git status -s | Select-String '/usage/Configuration.mdx')
+          "updated=$updated" >> $env:GITHUB_OUTPUT
+      - name: Create Pull Request
+        uses: peter-evans/create-pull-request@6d6857d36972b65feb161a90e484f2984215f83e # v6.0.5
+        id: create-pr
+        env:
+          PR_BRANCH: "docs-update/${{ env.DOCS }}-v${{ env.PESTER }}"
+          TITLE_DOCS_VERSION: "${{ env.DOCS != 'Current' && format('{0} ', env.DOCS) || '' }}"
+        with:
+          branch: ${{ env.PR_BRANCH }}
+          branch-suffix: short-commit-hash
+          draft: false
+          # Should always be reviewed by author to fix typos or other errors
+          reviewers: ${{ github.actor }}
+          # Set user triggering the workflow as author (default in action)
+          author: ${{ github.actor }} <${{ github.actor_id }}+${{ github.actor }}@users.noreply.github.com>
+          # Github Action as commit (explicit default)
+          committer: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
+          commit-message: "Update generated docs to ${{ env.PESTER }}"
+          add-paths: |
+            docs
+            versioned_docs
+          title: Update ${{ env.TITLE_DOCS_VERSION }}docs to Pester v${{ env.PESTER }}
+          body: |
+            Updates generated documentation using the specified Pester-version.
+
+            **Docs version:** ${{ env.DOCS }}
+            **Pester version:** ${{ env.PESTER }}
+
+            | Documentation updated | Result |
+            |-----------------------|--------|
+            | Command Reference | ${{ steps.commands.outputs.updated }} |
+            | PesterConfiguration section | ${{ steps.config.outputs.updated }} |
+
+            *PR created using 'Update Pester Docs' workflow*
+
+      - name: Output PR details
+        if: ${{ steps.create-pr.outputs.pull-request-number }}
+        run: |
+          echo "### Update Pester Docs successfully completed! :rocket:" >> $GITHUB_STEP_SUMMARY
+          echo "See [pull request #${{ steps.create-pr.outputs.pull-request-number }}](${{ steps.create-pr.outputs.pull-request-url }})" >> $GITHUB_STEP_SUMMARY

.vscode/launch.json

@@ -5,10 +5,10 @@
     "version": "0.2.0",
     "configurations": [
         {
-            "command": "yarn start --poll",
+            "command": "yarn start --host 0.0.0.0 --poll 1000",
             "name": "Start Docusaurus (with polling)",
             "request": "launch",
             "type": "node-terminal"
         }
     ]
-}
+}

docs/commands/Add-ShouldOperator.mdx

@@ -49,7 +49,7 @@ function BeAwesome($ActualValue, [switch] $Negate) {
         }
     }
 
-    return New-Object psobject -Property @{
+    return [PSCustomObject]@{
         Succeeded      = $succeeded
         FailureMessage = $failureMessage
     }
@@ -166,4 +166,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
 
 ## VERSION
 
-*This page was generated using comment-based help in [Pester 5.6.0](https://github.com/pester/pester).*
+*This page was generated using comment-based help in [Pester 6.0.0-alpha1](https://github.com/pester/pester).*

docs/commands/AfterAll.mdx

@@ -107,4 +107,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
 
 ## VERSION
 
-*This page was generated using comment-based help in [Pester 5.6.0](https://github.com/pester/pester).*
+*This page was generated using comment-based help in [Pester 6.0.0-alpha1](https://github.com/pester/pester).*

docs/commands/AfterEach.mdx

@@ -104,4 +104,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
 
 ## VERSION
 
-*This page was generated using comment-based help in [Pester 5.6.0](https://github.com/pester/pester).*
+*This page was generated using comment-based help in [Pester 6.0.0-alpha1](https://github.com/pester/pester).*

docs/commands/BeforeAll.mdx

@@ -116,4 +116,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
 
 ## VERSION
 
-*This page was generated using comment-based help in [Pester 5.6.0](https://github.com/pester/pester).*
+*This page was generated using comment-based help in [Pester 6.0.0-alpha1](https://github.com/pester/pester).*

docs/commands/BeforeDiscovery.mdx

@@ -94,4 +94,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
 
 ## VERSION
 
-*This page was generated using comment-based help in [Pester 5.6.0](https://github.com/pester/pester).*
+*This page was generated using comment-based help in [Pester 6.0.0-alpha1](https://github.com/pester/pester).*

docs/commands/BeforeEach.mdx

@@ -101,4 +101,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
 
 ## VERSION
 
-*This page was generated using comment-based help in [Pester 5.6.0](https://github.com/pester/pester).*
+*This page was generated using comment-based help in [Pester 6.0.0-alpha1](https://github.com/pester/pester).*

docs/commands/Context.mdx

@@ -183,4 +183,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
 
 ## VERSION
 
-*This page was generated using comment-based help in [Pester 5.6.0](https://github.com/pester/pester).*
+*This page was generated using comment-based help in [Pester 6.0.0-alpha1](https://github.com/pester/pester).*

docs/commands/ConvertTo-JUnitReport.mdx

@@ -118,4 +118,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
 
 ## VERSION
 
-*This page was generated using comment-based help in [Pester 5.6.0](https://github.com/pester/pester).*
+*This page was generated using comment-based help in [Pester 6.0.0-alpha1](https://github.com/pester/pester).*

docs/commands/ConvertTo-NUnitReport.mdx

@@ -145,4 +145,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
 
 ## VERSION
 
-*This page was generated using comment-based help in [Pester 5.6.0](https://github.com/pester/pester).*
+*This page was generated using comment-based help in [Pester 6.0.0-alpha1](https://github.com/pester/pester).*

docs/commands/ConvertTo-Pester4Result.mdx

@@ -86,4 +86,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
 
 ## VERSION
 
-*This page was generated using comment-based help in [Pester 5.6.0](https://github.com/pester/pester).*
+*This page was generated using comment-based help in [Pester 6.0.0-alpha1](https://github.com/pester/pester).*

docs/commands/Describe.mdx

@@ -193,4 +193,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
 
 ## VERSION
 
-*This page was generated using comment-based help in [Pester 5.6.0](https://github.com/pester/pester).*
+*This page was generated using comment-based help in [Pester 6.0.0-alpha1](https://github.com/pester/pester).*

docs/commands/Export-JUnitReport.mdx

@@ -105,4 +105,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
 
 ## VERSION
 
-*This page was generated using comment-based help in [Pester 5.6.0](https://github.com/pester/pester).*
+*This page was generated using comment-based help in [Pester 6.0.0-alpha1](https://github.com/pester/pester).*

docs/commands/Export-NUnitReport.mdx

@@ -121,4 +121,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
 
 ## VERSION
 
-*This page was generated using comment-based help in [Pester 5.6.0](https://github.com/pester/pester).*
+*This page was generated using comment-based help in [Pester 6.0.0-alpha1](https://github.com/pester/pester).*

docs/commands/Get-EquivalencyOption.mdx

@@ -0,0 +1,123 @@
+---
+id: Get-EquivalencyOption
+title: Get-EquivalencyOption
+description: Help page for the PowerShell Pester "Get-EquivalencyOption" command
+keywords:
+  - PowerShell
+  - Pester
+  - Help
+  - Documentation
+hide_title: false
+hide_table_of_contents: false
+custom_edit_url: null
+---
+
+:::info This page was generated
+Contributions are welcome in [Pester-repo](https://github.com/pester/pester).
+:::
+
+## SYNOPSIS
+
+Generates an object containing options for checking equivalency.
+
+## SYNTAX
+
+```powershell
+Get-EquivalencyOption [[-ExcludePath] <String[]>] [-ExcludePathsNotOnExpected] [[-Comparator] <String>]
+ [<CommonParameters>]
+```
+
+## DESCRIPTION
+
+The `Get-EquivalencyOption` function creates a custom object with options that determine how equivalency between two objects is assessed.
+This can be used in scenarios where a deep comparison of objects is required, with the ability to exclude specific paths from the comparison and to choose between different comparison strategies.
+
+## EXAMPLES
+
+### EXAMPLE 1
+
+```powershell
+$option = Get-EquivalencyOption -ExcludePath 'Id', 'Timestamp' -Comparator 'Equality'
+This example generates an equivalency option object that excludes the 'Id' and 'Timestamp' properties from the comparison and uses a simple equality comparison strategy.
+```
+
+### EXAMPLE 2
+
+```powershell
+$option = Get-EquivalencyOption -ExcludePathsNotOnExpected
+This example generates an equivalency option object that excludes any paths not present on the expected object from the comparison, using the default deep comparison strategy.
+```
+
+## PARAMETERS
+
+### -ExcludePath
+
+An array of strings specifying the paths to exclude from the comparison.
+Each path should correspond to a property name or a chain of property names separated by dots for nested properties.
+
+```yaml
+Type: String[]
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: 1
+Default value: @()
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -ExcludePathsNotOnExpected
+
+A switch parameter that, when set, excludes any paths from the comparison that are not present on the expected object.
+This is useful for ignoring extra properties on the actual object that are not relevant to the comparison.
+
+```yaml
+Type: SwitchParameter
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: False
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -Comparator
+
+Specifies the comparison strategy to use.
+The options are 'Equivalency' for a deep comparison that considers the structure and values of objects, and 'Equality' for a simple equality comparison.
+The default is 'Equivalency'.
+
+```yaml
+Type: String
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: 2
+Default value: Equivalency
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### CommonParameters
+
+This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
+
+## INPUTS
+
+## OUTPUTS
+
+## NOTES
+
+## RELATED LINKS
+
+[https://pester.dev/docs/commands/Get-EquivalencyOption](https://pester.dev/docs/commands/Get-EquivalencyOption)
+
+[https://pester.dev/docs/assertions](https://pester.dev/docs/assertions)
+
+## VERSION
+
+*This page was generated using comment-based help in [Pester 6.0.0-alpha1](https://github.com/pester/pester).*

docs/commands/Get-ShouldOperator.mdx

@@ -94,4 +94,4 @@ standard PowerShell discovery patterns (like `Get-Help Should -Parameter *`).
 
 ## VERSION
 
-*This page was generated using comment-based help in [Pester 5.6.0](https://github.com/pester/pester).*
+*This page was generated using comment-based help in [Pester 6.0.0-alpha1](https://github.com/pester/pester).*

docs/commands/InModuleScope.mdx

@@ -204,4 +204,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
 
 ## VERSION
 
-*This page was generated using comment-based help in [Pester 5.6.0](https://github.com/pester/pester).*
+*This page was generated using comment-based help in [Pester 6.0.0-alpha1](https://github.com/pester/pester).*