🪲 [Fix]: Fix linter settings and docs (#3)

This pull request introduces several small configuration and
documentation improvements related to linting and PowerShell module
testing. The changes primarily focus on customizing linter behavior and
improving inline documentation.

Linter configuration updates:

* Disabled several linter validations in the `Linter` section of
`.github/PSModule.yml` by setting their environment variables to
`false`, reducing unnecessary checks during CI runs.
* Updated `.github/linters/.markdown-lint.yml` to disable the `MD024`
rule (allowing duplicate headings), and made a minor formatting fix to
the `MD026` punctuation list.

Documentation improvements:

* Added a `.DESCRIPTION` section to the `Get-PSModuleTest` function in
`src/functions/public/Get-PSModuleTest.ps1` to improve inline
documentation.

Author: MariusStorhaug

.github/PSModule.yml

@@ -19,3 +19,13 @@ 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

.github/linters/.markdown-lint.yml

@@ -8,18 +8,19 @@
 ###############
 # Rules by id #
 ###############
-MD004: false                  # Unordered list style
+MD004: false # Unordered list style
 MD007:
-  indent: 2                   # Unordered list indentation
+  indent: 2 # Unordered list indentation
 MD013:
-  line_length: 808            # Line length
+  line_length: 808 # Line length
+MD024: false # no-duplicate-heading, INPUTS and OUTPUTS _can_ be the same item
 MD026:
-  punctuation: ".,;:!。，；:"  # List of not allowed
-MD029: false                  # Ordered list item prefix
-MD033: false                  # Allow inline HTML
-MD036: false                  # Emphasis used instead of a heading
+  punctuation: '.,;:!。，；:' # List of not allowed
+MD029: false # Ordered list item prefix
+MD033: false # Allow inline HTML
+MD036: false # Emphasis used instead of a heading
 
 #################
 # Rules by tags #
 #################
-blank_lines: false  # Error on blank lines
+blank_lines: false # Error on blank lines

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'