fix: treat links with non-http protocol as external (#51)

harlan-zw · Dec 16, 2024 · 994045d · 994045d
1 parent 226b006
commit 994045d
Show file tree

Hide file tree

Showing 5 changed files with 8 additions and 6 deletions.
diff --git a/playground/pages/fix-test.vue b/playground/pages/fix-test.vue
@@ -34,7 +34,7 @@
         absolute 404 link
       </LinkDebug>
       <LinkDebug to="javascript:history.back()">
-        javacript link
+        javascript link
       </LinkDebug>
       <LinkDebug to="/error">
         to an error page

diff --git a/playground/pages/index.vue b/playground/pages/index.vue
@@ -75,7 +75,7 @@
         absolute 404 link
       </LinkDebug>
       <LinkDebug to="javascript:history.back()">
-        javacript link
+        javascript link
       </LinkDebug>
       <LinkDebug to="/error">
         to an error page

diff --git a/src/runtime/shared/inspect.ts b/src/runtime/shared/inspect.ts
@@ -1,5 +1,5 @@
 import type { LinkInspectionResult, Rule, RuleTestContext } from '../types'
-import { parseURL } from 'ufo'
+import { hasProtocol, parseURL } from 'ufo'
 import RuleAbsoluteSiteUrls from './inspections/absolute-site-urls'
 import RuleDescriptiveLinkText from './inspections/link-text'
 import RuleMissingHash from './inspections/missing-hash'
@@ -45,7 +45,8 @@ export function inspect(ctx: Pick<Required<RuleTestContext>, 'link'> & Omit<Part
   let processing = true
   for (const rule of validInspections) {
     const isFakeAbsolute = link.startsWith('//') && !link.includes('.')
-    const isExternalLink = url.host && url.host !== siteConfigHost && !isFakeAbsolute
+    const hasNonHttpProtocol = hasProtocol(link) && !link.startsWith('http')
+    const isExternalLink = hasNonHttpProtocol || (url.host && url.host !== siteConfigHost && !isFakeAbsolute)
     if (!rule.externalLinks && isExternalLink) {
       continue
     }

diff --git a/src/runtime/shared/inspections/no-javascript.ts b/src/runtime/shared/inspections/no-javascript.ts
@@ -3,6 +3,7 @@ import { defineRule } from './util'
 export default function RuleNoJavascript() {
   return defineRule({
     id: 'no-javascript',
+    externalLinks: true,
     test({ link, report }) {
       if (link.startsWith('javascript:')) {
         report({

diff --git a/test/e2e/generate.test.ts b/test/e2e/generate.test.ts
@@ -301,7 +301,7 @@ describe('generate', () => {
               "fix": "javascript:history.back()",
               "link": "javascript:history.back()",
               "passes": false,
-              "textContent": "javacript link"
+              "textContent": "javascript link"
             },
             {
               "error": [],
@@ -493,7 +493,7 @@ describe('generate', () => {
               "fix": "javascript:history.back()",
               "link": "javascript:history.back()",
               "passes": false,
-              "textContent": "javacript link"
+              "textContent": "javascript link"
             },
             {
               "error": [],