From f417ba2b95f2c346f389184de7cdacf658097a63 Mon Sep 17 00:00:00 2001
From: "Mr.Hope" <mister-hope@outlook.com>
Date: Tue, 10 Oct 2023 23:22:17 +0800
Subject: [PATCH 1/4] fix: add support for custom protocol, close #1404

---
 .../src/client/components/AutoLink.vue        |  4 ++--
 packages/shared/src/utils/hasProtocol.ts      |  5 ++++
 packages/shared/src/utils/index.ts            |  4 +---
 packages/shared/src/utils/isLinkExternal.ts   |  4 +---
 packages/shared/src/utils/isLinkFtp.ts        |  4 ----
 packages/shared/src/utils/isLinkMailto.ts     |  4 ----
 packages/shared/src/utils/isLinkTel.ts        |  4 ----
 packages/shared/tests/hasProtocal.spec.ts     | 24 +++++++++++++++++++
 packages/shared/tests/isLinkExternal.spec.ts  | 10 ++++----
 packages/shared/tests/isLinkFtp.spec.ts       | 21 ----------------
 packages/shared/tests/isLinkMailto.spec.ts    | 23 ------------------
 packages/shared/tests/isLinkTel.spec.ts       | 23 ------------------
 12 files changed, 38 insertions(+), 92 deletions(-)
 create mode 100644 packages/shared/src/utils/hasProtocol.ts
 delete mode 100644 packages/shared/src/utils/isLinkFtp.ts
 delete mode 100644 packages/shared/src/utils/isLinkMailto.ts
 delete mode 100644 packages/shared/src/utils/isLinkTel.ts
 create mode 100644 packages/shared/tests/hasProtocal.spec.ts
 delete mode 100644 packages/shared/tests/isLinkFtp.spec.ts
 delete mode 100644 packages/shared/tests/isLinkMailto.spec.ts
 delete mode 100644 packages/shared/tests/isLinkTel.spec.ts

