diff --git a/.github/PSModule.yml b/.github/PSModule.yml index 35f3fc6..3f5a777 100644 --- a/.github/PSModule.yml +++ b/.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 diff --git a/.github/linters/.markdown-lint.yml b/.github/linters/.markdown-lint.yml index b9ecdfa..57db57e 100644 --- a/.github/linters/.markdown-lint.yml +++ b/.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 diff --git a/src/functions/public/ConvertTo-UriQueryString.ps1 b/src/functions/public/ConvertTo-UriQueryString.ps1 index c956332..5cba03d 100644 --- a/src/functions/public/ConvertTo-UriQueryString.ps1 +++ b/src/functions/public/ConvertTo-UriQueryString.ps1 @@ -10,7 +10,9 @@ is an array, multiple entries for the same key are generated. .EXAMPLE + ```pwsh ConvertTo-UriQueryString -Query @{ foo = 'bar'; search = 'hello world'; ids = 1,2,3 } + ``` Output: ```powershell diff --git a/src/functions/public/Get-Uri.ps1 b/src/functions/public/Get-Uri.ps1 index 537824d..d3c1c1d 100644 --- a/src/functions/public/Get-Uri.ps1 +++ b/src/functions/public/Get-Uri.ps1 @@ -11,7 +11,9 @@ format parameters. .EXAMPLE + ```pwsh Get-Uri -Uri 'example.com' + ``` Output: ```powershell @@ -42,7 +44,9 @@ Converts 'example.com' into a normalized absolute URI string. .EXAMPLE + ```pwsh Get-Uri -Uri 'https://example.com/path' -AsUriBuilder + ``` Output: ```powershell @@ -60,7 +64,9 @@ Returns a [System.UriBuilder] object for the specified URI. .EXAMPLE + ```pwsh 'example.com/path' | Get-Uri -AsString + ``` Output: ```powershell diff --git a/src/functions/public/New-Uri.ps1 b/src/functions/public/New-Uri.ps1 index 47b2cbb..a8b8f44 100644 --- a/src/functions/public/New-Uri.ps1 +++ b/src/functions/public/New-Uri.ps1 @@ -10,8 +10,9 @@ fragment identifiers. By default, returns a `[System.Uri]` object. .EXAMPLE - # Simple usage with base and path + ```pwsh New-Uri -BaseUri 'https://example.com' -Path 'products/item' + ``` Output: ```powershell @@ -42,8 +43,9 @@ Constructs a URI with the given base and path. .EXAMPLE - # Adding query parameters via hashtable + ```pwsh New-Uri 'https://example.com/api' -Path 'search' -Query @{ q = 'test search'; page = @(2, 4) } -AsUriBuilder + ``` Output: ```powershell @@ -61,8 +63,9 @@ Adds query parameters to the URI, automatically encoding values. .EXAMPLE - # Merging with existing query and using -MergeQueryParameter + ```pwsh New-Uri 'https://example.com/data?year=2023' -Query @{ year = 2024; sort = 'asc' } -MergeQueryParameters -AsString + ``` Output: ```powershell diff --git a/src/functions/public/Test-Uri.ps1 b/src/functions/public/Test-Uri.ps1 index 47d64d7..469d2a9 100644 --- a/src/functions/public/Test-Uri.ps1 +++ b/src/functions/public/Test-Uri.ps1 @@ -8,7 +8,9 @@ If the `-AllowRelative` switch is specified, it allows both absolute and relative URIs. .EXAMPLE + ```pwsh Test-Uri -Uri "https://example.com" + ``` Output: ```powershell @@ -18,7 +20,9 @@ Checks if `https://example.com` is a valid URI, returning `$true`. .EXAMPLE + ```pwsh Test-Uri -Uri "invalid-uri" + ``` Output: ```powershell @@ -28,7 +32,9 @@ Returns `$false` for an invalid URI string. .EXAMPLE + ```pwsh "https://example.com", "invalid-uri" | Test-Uri + ``` Output: ```powershell