Merge pull request #214 from nuxt-modules/lh/maintain-module

misc: refresh project structure, fully migrate to pnpm, nuxt 4 enhancements, @nuxt/eslint integration, and more!

Author: lihbr

.eslintignore

@@ -3,106 +3,82 @@ name: ci
 on: push
 
 jobs:
-  prepare:
-    name: Prepare (${{ matrix.os}}, Node ${{ matrix.node }})
-    runs-on: ${{ matrix.os }}
-    strategy:
-      matrix:
-        os: [ubuntu-latest]
-        node: [16, 18, 20.7]
-
+  lint:
+    runs-on: ubuntu-latest
     steps:
-      - name: Set up Node
-        uses: actions/setup-node@v3
-        with:
-          node-version: ${{ matrix.node }}
+      - uses: actions/checkout@v4
 
-      - name: Checkout
-        uses: actions/checkout@master
-
-      - name: Cache node_modules and .nuxt
-        id: cache
-        uses: actions/cache@v3
+      - name: Set node
+        uses: actions/setup-node@v4
         with:
-          path: |
-            node_modules
-            playground/.nuxt
-          key: ${{ matrix.os }}-node-v${{ matrix.node }}-deps-${{ hashFiles(format('{0}{1}', github.workspace, '/package-lock.json')) }}
+          node-version: lts/*
+
+      - name: Install pnpm
+        uses: pnpm/action-setup@v4
 
       - name: Install dependencies
-        if: steps.cache.outputs.cache-hit != 'true'
-        run: npm ci
+        run: pnpm install
+
+      - name: Lint
+        run: pnpm lint
+
+  typecheck:
+    runs-on: ubuntu-latest
+    name: typecheck (node ${{ matrix.node }}, typescript ${{ matrix.typescript }})
 
-  suite:
-    needs: prepare
-    name: Suite (${{ matrix.os}}, Node ${{ matrix.node }})
-    runs-on: ${{ matrix.os }}
     strategy:
-      fail-fast: false
       matrix:
-        os: [ubuntu-latest]
-        node: [16, 18, 20.7]
+        node: [lts/*]
+        # Based on https://majors.nullvoxpopuli.com/q?minors=on&packages=typescript
+        typescript: ["5.4"]
+      fail-fast: false
 
     steps:
-      - name: Set up Node
-        uses: actions/setup-node@v3
-        with:
-          node-version: ${{ matrix.node }}
-
-      - name: Checkout
-        uses: actions/checkout@master
+      - uses: actions/checkout@v4
 
-      - name: Retrieve node_modules and .nuxt
-        uses: actions/cache@v3
+      - name: Set node ${{ matrix.node }}
+        uses: actions/setup-node@v4
         with:
-          path: |
-            node_modules
-            playground/.nuxt
-          key: ${{ matrix.os }}-node-v${{ matrix.node }}-deps-${{ hashFiles(format('{0}{1}', github.workspace, '/package-lock.json')) }}
+          node-version: ${{ matrix.node }}
 
-      - name: Lint
-        run: npm run lint
+      - name: Install pnpm
+        uses: pnpm/action-setup@v4
 
-      - name: Unit
-        run: npm run unit
+      - name: Install dependencies
+        run: pnpm install
 
-      - name: Build
-        run: npm run build
+      - name: Set typescript ${{ matrix.typescript }}
+        run: pnpm add --workspace-root --save-dev typescript@${{ matrix.typescript }} && npx tsc --version
 
-      - name: Coverage
-        if: matrix.os == 'ubuntu-latest' && matrix.node == 20.7
-        uses: codecov/codecov-action@v3
+      - name: Typecheck
+        run: pnpm typecheck
 
-  types:
-    needs: prepare
-    name: Types (${{ matrix.os}}, Node ${{ matrix.node }}, TS ${{ matrix.typescript }})
+  test:
     runs-on: ${{ matrix.os }}
+    name: test (os ${{ matrix.os }}, node ${{ matrix.node }})
+
     strategy:
-      fail-fast: false
       matrix:
-        os: [ubuntu-latest]
-        node: [18]
-        typescript: ["5.0", "5.1"]
+        os: [ubuntu-latest, windows-latest, macos-latest]
+        node: [18, 20, lts/*]
+      fail-fast: false
 
     steps:
-      - name: Set up Node
-        uses: actions/setup-node@v3
+      - uses: actions/checkout@v4
+
+      - name: Set node ${{ matrix.node }}
+        uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node }}
 
-      - name: Checkout
-        uses: actions/checkout@master
+      - name: Install pnpm
+        uses: pnpm/action-setup@v4
 
-      - name: Retrieve node_modules and .nuxt
-        uses: actions/cache@v3
-        with:
-          path: |
-            node_modules
-            playground/.nuxt
-          key: ${{ matrix.os }}-node-v${{ matrix.node }}-deps-${{ hashFiles(format('{0}{1}', github.workspace, '/package-lock.json')) }}
+      - name: Install dependencies
+        run: pnpm install
 
-      - name: Overwrite TypeScript
-        run: npm install --no-save typescript@${{ matrix.typescript }} && npx tsc --version
+      - name: Unit
+        run: pnpm unit
 
-      - name: Types
-        run: npm run types
+      - name: Build
+        run: pnpm build

.eslintrc

@@ -1,40 +1,56 @@
-# custom
-dist
-.nuxt
-.output
-sw.*
+# Dependencies
+node_modules
 
-# os
-.DS_Store
-._*
+# Logs
+*.log*
 
-# node
-logs
-*.log
-node_modules
+# Temp directories
+.temp
+.tmp
+.cache
 
-# yarn
-yarn-debug.log*
-yarn-error.log*
-lerna-debug.log*
-.yarn-integrity
-yarn.lock
+# Yarn
+**/.yarn/cache
+**/.yarn/*state*
 
-# npm
-npm-debug.log*
+# Generated dirs
+dist
 
-# tests
-coverage
-.eslintcache
-.nyc_output
+# Nuxt
+.nuxt
+.output
+.data
+.vercel_build_output
+.build-*
+.netlify
 
-# .env
+# Env
 .env
-.env.test
-.env*.local
 
-# vscode
+# Testing
+reports
+coverage
+*.lcov
+.nyc_output
+
+# VSCode
 .vscode/*
+!.vscode/settings.json
 !.vscode/tasks.json
 !.vscode/launch.json
-*.code-workspace
+!.vscode/extensions.json
+!.vscode/*.code-snippets
+
+# Intellij idea
+*.iml
+.idea
+
+# OSX
+.DS_Store
+.AppleDouble
+.LSOverride
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk

.github/workflows/ci.yml

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

.gitignore

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021 Nuxt.js Community
+Copyright (c) 2024 Nuxt.js Community
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

.npmrc

@@ -2,7 +2,7 @@
 
 Replace all on all files (README.md, CONTRIBUTING.md, bug_report.md, package.json):
 - @nuxtjs/prismic
-- Easily connect your Nuxt 3 application to your content hosted on Prismic
+- Easily connect your Nuxt application to your content hosted on Prismic
 - nuxt-modules/prismic
 - prismic
 
@@ -91,15 +91,15 @@ Whether you're helping us fix bugs, improve the docs, or spread the word, we'd l
 
 <!-- Badges -->
 
-[npm-version-src]: https://img.shields.io/npm/v/@nuxtjs/prismic/latest.svg
+[npm-version-src]: https://img.shields.io/npm/v/@nuxtjs/prismic/latest.svg?style=flat&colorA=020420&colorB=00DC82
 [npm-version-href]: https://npmjs.com/package/@nuxtjs/prismic
-[npm-downloads-src]: https://img.shields.io/npm/dm/@nuxtjs/prismic.svg
+[npm-downloads-src]: https://img.shields.io/npm/dm/@nuxtjs/prismic.svg?style=flat&colorA=020420&colorB=00DC82
 [npm-downloads-href]: https://npmjs.com/package/@nuxtjs/prismic
-[github-actions-ci-src]: https://github.com/nuxt-modules/prismic/workflows/ci/badge.svg
+[github-actions-ci-src]: https://img.shields.io/github/actions/workflow/status/nuxt-modules/prismic/ci.yml.svg?style=flat&colorA=020420&colorB=00DC82
 [github-actions-ci-href]: https://github.com/nuxt-modules/prismic/actions?query=workflow%3Aci
-[codecov-src]: https://img.shields.io/codecov/c/github/nuxt-modules/prismic.svg
+[codecov-src]: https://img.shields.io/codecov/c/github/nuxt-modules/prismic.svg?style=flat&colorA=020420&colorB=00DC82
 [codecov-href]: https://codecov.io/gh/nuxt-modules/prismic
-[conventional-commits-src]: https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg
+[conventional-commits-src]: https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg?style=flat&colorA=020420&colorB=00DC82
 [conventional-commits-href]: https://conventionalcommits.org
-[license-src]: https://img.shields.io/npm/l/@nuxtjs/prismic.svg
+[license-src]: https://img.shields.io/npm/l/@nuxtjs/prismic.svg?style=flat&colorA=020420&colorB=00DC82
 [license-href]: https://npmjs.com/package/@nuxtjs/prismic

LICENSE

@@ -1,6 +1,9 @@
 <template>
 	<NuxtLayout>
-		<NuxtPage v-if="rpcClient" :rpc="rpcClient" />
+		<NuxtPage
+			v-if="rpcClient"
+			:rpc="rpcClient"
+		/>
 	</NuxtLayout>
 </template>
 
@@ -12,7 +15,7 @@ import {
 	SliceMachineStatus,
 	type RPCClientType,
 	type ISlicemachineClientFunctions,
-	type ISlicemachineServerFunctions
+	type ISlicemachineServerFunctions,
 } from '../src/devtools/types'
 
 const sliceMachineStatus = useSliceMachineStatus()
@@ -23,10 +26,10 @@ onDevtoolsClientConnected((client) => {
 	rpcClient.value = client.devtools.extendClientRpc<ISlicemachineServerFunctions, ISlicemachineClientFunctions>(
 		RPC_NAMESPACE,
 		{
-			updateStatus (status) {
+			updateStatus(status) {
 				sliceMachineStatus.value.running = status === SliceMachineStatus.STARTED
-			}
-		}
+			},
+		},
 	)
 })
 </script>

README.md

@@ -13,6 +13,10 @@ const text = computed(() => {
 <template>
 	<NTip :n="running ? 'green' : 'yellow'">
 		{{ text }}
-		<a v-if="running" target="_blank" href="http://localhost:9999">http://localhost:9999</a>
+		<a
+			v-if="running"
+			target="_blank"
+			href="http://localhost:9999"
+		>http://localhost:9999</a>
 	</NTip>
 </template>