diff --git a/ecosystem/theme-default/src/client/components/AutoLink.vue b/ecosystem/theme-default/src/client/components/AutoLink.vue
index e15784a31b..ef17b96f66 100644
--- a/ecosystem/theme-default/src/client/components/AutoLink.vue
+++ b/ecosystem/theme-default/src/client/components/AutoLink.vue
@@ -10,7 +10,7 @@ export default defineComponent({
 
 <script setup lang="ts">
 import { useSiteData } from '@vuepress/client'
-import { isLinkHttp, isLinkMailto, isLinkTel } from '@vuepress/shared'
+import { hasProtocol, isLinkHttp } from '@vuepress/shared'
 import { computed, toRefs } from 'vue'
 import type { PropType } from 'vue'
 import { useRoute } from 'vue-router'
@@ -36,7 +36,7 @@ const { item } = toRefs(props)
 const hasHttpProtocol = computed(() => isLinkHttp(item.value.link))
 // if the link has non-http protocol
 const hasNonHttpProtocol = computed(
-  () => isLinkMailto(item.value.link) || isLinkTel(item.value.link),
+  () => !hasHttpProtocol.value && hasProtocol(item.value.link),
 )
 // resolve the `target` attr
 const linkTarget = computed(() => {
diff --git a/packages/shared/src/utils/hasProtocol.ts b/packages/shared/src/utils/hasProtocol.ts
new file mode 100644
index 0000000000..159e6f87af
--- /dev/null
+++ b/packages/shared/src/utils/hasProtocol.ts
@@ -0,0 +1,5 @@
+/**
+ * Whether the link has a protocol
+ */
+export const hasProtocol = (link: string): boolean =>
+  /^[a-z][a-z0-9+.-]*:/.test(link)
diff --git a/packages/shared/src/utils/index.ts b/packages/shared/src/utils/index.ts
index a3967da277..8204c82520 100644
--- a/packages/shared/src/utils/index.ts
+++ b/packages/shared/src/utils/index.ts
@@ -5,11 +5,9 @@ export * from './dedupeHead.js'
 export * from './ensureLeadingSlash.js'
 export * from './ensureEndingSlash.js'
 export * from './formatDateString.js'
+export * from './hasProtocol.js'
 export * from './isLinkExternal.js'
-export * from './isLinkFtp.js'
 export * from './isLinkHttp.js'
-export * from './isLinkMailto.js'
-export * from './isLinkTel.js'
 export * from './isPlainObject.js'
 export * from './omit.js'
 export * from './removeEndingSlash.js'
diff --git a/packages/shared/src/utils/isLinkExternal.ts b/packages/shared/src/utils/isLinkExternal.ts
index 0c3f9a8854..4c75a56407 100644
--- a/packages/shared/src/utils/isLinkExternal.ts
+++ b/packages/shared/src/utils/isLinkExternal.ts
@@ -1,4 +1,3 @@
-import { isLinkFtp } from './isLinkFtp.js'
 import { isLinkHttp } from './isLinkHttp.js'
 
 const markdownLinkRegexp = /.md((\?|#).*)?$/
@@ -7,8 +6,7 @@ const markdownLinkRegexp = /.md((\?|#).*)?$/
  * Determine a link is external or not
  */
 export const isLinkExternal = (link: string, base = '/'): boolean => {
-  // http link or ftp link
-  if (isLinkHttp(link) || isLinkFtp(link)) {
+  if (isLinkHttp(link)) {
     return true
   }
 
diff --git a/packages/shared/src/utils/isLinkFtp.ts b/packages/shared/src/utils/isLinkFtp.ts
deleted file mode 100644
index 182043c58f..0000000000
--- a/packages/shared/src/utils/isLinkFtp.ts
+++ /dev/null
@@ -1,4 +0,0 @@
-/**
- * Determine a link is ftp link or not
- */
-export const isLinkFtp = (link: string): boolean => link.startsWith('ftp://')
diff --git a/packages/shared/src/utils/isLinkMailto.ts b/packages/shared/src/utils/isLinkMailto.ts
deleted file mode 100644
index 3e0ade3594..0000000000
--- a/packages/shared/src/utils/isLinkMailto.ts
+++ /dev/null
@@ -1,4 +0,0 @@
-/**
- * Determine a link is a mailto: address or not
- */
-export const isLinkMailto = (link: string): boolean => /^mailto:/.test(link)
diff --git a/packages/shared/src/utils/isLinkTel.ts b/packages/shared/src/utils/isLinkTel.ts
deleted file mode 100644
index 1290cba096..0000000000
--- a/packages/shared/src/utils/isLinkTel.ts
+++ /dev/null
@@ -1,4 +0,0 @@
-/**
- * Determine a link is a tel: address or not
- */
-export const isLinkTel = (link: string): boolean => /^tel:/.test(link)
diff --git a/packages/shared/tests/hasProtocal.spec.ts b/packages/shared/tests/hasProtocal.spec.ts
new file mode 100644
index 0000000000..29d334ac73
--- /dev/null
+++ b/packages/shared/tests/hasProtocal.spec.ts
@@ -0,0 +1,24 @@
+import { describe, expect, it } from 'vitest'
+import { hasProtocol } from '../src/index.js'
+
+const testCases: [string, ReturnType<typeof hasProtocol>][] = [
+  ['ftp://foobar.com', true],
+  ['mailto:foobar', true],
+  ['tel:foobar', true],
+  ['https://foobar.com', true],
+  ['http://foobar.com', true],
+  ['foobar.com', false],
+  ['/foo/bar', false],
+  ['../foo/bar', false],
+  ['//foobar.com', false],
+]
+
+describe('shared > hasProtocol', () => {
+  describe('should determine link with protocol correctly', () => {
+    testCases.forEach(([source, expected]) => {
+      it(`link: ${source}`, () => {
+        expect(hasProtocol(source)).toBe(expected)
+      })
+    })
+  })
+})
diff --git a/packages/shared/tests/isLinkExternal.spec.ts b/packages/shared/tests/isLinkExternal.spec.ts
index b7a2515e11..5f5bd960e2 100644
--- a/packages/shared/tests/isLinkExternal.spec.ts
+++ b/packages/shared/tests/isLinkExternal.spec.ts
@@ -5,27 +5,27 @@ const testCases: [
   Parameters<typeof isLinkExternal>,
   ReturnType<typeof isLinkExternal>,
 ][] = [
-  // http & ftp links
+  // http links
   [['https://foobar.com'], true],
   [['https://foobar.com', '/base/'], true],
   [['http://foobar.com'], true],
   [['http://foobar.com', '/base/'], true],
   [['//foobar.com'], true],
   [['//foobar.com', '/base/'], true],
-  [['ftp://foobar.com'], true],
-  [['ftp://foobar.com', '/base/'], true],
   [['https://foobar.com/base/README.md'], true],
   [['https://foobar.com/base/README.md', '/base/'], true],
   [['http://foobar.com/base/README.md'], true],
   [['http://foobar.com/base/README.md', '/base/'], true],
   [['//foobar.com/base/README.md'], true],
   [['//foobar.com/base/README.md', '/base/'], true],
-  [['ftp://foobar.com/base/README.md'], true],
-  [['ftp://foobar.com/base/README.md', '/base/'], true],
 
   // links with other protocols
   [['mailto:foobar', '/base/'], false],
   [['tel:foobar', '/base/'], false],
+  [['ftp://foobar.com'], false],
+  [['ftp://foobar.com', '/base/'], false],
+  [['ftp://foobar.com/base/README.md'], false],
+  [['ftp://foobar.com/base/README.md', '/base/'], false],
 
   // absolute links
   [['/foo/bar'], false],
diff --git a/packages/shared/tests/isLinkFtp.spec.ts b/packages/shared/tests/isLinkFtp.spec.ts
deleted file mode 100644
index 446d084c3e..0000000000
--- a/packages/shared/tests/isLinkFtp.spec.ts
+++ /dev/null
@@ -1,21 +0,0 @@
-import { describe, expect, it } from 'vitest'
-import { isLinkFtp } from '../src/index.js'
-
-const testCases: [string, ReturnType<typeof isLinkFtp>][] = [
-  ['ftp://foobar.com', true],
-  ['https://foobar.com', false],
-  ['http://foobar.com', false],
-  ['//foobar.com', false],
-  ['foobar.com', false],
-  ['/foo/bar', false],
-]
-
-describe('shared > isLinkFtp', () => {
-  describe('should determine ftp link correctly', () => {
-    testCases.forEach(([source, expected]) => {
-      it(`link: ${source}`, () => {
-        expect(isLinkFtp(source)).toBe(expected)
-      })
-    })
-  })
-})
diff --git a/packages/shared/tests/isLinkMailto.spec.ts b/packages/shared/tests/isLinkMailto.spec.ts
deleted file mode 100644
index 900d4b45ee..0000000000
--- a/packages/shared/tests/isLinkMailto.spec.ts
+++ /dev/null
@@ -1,23 +0,0 @@
-import { describe, expect, it } from 'vitest'
-import { isLinkMailto } from '../src/index.js'
-
-const testCases: [string, boolean][] = [
-  ['https://foobar.com', false],
-  ['http://foobar.com', false],
-  ['//foobar.com', false],
-  ['foobar.com', false],
-  ['/foo/bar', false],
-  ['mailto:foobar', true],
-  ['tel:foobar', false],
-  ['../foo/bar', false],
-]
-
-describe('shared > isLinkMailto', () => {
-  describe('should determine mailto link correctly', () => {
-    testCases.forEach(([source, expected]) => {
-      it(`link: ${source}`, () => {
-        expect(isLinkMailto(source)).toBe(expected)
-      })
-    })
-  })
-})
diff --git a/packages/shared/tests/isLinkTel.spec.ts b/packages/shared/tests/isLinkTel.spec.ts
deleted file mode 100644
index 60c8361b02..0000000000
--- a/packages/shared/tests/isLinkTel.spec.ts
+++ /dev/null
@@ -1,23 +0,0 @@
-import { describe, expect, it } from 'vitest'
-import { isLinkTel } from '../src/index.js'
-
-const testCases: [string, boolean][] = [
-  ['https://foobar.com', false],
-  ['http://foobar.com', false],
-  ['//foobar.com', false],
-  ['foobar.com', false],
-  ['/foo/bar', false],
-  ['mailto:foobar', false],
-  ['tel:foobar', true],
-  ['../foo/bar', false],
-]
-
-describe('shared > isLinkMailto', () => {
-  describe('should determine mailto link correctly', () => {
-    testCases.forEach(([source, expected]) => {
-      it(`link: ${source}`, () => {
-        expect(isLinkTel(source)).toBe(expected)
-      })
-    })
-  })
-})

From 8051284e33dd9f7cb560d2143fa76caf6f709645 Mon Sep 17 00:00:00 2001
From: meteorlxy <meteor.lxy@foxmail.com>
Date: Tue, 14 Nov 2023 23:43:09 +0800
Subject: [PATCH 2/4] test: add custom protocol

---
 packages/shared/tests/hasProtocal.spec.ts    | 1 +
 packages/shared/tests/isLinkExternal.spec.ts | 1 +
 2 files changed, 2 insertions(+)

diff --git a/packages/shared/tests/hasProtocal.spec.ts b/packages/shared/tests/hasProtocal.spec.ts
index 29d334ac73..34df366460 100644
--- a/packages/shared/tests/hasProtocal.spec.ts
+++ b/packages/shared/tests/hasProtocal.spec.ts
@@ -3,6 +3,7 @@ import { hasProtocol } from '../src/index.js'
 
 const testCases: [string, ReturnType<typeof hasProtocol>][] = [
   ['ftp://foobar.com', true],
+  ['ms-windows-store://home', true],
   ['mailto:foobar', true],
   ['tel:foobar', true],
   ['https://foobar.com', true],
diff --git a/packages/shared/tests/isLinkExternal.spec.ts b/packages/shared/tests/isLinkExternal.spec.ts
index 5f5bd960e2..96291a4b3d 100644
--- a/packages/shared/tests/isLinkExternal.spec.ts
+++ b/packages/shared/tests/isLinkExternal.spec.ts
@@ -26,6 +26,7 @@ const testCases: [
   [['ftp://foobar.com', '/base/'], false],
   [['ftp://foobar.com/base/README.md'], false],
   [['ftp://foobar.com/base/README.md', '/base/'], false],
+  [['ms-windows-store://home', '/base/'], false],
 
   // absolute links
   [['/foo/bar'], false],

From d7e928338927ba45436fa1bff26d1b50a4078b61 Mon Sep 17 00:00:00 2001
From: meteorlxy <meteor.lxy@foxmail.com>
Date: Tue, 14 Nov 2023 23:44:54 +0800
Subject: [PATCH 3/4] chore: rename

---
 .../shared/tests/{hasProtocal.spec.ts => hasProtocol.spec.ts}     | 0
 1 file changed, 0 insertions(+), 0 deletions(-)
 rename packages/shared/tests/{hasProtocal.spec.ts => hasProtocol.spec.ts} (100%)

diff --git a/packages/shared/tests/hasProtocal.spec.ts b/packages/shared/tests/hasProtocol.spec.ts
similarity index 100%
rename from packages/shared/tests/hasProtocal.spec.ts
rename to packages/shared/tests/hasProtocol.spec.ts

From 7eba693946f8cd27cb9992d7c4879456a2da4948 Mon Sep 17 00:00:00 2001
From: meteorlxy <meteor.lxy@foxmail.com>
Date: Tue, 14 Nov 2023 23:47:03 +0800
Subject: [PATCH 4/4] refactor: rename to isLinkWithProtocol

---
 .../theme-default/src/client/components/AutoLink.vue      | 4 ++--
 packages/shared/src/utils/hasProtocol.ts                  | 5 -----
 packages/shared/src/utils/index.ts                        | 2 +-
 packages/shared/src/utils/isLinkWithProtocol.ts           | 5 +++++
 .../{hasProtocol.spec.ts => isLinkWithProtocol.spec.ts}   | 8 ++++----
 5 files changed, 12 insertions(+), 12 deletions(-)
 delete mode 100644 packages/shared/src/utils/hasProtocol.ts
 create mode 100644 packages/shared/src/utils/isLinkWithProtocol.ts
 rename packages/shared/tests/{hasProtocol.spec.ts => isLinkWithProtocol.spec.ts} (68%)

diff --git a/ecosystem/theme-default/src/client/components/AutoLink.vue b/ecosystem/theme-default/src/client/components/AutoLink.vue
index ef17b96f66..b6d8e404f3 100644
--- a/ecosystem/theme-default/src/client/components/AutoLink.vue
+++ b/ecosystem/theme-default/src/client/components/AutoLink.vue
@@ -10,7 +10,7 @@ export default defineComponent({
 
 <script setup lang="ts">
 import { useSiteData } from '@vuepress/client'
-import { hasProtocol, isLinkHttp } from '@vuepress/shared'
+import { isLinkHttp, isLinkWithProtocol } from '@vuepress/shared'
 import { computed, toRefs } from 'vue'
 import type { PropType } from 'vue'
 import { useRoute } from 'vue-router'
@@ -36,7 +36,7 @@ const { item } = toRefs(props)
 const hasHttpProtocol = computed(() => isLinkHttp(item.value.link))
 // if the link has non-http protocol
 const hasNonHttpProtocol = computed(
-  () => !hasHttpProtocol.value && hasProtocol(item.value.link),
+  () => !hasHttpProtocol.value && isLinkWithProtocol(item.value.link),
 )
 // resolve the `target` attr
 const linkTarget = computed(() => {
diff --git a/packages/shared/src/utils/hasProtocol.ts b/packages/shared/src/utils/hasProtocol.ts
deleted file mode 100644
index 159e6f87af..0000000000
--- a/packages/shared/src/utils/hasProtocol.ts
+++ /dev/null
@@ -1,5 +0,0 @@
-/**
- * Whether the link has a protocol
- */
-export const hasProtocol = (link: string): boolean =>
-  /^[a-z][a-z0-9+.-]*:/.test(link)
diff --git a/packages/shared/src/utils/index.ts b/packages/shared/src/utils/index.ts
index 8204c82520..5cbea86d0e 100644
--- a/packages/shared/src/utils/index.ts
+++ b/packages/shared/src/utils/index.ts
@@ -5,9 +5,9 @@ export * from './dedupeHead.js'
 export * from './ensureLeadingSlash.js'
 export * from './ensureEndingSlash.js'
 export * from './formatDateString.js'
-export * from './hasProtocol.js'
 export * from './isLinkExternal.js'
 export * from './isLinkHttp.js'
+export * from './isLinkWithProtocol.js'
 export * from './isPlainObject.js'
 export * from './omit.js'
 export * from './removeEndingSlash.js'
diff --git a/packages/shared/src/utils/isLinkWithProtocol.ts b/packages/shared/src/utils/isLinkWithProtocol.ts
new file mode 100644
index 0000000000..e6f66e9741
--- /dev/null
+++ b/packages/shared/src/utils/isLinkWithProtocol.ts
@@ -0,0 +1,5 @@
+/**
+ * Determine a link has protocol or not
+ */
+export const isLinkWithProtocol = (link: string): boolean =>
+  /^[a-z][a-z0-9+.-]*:/.test(link)
diff --git a/packages/shared/tests/hasProtocol.spec.ts b/packages/shared/tests/isLinkWithProtocol.spec.ts
similarity index 68%
rename from packages/shared/tests/hasProtocol.spec.ts
rename to packages/shared/tests/isLinkWithProtocol.spec.ts
index 34df366460..cacc8b318f 100644
--- a/packages/shared/tests/hasProtocol.spec.ts
+++ b/packages/shared/tests/isLinkWithProtocol.spec.ts
@@ -1,7 +1,7 @@
 import { describe, expect, it } from 'vitest'
-import { hasProtocol } from '../src/index.js'
+import { isLinkWithProtocol } from '../src/index.js'
 
-const testCases: [string, ReturnType<typeof hasProtocol>][] = [
+const testCases: [string, ReturnType<typeof isLinkWithProtocol>][] = [
   ['ftp://foobar.com', true],
   ['ms-windows-store://home', true],
   ['mailto:foobar', true],
@@ -14,11 +14,11 @@ const testCases: [string, ReturnType<typeof hasProtocol>][] = [
   ['//foobar.com', false],
 ]
 
-describe('shared > hasProtocol', () => {
+describe('shared > isLinkWithProtocol', () => {
   describe('should determine link with protocol correctly', () => {
     testCases.forEach(([source, expected]) => {
       it(`link: ${source}`, () => {
-        expect(hasProtocol(source)).toBe(expected)
+        expect(isLinkWithProtocol(source)).toBe(expected)
       })
     })
   })