feat: improves messages for errors related to the Astro `trailingSlas…

…h` option to indicate if a link is missing a trailing slash or if a link has a trailing slash when it should not
HiDeoo · Nov 27, 2024 · a87760a · a87760a
1 parent 0e4f143
commit a87760a
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 12 deletions.
diff --git a/packages/starlight-links-validator/libs/validation.ts b/packages/starlight-links-validator/libs/validation.ts
@@ -19,7 +19,8 @@ export const ValidationErrorType = {
   InvalidLink: 'invalid link',
   LocalLink: 'local link',
   RelativeLink: 'relative link',
-  TrailingSlash: 'trailing slash',
+  TrailingSlashMissing: 'missing trailing slash',
+  TrailingSlashForbidden: 'forbidden trailing slash',
 } as const
 
 export function validateLinks(
@@ -168,13 +169,14 @@ function validateLink(context: ValidationContext) {
     return
   }
 
-  if (
-    path.length > 0 &&
-    ((astroConfig.trailingSlash === 'always' && !path.endsWith('/')) ||
-      (astroConfig.trailingSlash === 'never' && path.endsWith('/')))
-  ) {
-    addError(errors, filePath, link, ValidationErrorType.TrailingSlash)
-    return
+  if (path.length > 0) {
+    if (astroConfig.trailingSlash === 'always' && !path.endsWith('/')) {
+      addError(errors, filePath, link, ValidationErrorType.TrailingSlashMissing)
+      return
+    } else if (astroConfig.trailingSlash === 'never' && path.endsWith('/')) {
+      addError(errors, filePath, link, ValidationErrorType.TrailingSlashForbidden)
+      return
+    }
   }
 }
 

diff --git a/packages/starlight-links-validator/tests/trailing.test.ts b/packages/starlight-links-validator/tests/trailing.test.ts
@@ -12,8 +12,8 @@ test('validates links when the `trailingSlash` Astro option is set to `never`',
   expectValidationErrorCount(output, 6, 1)
 
   expectValidationErrors(output, 'test/', [
-    ['/guides/example/', ValidationErrorType.TrailingSlash],
-    ['/guides/example/#description', ValidationErrorType.TrailingSlash],
+    ['/guides/example/', ValidationErrorType.TrailingSlashForbidden],
+    ['/guides/example/#description', ValidationErrorType.TrailingSlashForbidden],
     ['/unknown', ValidationErrorType.InvalidLink],
     ['/unknown/', ValidationErrorType.InvalidLink],
     ['/guides/example#unknown', ValidationErrorType.InvalidHash],
@@ -29,8 +29,8 @@ test('validates links when the `trailingSlash` Astro option is set to `always`',
   expectValidationErrorCount(output, 6, 1)
 
   expectValidationErrors(output, 'test/', [
-    ['/guides/example', ValidationErrorType.TrailingSlash],
-    ['/guides/example#description', ValidationErrorType.TrailingSlash],
+    ['/guides/example', ValidationErrorType.TrailingSlashMissing],
+    ['/guides/example#description', ValidationErrorType.TrailingSlashMissing],
     ['/unknown', ValidationErrorType.InvalidLink],
     ['/unknown/', ValidationErrorType.InvalidLink],
     ['/guides/example#unknown', ValidationErrorType.InvalidHash],