@dargmuesli/nuxt-vio 3.0.0-beta.19 → 3.0.0-beta.20

package/components/vio/_/VioLink.vue

@@ -1,9 +1,9 @@
 <template>
   <a
-    v-if="to.match(/^((ftp|http(s)?):\/\/|(mailto):)/)"
+    v-if="to?.toString().match(/^((ftp|http(s)?):\/\/|(mailto):)/)"
     :aria-label="ariaLabel"
     :class="classes"
-    :href="to"
+    :href="to.toString()"
     :rel="
       [...(nofollow ? ['nofollow'] : []), 'noopener', 'noreferrer'].join(' ')
     "
@@ -24,13 +24,15 @@
 </template>
 
 <script setup lang="ts">
+import { NuxtLinkProps } from '#app'
+
 export interface Props {
   ariaLabel?: string
   isColored?: boolean
   isToRelative?: boolean
   isUnderlined?: boolean
   nofollow?: boolean
-  to: string
+  to: NuxtLinkProps['to']
 }
 const props = withDefaults(defineProps<Props>(), {
   ariaLabel: undefined,

package/nuxt.config.ts

@@ -1,180 +1,172 @@
 import { dirname, join } from 'node:path'
 import { fileURLToPath } from 'node:url'
 
+import { defu } from 'defu'
+
 import {
+  BASE_URL,
   I18N_COOKIE_NAME,
-  I18N_MODULE_CONFIG,
-  TIMEZONE_COOKIE_NAME,
   SITE_NAME,
+  TIMEZONE_COOKIE_NAME,
+  VIO_NUXT_BASE_CONFIG,
 } from './utils/constants'
 
 const currentDir = dirname(fileURLToPath(import.meta.url))
 
-const BASE_URL =
-  (process.env.NUXT_PUBLIC_STACK_DOMAIN ? 'https' : 'http') +
-  '://' +
-  (process.env.NUXT_PUBLIC_STACK_DOMAIN ||
-    `${process.env.HOST || 'localhost'}:${
-      !process.env.NODE_ENV || process.env.NODE_ENV === 'development'
-        ? '3000'
-        : '3001'
-    }`)
-
 // https://v3.nuxtjs.org/api/configuration/nuxt.config
-export default defineNuxtConfig({
-  alias: {
-    clipboard: 'clipboard',
-    dayjs: 'dayjs',
-    sweetalert2: 'sweetalert2',
-  }, // TODO: remove (https://github.com/nuxt/nuxt/issues/19426)
-  app: {
-    head: {
-      htmlAttrs: {
-        lang: 'en', // fallback data to prevent invalid html at generation
+export default defineNuxtConfig(
+  defu(
+    {
+      alias: {
+        clipboard: 'clipboard',
+        dayjs: 'dayjs',
+        sweetalert2: 'sweetalert2',
+      }, // TODO: remove (https://github.com/nuxt/nuxt/issues/19426)
+      app: {
+        head: {
+          htmlAttrs: {
+            lang: 'en', // fallback data to prevent invalid html at generation
+          },
+          titleTemplate: '%s', // fully set in `composables/useAppLayout.ts`
+        },
+        pageTransition: {
+          name: 'layout',
+        },
       },
-      title: SITE_NAME, // fallback data to prevent invalid html at generation
-      titleTemplate: '%s', // fully set in `composables/useAppLayout.ts`
-    },
-    pageTransition: {
-      name: 'layout',
-    },
-  },
-  devtools: {
-    enabled: process.env.NODE_ENV !== 'production',
-    timeline: {
-      enabled: true,
-    },
-  },
-  modules: [
-    '@dargmuesli/nuxt-cookie-control',
-    '@nuxt/image',
-    '@nuxtjs/color-mode',
-    '@nuxtjs/html-validator',
-    '@nuxtjs/i18n',
-    '@nuxtjs/tailwindcss',
-    '@pinia/nuxt',
-    'nuxt-seo-kit-module',
-  ],
-  nitro: {
-    compressPublicAssets: true,
-  },
-  runtimeConfig: {
-    public: {
-      i18n: {
-        baseUrl: BASE_URL,
+      devtools: {
+        enabled: process.env.NODE_ENV !== 'production',
+        timeline: {
+          enabled: true,
+        },
       },
-      vio: {
-        googleAnalyticsId: '', // set via environment variable `NUXT_PUBLIC_GOOGLE_ANALYTICS_ID` only
-        isInProduction: process.env.NODE_ENV === 'production',
-        isTesting: false,
-        stagingHost:
-          process.env.NODE_ENV !== 'production' &&
-          !process.env.NUXT_PUBLIC_STACK_DOMAIN
-            ? 'localhost:3000'
-            : undefined,
+      modules: [
+        '@dargmuesli/nuxt-cookie-control',
+        '@nuxt/image',
+        '@nuxtjs/color-mode',
+        '@nuxtjs/html-validator',
+        '@nuxtjs/i18n',
+        '@nuxtjs/tailwindcss',
+        '@pinia/nuxt',
+        'nuxt-seo-kit-module',
+      ],
+      nitro: {
+        compressPublicAssets: true,
       },
-    },
-  },
-  typescript: {
-    shim: false,
-    // tsConfig: {
-    //   compilerOptions: {
-    //     esModuleInterop: true,
-    //   },
-    // },
-  },
-
-  // modules
-  colorMode: {
-    classSuffix: '',
-  },
-  cookieControl: {
-    cookies: {
-      necessary: [
-        {
-          description: {
-            de: 'Dieser Cookie von uns speichert die Einstellungen, die in diesem Dialog getroffen werden.',
-            en: 'This cookie of ours stores the settings made in this dialog.',
+      runtimeConfig: {
+        public: {
+          vio: {
+            googleAnalyticsId: '', // set via environment variable `NUXT_PUBLIC_GOOGLE_ANALYTICS_ID` only
+            isInProduction: process.env.NODE_ENV === 'production',
+            isTesting: false,
           },
-          id: 'c',
-          name: {
-            de: 'Cookie-Präferenzen',
-            en: 'Cookie Preferences',
-          },
-          targetCookieIds: ['ncc_c', 'ncc_e'],
         },
-        {
-          description: {
-            de: 'Dieser Cookie von uns speichert die Sprache, in der diese Webseite angezeigt wird.',
-            en: "This cookie of ours stores the language that's used to display this website.",
-          },
-          id: 'l',
-          name: {
-            de: 'Sprache',
-            en: 'Language',
+      },
+      typescript: {
+        shim: false,
+        tsConfig: {
+          compilerOptions: {
+            esModuleInterop: true,
+            // moduleResolution: 'bundler',
+            // noErrorTruncation: true,
           },
-          targetCookieIds: [I18N_COOKIE_NAME],
         },
-        {
-          description: {
-            de: 'Dieser Cookie von uns speichert die Zeitzone, in der sich das Gerät zu befinden scheint.',
-            en: 'This cookie of ours saves the timezone in which the device appears to be located.',
-          },
-          id: 't',
-          name: {
-            de: 'Zeitzone',
-            en: 'Timezone',
-          },
-          targetCookieIds: [TIMEZONE_COOKIE_NAME],
+      },
+
+      // modules
+      colorMode: {
+        classSuffix: '',
+      },
+      cookieControl: {
+        cookies: {
+          necessary: [
+            {
+              description: {
+                de: 'Dieser Cookie von uns speichert die Einstellungen, die in diesem Dialog getroffen werden.',
+                en: 'This cookie of ours stores the settings made in this dialog.',
+              },
+              id: 'c',
+              name: {
+                de: 'Cookie-Präferenzen',
+                en: 'Cookie Preferences',
+              },
+              targetCookieIds: ['ncc_c', 'ncc_e'],
+            },
+            {
+              description: {
+                de: 'Dieser Cookie von uns speichert die Sprache, in der diese Webseite angezeigt wird.',
+                en: "This cookie of ours stores the language that's used to display this website.",
+              },
+              id: 'l',
+              name: {
+                de: 'Sprache',
+                en: 'Language',
+              },
+              targetCookieIds: [I18N_COOKIE_NAME],
+            },
+            {
+              description: {
+                de: 'Dieser Cookie von uns speichert die Zeitzone, in der sich das Gerät zu befinden scheint.',
+                en: 'This cookie of ours saves the timezone in which the device appears to be located.',
+              },
+              id: 't',
+              name: {
+                de: 'Zeitzone',
+                en: 'Timezone',
+              },
+              targetCookieIds: [TIMEZONE_COOKIE_NAME],
+            },
+          ],
+          optional: [
+            {
+              description: {
+                de: 'Die Cookies vom Drittanbieter Google ermöglichen die Analyse von Nutzerverhalten. Diese Analyse hilft uns unsere Dienste zu verbessern, indem wir verstehen, wie diese Webseite genutzt wird.',
+                en: 'The third-party cookies by Google enable the analysis of user behavior. This analysis helps us to improve our services by understanding how this website is used.',
+              },
+              id: 'ga',
+              links: {
+                'https://policies.google.com/privacy': 'Google Privacy Policy',
+                'https://policies.google.com/terms': 'Google Terms of Service',
+              },
+              name: 'Analytics',
+              targetCookieIds: ['_ga', '_ga_K4R41W62BR'],
+            },
+          ],
         },
-      ],
-      optional: [
-        {
-          description: {
-            de: 'Die Cookies vom Drittanbieter Google ermöglichen die Analyse von Nutzerverhalten. Diese Analyse hilft uns unsere Dienste zu verbessern, indem wir verstehen, wie diese Webseite genutzt wird.',
-            en: 'The third-party cookies by Google enable the analysis of user behavior. This analysis helps us to improve our services by understanding how this website is used.',
-          },
-          id: 'ga',
-          links: {
-            'https://policies.google.com/privacy': 'Google Privacy Policy',
-            'https://policies.google.com/terms': 'Google Terms of Service',
-          },
-          name: 'Analytics',
-          targetCookieIds: ['_ga', '_ga_K4R41W62BR'],
+        locales: ['en', 'de'],
+      },
+      htmlValidator: {
+        failOnError: false, // TODO: fix invalid html in nuxt html template (https://github.com/nuxt/nuxt/issues/22526)
+        logLevel: 'warning',
+      },
+      i18n: {
+        defaultLocale: 'en', // Must be set for the default prefix_except_default prefix strategy.
+        detectBrowserLanguage: {
+          cookieKey: I18N_COOKIE_NAME,
+          cookieSecure: true,
         },
-      ],
-    },
-    locales: ['en', 'de'],
-  },
-  htmlValidator: {
-    failOnError: false, // TODO: fix invalid html in nuxt html template (https://github.com/nuxt/nuxt/issues/22526)
-    logLevel: 'warning',
-  },
-  i18n: {
-    ...I18N_MODULE_CONFIG,
-    defaultLocale: 'en', // Must be set for the default prefix_except_default prefix strategy.
-    detectBrowserLanguage: {
-      cookieKey: I18N_COOKIE_NAME,
-      cookieSecure: true,
+      },
+      linkChecker: {
+        debug: process.env.NODE_ENV === 'development',
+        failOnError: true,
+      },
+      seoKit: {
+        splash: false,
+      },
+      site: {
+        debug: process.env.NODE_ENV === 'development',
+        titleSeparator: '·',
+      },
+      sitemap: {
+        exclude: ['/api/pages/**'],
+      },
+      tailwindcss: {
+        cssPath: join(currentDir, './assets/css/tailwind.css'),
+      },
     },
-  },
-  linkChecker: {
-    debug: process.env.NODE_ENV === 'development',
-    failOnError: true,
-  },
-  seoKit: {
-    splash: false,
-  },
-  site: {
-    debug: process.env.NODE_ENV === 'development',
-    name: SITE_NAME,
-    titleSeparator: '·',
-    url: BASE_URL,
-  },
-  sitemap: {
-    exclude: ['/api/pages/**'],
-  },
-  tailwindcss: {
-    cssPath: join(currentDir, './assets/css/tailwind.css'),
-  },
-})
+    VIO_NUXT_BASE_CONFIG({
+      baseUrl: BASE_URL,
+      siteName: SITE_NAME,
+      stagingHost: 'localhost:3000',
+    }),
+  ),
+)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dargmuesli/nuxt-vio",
-  "version": "3.0.0-beta.19",
+  "version": "3.0.0-beta.20",
   "type": "module",
   "publishConfig": {
     "access": "public"

package/utils/constants.ts

@@ -1,5 +1,14 @@
 export const SITE_NAME = 'Vio'
 
+export const BASE_URL =
+  (process.env.NUXT_PUBLIC_STACK_DOMAIN ? 'https' : 'http') +
+  '://' +
+  (process.env.NUXT_PUBLIC_STACK_DOMAIN ||
+    `${process.env.HOST || 'localhost'}:${
+      !process.env.NODE_ENV || process.env.NODE_ENV === 'development'
+        ? '3000'
+        : '3001'
+    }`)
 export const CACHE_VERSION = 'bOXMwoKlJr'
 export const COOKIE_PREFIX = SITE_NAME.toLocaleLowerCase()
 export const COOKIE_SEPARATOR = '_'
@@ -38,44 +47,36 @@ export const VIO_NUXT_BASE_CONFIG = ({
   baseUrl?: string
   siteName: string
   stagingHost?: string
-}) => ({
-  app: {
-    head: {
-      title: SITE_NAME, // fallback data to prevent invalid html at generation
-    },
-  },
-  runtimeConfig: {
-    public: {
-      i18n: {
-        ...(baseUrl ? { baseUrl } : {}),
-      },
-      vio: {
-        ...(stagingHost
-          ? {
-              stagingHost:
-                process.env.NODE_ENV !== 'production' &&
-                !process.env.NUXT_PUBLIC_STACK_DOMAIN
-                  ? stagingHost
-                  : undefined,
-            }
-          : {}),
+}) =>
+  ({
+    app: {
+      head: {
+        title: SITE_NAME, // fallback data to prevent invalid html at generation
       },
     },
-  },
-  typescript: {
-    tsConfig: {
-      compilerOptions: {
-        esModuleInterop: true,
-        // moduleResolution: 'bundler',
-        // noErrorTruncation: true,
+    runtimeConfig: {
+      public: {
+        i18n: {
+          ...(baseUrl ? { baseUrl } : {}),
+        },
+        vio: {
+          ...(stagingHost
+            ? {
+                stagingHost:
+                  process.env.NODE_ENV !== 'production' &&
+                  !process.env.NUXT_PUBLIC_STACK_DOMAIN
+                    ? stagingHost
+                    : undefined,
+              }
+            : {}),
+        },
       },
     },
-  },
 
-  // modules
-  i18n: I18N_MODULE_CONFIG, // `langDir`, `lazy` and `locales` must be configured to extend a layer having lazy-loaded translations (https://v8.i18n.nuxtjs.org/guide/layers#locales)
-  site: {
-    name: siteName,
-    ...(baseUrl ? { url: baseUrl } : {}),
-  },
-})
+    // modules
+    i18n: I18N_MODULE_CONFIG, // `langDir`, `lazy` and `locales` must be configured to extend a layer having lazy-loaded translations (https://v8.i18n.nuxtjs.org/guide/layers#locales)
+    site: {
+      name: siteName,
+      ...(baseUrl ? { url: baseUrl } : {}),
+    },
+  }) as Parameters<typeof defineNuxtConfig>[0]

package/utils/routing.ts

@@ -1,2 +1,4 @@
-export const append = (path: string, pathToAppend: string) =>
-  path + (path.endsWith('/') ? '' : '/') + pathToAppend
+import { RouteLocationRaw } from '#vue-router'
+
+export const append = (path: string, pathToAppend?: RouteLocationRaw) =>
+  path + (path.endsWith('/') ? '' : '/') + (pathToAppend ?? '')