feat!: nuxt 3 compatibility (#59)

Author: pi0

.github/workflows/ci.yml

@@ -10,36 +10,17 @@ on:
 
 jobs:
   ci:
-    runs-on: ${{ matrix.os }}
-
-    strategy:
-      matrix:
-        os: [ubuntu-latest]
-        node: [14]
-
+    runs-on: ubuntu-latest
     steps:
+      - uses: actions/checkout@v3
+      - run: corepack enable
       - uses: actions/setup-node@v3
         with:
-          node-version: ${{ matrix.node }}
-
-      - name: checkout
-        uses: actions/checkout@v3
-
-      - name: cache node_modules
-        uses: actions/cache@v3
-        with:
-          path: node_modules
-          key: ${{ matrix.os }}-node-v${{ matrix.node }}-deps-${{ hashFiles(format('{0}{1}', github.workspace, '/yarn.lock')) }}
-
-      - name: Install dependencies
-        if: steps.cache.outputs.cache-hit != 'true'
-        run: yarn
-
-      - name: Lint
-        run: yarn lint
-
-      # - name: Test
-      #   run: yarn jest
+          node-version: 16
+          cache: "pnpm"
+      - run: pnpm install
+      - run: pnpm dev:prepare
+      - run: pnpm lint
+      - run: pnpm build
+      - run: pnpm dev:build
 
-      # - name: Coverage
-      #   uses: codecov/codecov-action@v1

.gitignore

@@ -2,3 +2,4 @@ node_modules
 *.log*
 dist
 .nuxt
+.output

.npmrc

@@ -0,0 +1,2 @@
+strict-peer-dependencies=false
+shamefully-hoist=true

.nuxtrc

@@ -0,0 +1,2 @@
+typescript.includeWorkspace=true
+imports.autoImport=false

package.json

@@ -18,37 +18,36 @@
   "repository": "nuxt-modules/web-vitals",
   "license": "MIT",
   "exports": {
-    ".": "./dist/index.js",
-    "./*": "./*",
-    "./dist/runtime/*": "./dist/runtime/*.mjs"
+    ".": "./dist/module.mjs",
+    "./*": "./*"
   },
-  "main": "./dist/index.js",
-  "types": "./dist/index.d.ts",
+  "main": "./dist/module.cjs",
+  "types": "./dist/module.d.ts",
   "files": [
     "dist"
   ],
   "scripts": {
-    "build": "siroc build",
-    "dev": "nuxt playground",
+    "build": "nuxt build-module",
+    "dev:prepare": "nuxt-module-build --stub && nuxi prepare playground",
+    "dev": "nuxt dev playground",
+    "dev:build": "nuxt build playground",
     "lint": "eslint --ext .ts .",
-    "prepublishOnly": "yarn build",
-    "release": "yarn test && standard-version && npm publish && git push --follow-tags",
-    "test": "yarn lint"
+    "release": "pnpm test && standard-version && npm publish && git push --follow-tags",
+    "test": "pnpm lint"
   },
   "dependencies": {
+    "@nuxt/kit": "^3.0.0",
     "defu": "^6.1.1",
+    "pathe": "^1.0.0",
     "ufo": "^1.0.0",
     "web-vitals": "^3.1.0"
   },
   "devDependencies": {
-    "@nuxt/types": "latest",
-    "@nuxtjs/eslint-config-typescript": "latest",
-    "babel-eslint": "latest",
-    "eslint": "latest",
-    "nuxt-edge": "latest",
-    "nuxt-swc": "latest",
-    "siroc": "latest",
-    "standard-version": "latest",
-    "typescript": "latest"
+    "@nuxt/module-builder": "^0.2.1",
+    "@nuxtjs/eslint-config-typescript": "^12.0.0",
+    "eslint": "^8.28.0",
+    "nuxt": "^3.0.0",
+    "standard-version": "^9.5.0",
+    "typescript": "^4.9.3"
   }
 }

playground/layouts/default.vue playground-nuxt2/layouts/default.vue

@@ -0,0 +1,11 @@
+export default {
+  buildModules: [
+    require('..')
+  ],
+  webVitals: {
+    debug: true
+  }
+  // googleAnalytics: {
+  //   id: 'hello'
+  // }
+}

playground-nuxt2/nuxt.config.ts

@@ -0,0 +1,10 @@
+{
+  "private": true,
+  "scripts": {
+    "dev": "nuxt dev",
+    "build": "nuxt build"
+  },
+  "devDependencies": {
+    "nuxt": "^2.15.8"
+  }
+}

playground-nuxt2/package.json

@@ -0,0 +1,8 @@
+<template>
+  <div>
+    <h1>About page</h1>
+    <NuxtLink to="/">
+      Home
+    </NuxtLink>
+  </div>
+</template>

playground-nuxt2/pages/about.vue

@@ -0,0 +1,8 @@
+<template>
+  <div>
+    <h1>Nuxt Vitals</h1>
+    <NuxtLink to="/about">
+      About page
+    </NuxtLink>
+  </div>
+</template>