Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Marius Storhaug (MariusStorhaug) merged 8 commits into from
Oct 11, 2025
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
afa75fc
Add linter configuration to PSModule.yml
MariusStorhaug Oct 6, 2025
5a47c59
Fix Docs
MariusStorhaug Oct 6, 2025
00358f8
Merge branch 'fixDocs' of https://github.com/PSModule/MemoryMappedFil…
MariusStorhaug Oct 8, 2025
7a7014d
Refactor markdown linter configuration for improved readability
MariusStorhaug Oct 8, 2025
3ac6d6c
Add DESCRIPTION section to module documentation
MariusStorhaug Oct 8, 2025
a6836f5
Uncomment test for New-MemoryMappedFile in MemoryMappedFile.Tests.ps1
MariusStorhaug Oct 9, 2025
66a828c
Remove placeholder test for New-MemoryMappedFile in MemoryMappedFile.…
MariusStorhaug Oct 11, 2025
73030e3
Update warning message in MemoryMappedFile.Tests.ps1 for clarity
MariusStorhaug Oct 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions .github/PSModule.yml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -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
Comment thread
MariusStorhaug marked this conversation as resolved.
VALIDATE_YAML_PRETTIER: false
17 changes: 9 additions & 8 deletions .github/linters/.markdown-lint.yml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -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
3 changes: 3 additions & 0 deletions src/functions/private/Get-InternalPSModule.ps1
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,9 @@
.SYNOPSIS
Performs tests on a module.

.DESCRIPTION
Performs tests on a module.
Comment thread
MariusStorhaug marked this conversation as resolved.

.EXAMPLE
Test-PSModule -Name 'World'

Expand Down
3 changes: 3 additions & 0 deletions src/functions/private/Set-InternalPSModule.ps1
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,9 @@
.SYNOPSIS
Performs tests on a module.

.DESCRIPTION
Performs tests on a module.
Comment thread
MariusStorhaug marked this conversation as resolved.
Comment thread
MariusStorhaug marked this conversation as resolved.

.EXAMPLE
Test-PSModule -Name 'World'

Expand Down
10 changes: 3 additions & 7 deletions tests/MemoryMappedFile.Tests.ps1
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -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...'
}
}
}
Loading