feat(Sitemap): add HOSTNAME env var to generate a sitemap

Fix #476

Author: sharevb

.github/workflows/sharevb-vercel-prod.yml

@@ -4,6 +4,7 @@ env:
   VERCEL_PROJECT_ID: ${{ secrets.VERCEL_PROJECT_ID }}
   VITE_VERCEL_ENV: production
   VITE_VERCEL_DEPLOY: true
+  HOSTNAME: https://sharevb-it-tools.vercel.app/
 on:
   push:
     branches:
@@ -20,4 +21,4 @@ jobs:
       - name: Build Project Artifacts
         run: vercel build --prod --token=${{ secrets.VERCEL_TOKEN }}
       - name: Deploy Project Artifacts to Vercel
-        run: vercel deploy --prebuilt --archive=tgz --prod --token=${{ secrets.VERCEL_TOKEN }}
+        run: vercel deploy --prebuilt --archive=tgz --prod --token=${{ secrets.VERCEL_TOKEN }}

package.json

@@ -379,6 +379,7 @@
     "utf8": "^3.0.0",
     "uuid": "^14.0.1",
     "vanilla-jsoneditor": "^3.12.0",
+    "vite-plugin-sitemap": "^0.8.2",
     "vue": "^3.5.39",
     "vue-color-wheel": "^0.1.1",
     "vue-i18n": "^11.4.6",
@@ -457,6 +458,7 @@
     "commander": "^15.0.0",
     "consola": "^3.4.2",
     "dotenv": "^17.4.2",
+    "fast-glob": "^3.3.3",
     "hygen": "^6.2.11",
     "jsdom": "^29.1.1",
     "less": "^4.6.7",

pnpm-lock.yaml

@@ -18,17 +18,19 @@ import Icons from 'unplugin-icons/vite';
 import IconsResolver from 'unplugin-icons/resolver';
 import VueI18n from '@intlify/unplugin-vue-i18n/vite';
 
+import fs from 'node:fs';
+import fg from 'fast-glob';
+import Sitemap from 'vite-plugin-sitemap';
+
 import { visualizer } from 'rollup-plugin-visualizer';
 
 const baseUrl = process.env.BASE_URL || '/';
+const hostname = process.env.HOSTNAME;
 
 // Locales are code-split: only en is bundled eagerly, the rest become lazy chunks fetched on
 // first use (see src/plugins/i18n.plugin.ts). VITE_AVAILABLE_LOCALES filters the locales
 // offered at runtime instead of trimming the build.
-const includeLocales = [
-  resolve(__dirname, 'src/tools/*/locales/**'),
-  resolve(__dirname, 'locales/**'),
-];
+const includeLocales = [resolve(__dirname, 'src/tools/*/locales/**'), resolve(__dirname, 'locales/**')];
 
 // https://vitejs.dev/config/
 export default defineConfig({
@@ -67,15 +69,16 @@ export default defineConfig({
         // tool chunk and WASM binary (~160 MB) on first visit; hashed assets are
         // cached on demand as tools are opened. Set VITE_PWA_FULL_PRECACHE=true to
         // restore full offline precaching of everything.
-        globPatterns: (process.env.VITE_PWA_FULL_PRECACHE === 'true' && !process.env.VITE_VERCEL_DEPLOY)
-          ? ['**\/*.{js,wasm,css,html}']
-          : ['**\/*.{css,html}'],
+        globPatterns:
+          process.env.VITE_PWA_FULL_PRECACHE === 'true' && !process.env.VITE_VERCEL_DEPLOY
+            ? ['**\/*.{js,wasm,css,html}']
+            : ['**\/*.{css,html}'],
         maximumFileSizeToCacheInBytes: 25 * 1024 ** 2,
         navigateFallback: `${baseUrl}index.html`,
         runtimeCaching: [
           {
-            urlPattern: ({ sameOrigin, request }) => sameOrigin
-              && (request.destination === 'script' || request.destination === 'worker'),
+            urlPattern: ({ sameOrigin, request }) =>
+              sameOrigin && (request.destination === 'script' || request.destination === 'worker'),
             handler: 'CacheFirst',
             options: {
               cacheName: 'app-chunks',
@@ -142,19 +145,44 @@ export default defineConfig({
     nodePolyfills(),
     wasm(),
     visualizer(),
+    hostname
+      ? Sitemap({
+          hostname,
+          generateRobotsTxt: true,
+          robots: [{ userAgent: '*', allow: '/' }],
+          dynamicRoutes: (() => {
+            const paths = ['/', '/about'];
+            fg.sync('src/tools/*/index.ts').forEach((file) => {
+              const content = fs.readFileSync(file, 'utf-8');
+              const pathMatch = content.match(/path:\s*['"`]([^'"`]+)['"`]/);
+              if (pathMatch) {
+                paths.push(pathMatch[1]);
+              }
+              const redirectMatch = content.match(/redirectFrom:\s*\[([^\]]+)\]/);
+              if (redirectMatch?.[1]) {
+                const redirectPaths = redirectMatch[1].match(/['"`]([^'"`]+)['"`]/g);
+                redirectPaths?.forEach((p) => paths.push(p.replace(/['"`]/g, '')));
+              }
+            });
+            return paths;
+          })(),
+        })
+      : undefined,
   ],
   base: baseUrl,
   resolve: {
     alias: {
       '@': fileURLToPath(new URL('./src', import.meta.url)),
       'node:fs/promises': fileURLToPath(new URL('./src/_empty.ts', import.meta.url)),
       'node:fs': fileURLToPath(new URL('./src/_empty.ts', import.meta.url)),
-      'fs': fileURLToPath(new URL('./src/_empty.ts', import.meta.url)),
+      fs: fileURLToPath(new URL('./src/_empty.ts', import.meta.url)),
       '@babel/core': fileURLToPath(new URL('./src/_empty.ts', import.meta.url)),
       'isolated-vm': fileURLToPath(new URL('./src/_empty.ts', import.meta.url)),
       'onnxruntime-node': fileURLToPath(new URL('./src/_empty.ts', import.meta.url)),
       'unpdf/pdfjs': fileURLToPath(new URL('./src/_empty.ts', import.meta.url)),
-      'webcrypto-liner-shim': !process.env.VERCEL ? 'webcrypto-liner-shim' : fileURLToPath(new URL('./src/_empty.ts', import.meta.url)),
+      'webcrypto-liner-shim': !process.env.VERCEL
+        ? 'webcrypto-liner-shim'
+        : fileURLToPath(new URL('./src/_empty.ts', import.meta.url)),
     },
   },
   define: {
@@ -197,7 +225,16 @@ export default defineConfig({
     },
   },
   optimizeDeps: {
-    include: ['isolated-vm', '@lezer/highlight', 'pdfjs-dist', 'onnxruntime-node', 'onnxruntime-web', 'unpdf', 'unpdf/pdfjs', ...(process.env.VERCEL ? ['webcrypto-liner-shim'] : [])], // optionally specify dependency name
+    include: [
+      'isolated-vm',
+      '@lezer/highlight',
+      'pdfjs-dist',
+      'onnxruntime-node',
+      'onnxruntime-web',
+      'unpdf',
+      'unpdf/pdfjs',
+      ...(process.env.VERCEL ? ['webcrypto-liner-shim'] : []),
+    ], // optionally specify dependency name
   },
   // server: {
   // headers: {