fix: escape experimental allowlist paths (#24)

* fix: escape experimental allowlist paths * chore: add dynamic routes to examples * chore: show 'generated at' in dynamic routes too * chore: use ts extension for consistency --------- Co-authored-by: Divyansh Singh <[email protected]>
vite-pwa · Oct 15, 2023 · f26e0fb · f26e0fb
1 parent 7fd1eee
commit f26e0fb
Show file tree

Hide file tree

Showing 5 changed files with 39 additions and 4 deletions.
diff --git a/examples/pwa-prompt/about.md b/examples/pwa-prompt/about.md
@@ -1,6 +1,7 @@
 ---
 title: About
 ---
+
 <script setup>
 const date = __DATE__
 </script>

diff --git a/examples/pwa-simple/.vitepress/config.ts b/examples/pwa-simple/.vitepress/config.ts
@@ -32,6 +32,13 @@ export default withPwa(defineConfig({
     nav: [
       { text: 'Home', link: '/' },
       { text: 'About', link: '/about', activeMatch: '/about' },
+      {
+        text: 'Packages',
+        items: [
+          { text: 'Foo', link: '/packages/foo' },
+          { text: 'Bar', link: '/packages/bar' },
+        ],
+      },
     ],
   },
   pwa: {

diff --git a/examples/pwa-simple/packages/[pkg].md b/examples/pwa-simple/packages/[pkg].md
@@ -0,0 +1,11 @@
+---
+title: Package
+---
+
+<script setup>
+const date = __DATE__
+</script>
+
+# Package `{{ $params.pkg }}`
+
+<pre>Generated at: {{ date }}</pre>
diff --git a/examples/pwa-simple/packages/[pkg].paths.ts b/examples/pwa-simple/packages/[pkg].paths.ts
@@ -0,0 +1,8 @@
+export default {
+  paths() {
+    return [
+      { params: { pkg: 'foo' } },
+      { params: { pkg: 'bar' } },
+    ]
+  },
+}
diff --git a/src/integration.ts b/src/integration.ts
@@ -112,10 +112,10 @@ export function withUserConfig<T = DefaultTheme.Config>(config: UserConfig<T>) {
       if (typeof allowlist !== 'undefined') {
         const base = siteConfig.site.base ?? '/'
         for (const page of siteConfig.pages) {
-          if (page === 'index.md')
-            allowlist.push(new RegExp(`^${base}(.html)?$`))
-          else
-            allowlist.push(new RegExp(`^${base}${page.replace(/\.md$/, '(.html)?')}$`))
+          const regex = page === 'index.md'
+            ? escapeStringRegexp(base)
+            : escapeStringRegexp(`${base}${page.replace(/\.md$/, '')}`)
+          allowlist.push(new RegExp(`^${regex}(\\.html)?$`))
         }
       }
       await api.generateSW()
@@ -124,3 +124,11 @@ export function withUserConfig<T = DefaultTheme.Config>(config: UserConfig<T>) {
 
   return vitePressConfig
 }
+
+function escapeStringRegexp(value: string) {
+  // Escape characters with special meaning either inside or outside character sets.
+  // Use a simple backslash escape when it’s always valid, and a `\xnn` escape when the simpler form would be disallowed by Unicode patterns’ stricter grammar.
+  return value
+    .replace(/[|\\{}()[\]^$+*?.]/g, '\\$&')
+    .replace(/-/g, '\\x2d')
+}