🩹 [Patch]: Add comment for faster testing and ensure linter environment variables are defined (#10)

## Description

This pull request updates the `.github/PSModule.yml` configuration to
allow for more flexible and faster testing and linting workflows. The
main changes introduce new environment variables to selectively disable
specific linter validations and provide a commented-out option to skip
some test steps.

Workflow configuration improvements:

* Added environment variables under the new `Linter` section to allow
disabling of various linter validations, including Biome format/lint,
GitHub Actions Zizmor, JSCPD, and Prettier checks for JSON, Markdown,
and YAML.

Test workflow flexibility:

* Added a commented-out configuration option to skip some test steps for
faster testing during development.

Author: MariusStorhaug

.github/PSModule.yml

@@ -5,6 +5,7 @@
 Test:
   CodeCoverage:
     PercentTarget: 0
+# Uncomment this to test faster by skipping some steps
 #   TestResults:
 #     Skip: true
 #   SourceCode:
@@ -19,3 +20,12 @@ Test:
 # Build:
 #   Docs:
 #     Skip: true
+Linter:
+  env:
+    VALIDATE_BIOME_FORMAT: false
+    VALIDATE_BIOME_LINT: false
+    VALIDATE_GITHUB_ACTIONS_ZIZMOR: false
+    VALIDATE_JSCPD: false
+    VALIDATE_JSON_PRETTIER: false
+    VALIDATE_MARKDOWN_PRETTIER: false
+    VALIDATE_YAML_PRETTIER: false

src/functions/public/Get-PSModuleTest.ps1

@@ -5,6 +5,9 @@ function Get-PSModuleTest {
         .SYNOPSIS
         Performs tests on a module.
 
+        .DESCRIPTION
+        Performs tests on a module.
+
         .EXAMPLE
         Test-PSModule -Name 'World'
 

src/functions/public/New-PSModuleTest.ps1

@@ -5,6 +5,9 @@ function New-PSModuleTest {
         .SYNOPSIS
         Performs tests on a module.
 
+        .DESCRIPTION
+        Performs tests on a module.
+
         .EXAMPLE
         Test-PSModule -Name 'World'
 

src/functions/public/Set-PSModuleTest.ps1

@@ -3,6 +3,9 @@
         .SYNOPSIS
         Performs tests on a module.
 
+        .DESCRIPTION
+        Performs tests on a module.
+
         .EXAMPLE
         Test-PSModule -Name 'World'
 

src/functions/public/Test-PSModuleTest.ps1

@@ -3,6 +3,9 @@
         .SYNOPSIS
         Performs tests on a module.
 
+        .DESCRIPTION
+        Performs tests on a module.
+
         .EXAMPLE
         Test-PSModule -Name 'World'