feat: add @netlify/nuxt Nuxt module (#344)

* feat: move req/res utils to @netlify/dev-utils

* build: add keywords to vite plugin package

* feat: add `@netlify/nuxt` Nuxt module

* refactor: remove useless directory?

* build: add a no-op build script

* fix: add missing deps and fix build steps

* fix: loosen nuxt module node reqs

* ci: add separate CI workflow to fix node version issue

The new package has a min. of node 20.19.0 whereas the others have 20.6.1.

The CI setup in this monorepo assumes it can run `npm run test` on all workspace packages against
the earliest supported version (20.6.1), which is assumed to be consistent.

I considered several approaches here, and this seemed like the lesser of evils. It just sets the
`test` script in this package to a no-op (npm workspaces have no option to run something against
"all workspaces packages except this one") and added a separate CI workflow for the new package.
This also avoids another weirdness while I was at it, since this package has its own lint and
typechecking.

* build: fix `test:types` nuxt module script

* test: add missing dependency to fixture

* chore(deps): remove unused dev dep

* fix(deps): specify a @types/node major

* chore: bump @netlify/nuxt version

I manually published 0.0.0 and 0.0.1 while testing

Author: serhalp

.github/workflows/nuxt-module.yaml

@@ -0,0 +1,49 @@
+name: Test @netlify/nuxt
+on:
+  push:
+    branches: [main]
+  pull_request:
+    types: [opened, synchronize, reopened]
+    branches:
+      - '**'
+      - '!release-please--**'
+  merge_group:
+jobs:
+  test:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macOS-latest, windows-latest]
+        node-version: ['*']
+        include:
+          - os: ubuntu-latest
+            node-version: '20.19.0'
+      fail-fast: false
+    steps:
+      - run: git config --global core.symlinks true
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node-version }}
+          cache: 'npm'
+      - name: Setup Deno
+        uses: denoland/setup-deno@v1
+        with:
+          deno-version: 2.2.4
+      - name: Setup Deno dependencies
+        run: deno cache https://deno.land/x/[email protected]/eszip.ts
+      - name: Install dependencies
+        run: npm ci
+      - name: Install playwright browsers
+        run: npx playwright install --with-deps chromium
+      - name: Build
+        run: npm run build --workspaces
+      - name: Lint
+        run: npm run lint -w ./packages/nuxt-module
+      - name: Typecheck
+        run: npm run test:types -w ./packages/nuxt-module
+      - name: Tests
+        run: npm run test:ci -w ./packages/nuxt-module

.github/workflows/release-please.yaml

@@ -78,6 +78,10 @@ jobs:
         if: ${{ steps.release.outputs['packages/images--release_created'] }}
         env:
           NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}
+      - run: npm publish packages/nuxt-module/ --provenance --access=public
+        if: ${{ steps.release.outputs['packages/nuxt-module--release_created'] }}
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}
       - run: npm publish packages/redirects/ --provenance --access=public
         if: ${{ steps.release.outputs['packages/redirects--release_created'] }}
         env:

.release-please-manifest.json

@@ -7,6 +7,7 @@
   "packages/functions": "4.1.10",
   "packages/headers": "2.0.4",
   "packages/images": "1.2.0",
+  "packages/nuxt-module": "0.0.1",
   "packages/otel": "3.1.0",
   "packages/redirects": "3.0.4",
   "packages/runtime": "4.0.8",

README.md

@@ -36,6 +36,7 @@ npm run dev
 | ⚡ [@netlify/functions](packages/functions)         | TypeScript utilities for interacting with Netlify Functions             | [![npm version](https://img.shields.io/npm/v/@netlify/functions.svg)](https://www.npmjs.com/package/@netlify/functions)         |
 | 📋 [@netlify/headers](packages/headers)             | TypeScript implementation of Netlify's headers engine                   | [![npm version](https://img.shields.io/npm/v/@netlify/headers.svg)](https://www.npmjs.com/package/@netlify/headers)             |
 | 🖼️ [@netlify/images](packages/images)               | TypeScript utilities for interacting with Netlify Image CDN             | [![npm version](https://img.shields.io/npm/v/@netlify/images.svg)](https://www.npmjs.com/package/@netlify/images)               |
+| 🚀 [@netlify/nuxt](packages/nuxt-module)            | Nuxt module with a local emulation of the Netlify environment           | [![npm version](https://img.shields.io/npm/v/@netlify/nuxt.svg)](https://www.npmjs.com/package/@netlify/nuxt)                   |
 | 🔍 [@netlify/otel](packages/otel)                   | TypeScript utilities to interact with Netlify's OpenTelemetry           | [![npm version](https://img.shields.io/npm/v/@netlify/otel.svg)](https://www.npmjs.com/package/@netlify/otel)                   |
 | 🔄 [@netlify/redirects](packages/redirects)         | TypeScript implementation of Netlify's rewrites and redirects engine    | [![npm version](https://img.shields.io/npm/v/@netlify/redirects.svg)](https://www.npmjs.com/package/@netlify/redirects)         |
 | 🏛️ [@netlify/runtime](packages/runtime)             | Netlify compute runtime                                                 | [![npm version](https://img.shields.io/npm/v/@netlify/runtime.svg)](https://www.npmjs.com/package/@netlify/runtime)             |

eslint.config.js

@@ -22,6 +22,10 @@ export default tseslint.config(
   // Global rules and configuration
   includeIgnoreFile(path.resolve(__dirname, '.gitignore')),
   ...packageIgnores,
+  {
+    // Uses its own eslint setup
+    ignores: ['packages/nuxt-module/'],
+  },
   {
     linterOptions: {
       reportUnusedDisableDirectives: true,

eslint_temporary_suppressions.js

@@ -649,15 +649,6 @@ export default [
       '@typescript-eslint/no-confusing-void-expression': 'off',
     },
   },
-  {
-    files: ['packages/vite-plugin/src/lib/reqres.ts'],
-    rules: {
-      '@typescript-eslint/restrict-template-expressions': 'off',
-      '@typescript-eslint/no-confusing-void-expression': 'off',
-      '@typescript-eslint/ban-ts-comment': 'off',
-      '@typescript-eslint/no-unnecessary-condition': 'off',
-    },
-  },
   {
     files: ['packages/vite-plugin/src/main.ts'],
     rules: {