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

This pull request includes updates to configuration files and PowerShell
scripts to improve linting controls and documentation. The main changes
are grouped into configuration improvements and documentation
enhancements.

**Configuration improvements:**

* Added a new `Linter` section to `.github/PSModule.yml` to explicitly
disable several validation checks in the CI environment, such as Biome
format/lint, GitHub Actions Zizmor, JSCPD, and various Prettier
validations.
* Updated `.github/linters/.markdown-lint.yml` to disable the `MD024`
rule (no duplicate headings allowed) and clarified the punctuation list
for `MD026`, allowing for more flexibility in markdown documentation.

**Documentation enhancements:**

* Added a `.DESCRIPTION` section to the comment-based help in
`src/functions/private/Get-InternalPSModule.ps1` to provide more
detailed documentation for the function.
* Added a `.DESCRIPTION` section to the comment-based help in
`src/functions/private/Set-InternalPSModule.ps1` for improved clarity
and completeness of the function's 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/private/Get-InternalPSModule.ps1

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

src/functions/private/Set-InternalPSModule.ps1

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

tests/MemoryMappedFile.Tests.ps1

@@ -11,12 +11,8 @@ param()
 
 Describe 'Module' {
     Context 'MemoryMappedFile' {
-        # It 'New-MemoryMappedFile' {
-        #     $fileName = '$HOME\test.json'
-        #     $size = 1024
-        #     $mmf = New-MemoryMappedFile -Name 'shared' -Path $fileName -Size $size
-        #     $mmf | Should -Not -BeNullOrEmpty
-        #     Test-Path $fileName | Should -BeTrue
-        # }
+        It 'No tests yet...' {
+            Write-Warning 'No tests yet...'
+        }
     }
 }