feat: translate nuxt-module-plausible to nuxt3

Author: tikagan

modules/nuxt-module-plausible/index.js

@@ -1,13 +1,23 @@
-/*
- *
- * 📦 [Module] NuxtModulePlausible
- *
- */
+console.log('📦 [load:module] nuxt-module-plausible')
 
 // ///////////////////////////////////////////////////////////////////// Imports
 // -----------------------------------------------------------------------------
-// ///////////////////////////////////////////////////////////////////// General
 import Path from 'path'
+
+import { defineNuxtModule, addPlugin } from 'nuxt/kit'
+
+// ////////////////////////////////////////////////////////////////////// Config
+// -----------------------------------------------------------------------------
+const meta = {
+  name: '@undone-labs/nuxt-module-plausible',
+  configKey: 'nuxtModulePlausible',
+  compatibility: {
+    nuxt: '^3.0.0'
+  }
+}
+
+// /////////////////////////////////////////////////////////////////// Functions
+// -----------------------------------------------------------------------------
 // ///////////////////////////////////////////////////////////////////// Plugins
 const plugins = [
   {
@@ -17,21 +27,23 @@ const plugins = [
 ]
 
 // ///////////////////////////////////////////////////////////// registerPlugins
-const registerPlugins = (instance, next) => {
-  return new Promise((next) => {
+const registerPlugins = () => {
     plugins.forEach((plugin) => {
-      instance.addPlugin(plugin)
+      addPlugin(plugin)
+      console.log('🔌 [nuxt-module-plausible:plugin]')
     })
-    if (next) { return next() }
-  })
 }
 
-// ///////////////////////////////////////////////////////////////////// Liftoff
+// /////////////////////////////////////////////////////////////////////// Setup
 // -----------------------------------------------------------------------------
-export default async function () {
-  if (this.options.plausible.include) {
-    await registerPlugins(this, () => {
-      console.log(`📦 [Module] Plausible`)
-    })
+const setup = async (_, nuxt) => {
+  if (nuxt.options.plausible.include) {
+    registerPlugins()
   }
 }
+// ////////////////////////////////////////////////////////////////////// Export
+// -----------------------------------------------------------------------------
+export default defineNuxtModule({
+  meta,
+  setup
+})

modules/nuxt-module-plausible/package.json

@@ -29,6 +29,7 @@
       }
     ],
     "license": "Apache-2.0",
+    "type": "module",
     "bugs": {
       "url": "https://github.com/undone-labs/nuxt-module-plausible/issues"
     },
@@ -52,4 +53,3 @@
      "access": "public"
     }
   }
-  

modules/nuxt-module-plausible/plugin.js

@@ -1,27 +1,22 @@
-/*
- *
- * 🔌 [Plugin | NuxtModulePlausible] Methods
- *
- */
-
-console.log(`🔌 [Plugin | Plausible] Plausible`)
-
 // ///////////////////////////////////////////////////////////////////// Imports
 // -----------------------------------------------------------------------------
-import Config from '@/nuxt.config'
+import { defineNuxtPlugin, useRuntimeConfig, useRouter } from '#imports'
+// import Config from '@/nuxt.config'
 
 // ////////////////////////////////////////////////////////////////////// Export
 // -----------------------------------------------------------------------------
-export default ({ app }) => {
+export default defineNuxtPlugin(() => {
 
   // Do not fire Plausible if not in production mode
   if (process.env.NODE_ENV !== 'production') {
     return
   }
 
+  const router = useRouter()
+  const config = useRuntimeConfig()
   let isInitialPageLoad = true
 
-  app.router.afterEach((to, from) => {
+  router.afterEach((to) => {
 
     // Ignore initial page because it's fired in the head
     if (isInitialPageLoad) {
@@ -36,8 +31,8 @@ export default ({ app }) => {
         (window.plausible.q = window.plausible.q || []).push(arguments)
       }
       window.plausible('pageview', {
-        url: `https://ecosystem.filecoin.io${to.fullPath}`
+        url: `${config.public.siteUrl}${to.fullPath}`
       })
     }
   })
-}
+})

nuxt.config.js

@@ -132,6 +132,7 @@ export default defineNuxtConfig({
   plausible: {
     include: true,
     domain: 'singularity.storage',
+    trackLocalhost: true,
     autoOutboundTracking: true
   },
   // //////////////////////////////////////////////////// [Module] @nuxt/content