feat: ignore query strings with exclude option (#104)

Author: HiDeoo

.changeset/tricky-apes-invite.md

@@ -0,0 +1,7 @@
+---
+'starlight-links-validator': minor
+---
+
+Ignores query strings when checking for [excluded links](https://starlight-links-validator.vercel.app/configuration#exclude).
+
+Previously, to exclude links with query strings, you may have needed to rely on fairly loose glob patterns, e.g. `/playground/**` to exclude `/playground/`, `/playground/?id=foo` and `/playground/?id=bar`. With this change, excluding `/playground/` will ignore all query strings, so `/playground/`, `/playground/?id=foo` and `/playground/?id=bar` will all be excluded.

packages/starlight-links-validator/libs/validation.ts

@@ -249,7 +249,7 @@ function isValidAsset(path: string, context: ValidationContext) {
  * Check if a link is excluded from validation by the user.
  */
 function isExcludedLink(link: Link, context: ValidationContext) {
-  return picomatch(context.options.exclude)(link.raw)
+  return picomatch(context.options.exclude)(stripQueryString(link.raw))
 }
 
 function stripQueryString(path: string): string {

packages/starlight-links-validator/tests/exclude.test.ts

@@ -9,10 +9,11 @@ test('ignores links that are excluded from validation', async () => {
 
   expect(status).toBe('error')
 
-  expectValidationErrorCount(output, 6, 1)
+  expectValidationErrorCount(output, 7, 1)
 
   expectValidationErrors(output, '/', [
     ['/excluded/', ValidationErrorType.InvalidLink],
+    ['/excluded/?something', ValidationErrorType.InvalidLink],
     ['/excluded#test', ValidationErrorType.InvalidLink],
     ['/test/excluded', ValidationErrorType.InvalidLink],
     ['/test/excluded/test', ValidationErrorType.InvalidLink],

packages/starlight-links-validator/tests/fixtures/exclude/src/content/docs/index.md

@@ -13,8 +13,10 @@ title: Index
 # Exclude
 
 - [Excluded link](/excluded)
+- [Excluded link with query string](/excluded?something)
 
 - [Non-excluded link](/excluded/)
+- [Non-excluded link with query string](/excluded/?something)
 - [More non-excluded link](/excluded#test)
 - [Another non-excluded link](/test/excluded)
 - [And another non-excluded link](/test/excluded/test)