@netlify/nuxt 0.0.0

package/README.md

@@ -0,0 +1,64 @@
+# Netlify 🤝 Nuxt
+
+[![npm version][npm-version-src]][npm-version-href] [![npm downloads][npm-downloads-src]][npm-downloads-href]
+[![License][license-src]][license-href] [![Nuxt][nuxt-src]][nuxt-href]
+
+`@netlify/nuxt` provides local emulation of the Netlify platform directly in `nuxt dev`
+
+## Features
+
+This repackages all the same features as `@netlify/vite-plugin`.
+[Check out its docs for details](../packages/vite-plugin/README.md).
+
+## Quick Setup
+
+Install the module to your Nuxt application with one command:
+
+```bash
+npx nuxi module add @netlify/nuxt
+```
+
+That's it! You now have local emulation of the full Netlify platform automatically in your nuxt dev server:
+
+```bash
+npx nuxt dev
+```
+
+## Contribution
+
+<details>
+  <summary>Local development</summary>
+
+```bash
+# Install dependencies
+npm install
+
+# Generate type stubs
+npm run dev:prepare
+
+# Develop with the playground
+npm run dev
+
+# Build the playground
+npm run dev:build
+
+# Run ESLint
+npm run lint
+
+# Run Vitest
+npm run test
+npm run test:watch
+```
+
+</details>
+
+<!-- Badges -->
+
+[npm-version-src]: https://img.shields.io/npm/v/@netlify/nuxt/latest.svg?style=flat&colorA=020420&colorB=00DC82
+[npm-version-href]: https://npmjs.com/package/@netlify/nuxt
+[npm-downloads-src]: https://img.shields.io/npm/dm/@netlify/nuxt.svg?style=flat&colorA=020420&colorB=00DC82
+[npm-downloads-href]: https://npm.chart.dev/@netlify/nuxt
+[license-src]: https://img.shields.io/npm/l/@netlify/nuxt.svg?style=flat&colorA=020420&colorB=00DC82
+[license-href]: https://npmjs.com/package/@netlify/nuxt
+[nuxt-src]: https://img.shields.io/badge/Nuxt-020420?logo=nuxt.js
+[nuxt-href]: https://nuxt.com

package/dist/module.d.mts

@@ -0,0 +1,8 @@
+import * as _nuxt_schema from '@nuxt/schema';
+import { Features } from '@netlify/dev';
+
+type NetlifyModuleOptions = Features;
+declare const _default: _nuxt_schema.NuxtModule<Features, Features, false>;
+
+export { _default as default };
+export type { NetlifyModuleOptions };

package/dist/module.json

@@ -0,0 +1,9 @@
+{
+  "name": "@netlify/nuxt",
+  "configKey": "netlify",
+  "version": "0.0.0",
+  "builder": {
+    "@nuxt/module-builder": "1.0.1",
+    "unbuild": "3.5.0"
+  }
+}

package/dist/module.mjs

@@ -0,0 +1,88 @@
+import process from 'node:process';
+import { defineNuxtModule } from '@nuxt/kit';
+import { NetlifyDev } from '@netlify/dev';
+import { netlifyCommand, fromWebResponse, netlifyBanner } from '@netlify/dev-utils';
+import { defineLazyEventHandler, fromNodeMiddleware } from 'h3';
+
+const createPrefixedLogger = (prefix, logger) => ({
+  log: (msg) => {
+    logger.log(`${prefix} ${msg ?? ""}`);
+  },
+  warn: (msg) => {
+    logger.warn(`${prefix} ${msg ?? ""}`);
+  },
+  error: (msg) => {
+    logger.error(`${prefix} ${msg ?? ""}`);
+  }
+});
+const module = defineNuxtModule({
+  meta: {
+    name: "@netlify/nuxt",
+    configKey: "netlify"
+  },
+  defaults: {},
+  async setup(options, nuxt) {
+    if (process.env.NETLIFY_DEV) {
+      return;
+    }
+    if (!(nuxt.options.dev || nuxt.options.test)) {
+      return;
+    }
+    const logger = createPrefixedLogger(netlifyBanner, console);
+    const { blobs, edgeFunctions, functions, redirects } = options;
+    let netlifyDev;
+    nuxt.hook("nitro:init", async (nitro) => {
+      netlifyDev = new NetlifyDev({
+        blobs,
+        edgeFunctions,
+        functions,
+        logger,
+        redirects,
+        projectRoot: nuxt.options.rootDir,
+        staticFiles: {
+          ...options.staticFiles,
+          directories: nitro.options.publicAssets.map((d) => d.dir)
+        }
+      });
+      await netlifyDev.start();
+      nuxt.hook("close", () => {
+        netlifyDev.stop();
+      });
+      if (!netlifyDev.siteIsLinked) {
+        logger.log(
+          `\u{1F4AD} Linking this project to a Netlify site lets you deploy your site, use any environment variables defined on your team and site and much more. Run ${netlifyCommand("npx netlify init")} to get started.`
+        );
+      }
+      logger.log("Environment loaded");
+    });
+    nuxt.options.nitro.devHandlers ??= [];
+    nuxt.options.nitro.devHandlers.push({
+      handler: defineLazyEventHandler(() => {
+        logger.log(`Middleware loaded. Emulating features: ${netlifyDev.getEnabledFeatures().join(", ")}.`);
+        return fromNodeMiddleware(async function netlifyPreMiddleware(nodeReq, nodeRes, next) {
+          if (!netlifyDev) {
+            return;
+          }
+          const headers = {};
+          const result = await netlifyDev.handleAndIntrospectNodeRequest(nodeReq, {
+            headersCollector: (key, value) => {
+              headers[key] = value;
+            },
+            serverAddress: `http://localhost:${nodeReq.socket.localPort}`
+          });
+          const isStaticFile = result?.type === "static";
+          if (result && !isStaticFile) {
+            fromWebResponse(result.response, nodeRes);
+            return;
+          }
+          for (const key in headers) {
+            nodeRes.setHeader(key, headers[key] ?? "");
+          }
+          next();
+        });
+      })
+    });
+  }
+});
+
+export { module as default };

package/dist/types.d.mts

@@ -0,0 +1,9 @@
+import type { NuxtModule } from '@nuxt/schema'
+
+import type { default as Module } from './module.mjs'
+
+export type ModuleOptions = typeof Module extends NuxtModule<infer O> ? Partial<O> : Record<string, any>
+
+export { default } from './module.mjs'
+
+export { type NetlifyModuleOptions } from './module.mjs'

package/package.json

@@ -0,0 +1,73 @@
+{
+  "name": "@netlify/nuxt",
+  "version": "0.0.0",
+  "description": "Nuxt module providing local emulation of the Netlify environment",
+  "type": "module",
+  "engines": {
+    "node": "^20.6.1 || >=22"
+  },
+  "main": "./dist/module.mjs",
+  "typesVersions": {
+    "*": {
+      ".": [
+        "./dist/types.d.mts"
+      ]
+    }
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/types.d.mts",
+      "import": "./dist/module.mjs"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "nuxt-module-build prepare && nuxt-module-build build",
+    "dev": "npm run dev:prepare && nuxi dev playground",
+    "dev:build": "nuxi build playground",
+    "dev:prepare": "nuxt-module-build build --stub && nuxt-module-build prepare && nuxi prepare playground",
+    "lint": "eslint .",
+    "prepack": "npm run build",
+    "publint": "npx -y publint --strict",
+    "test": "vitest run",
+    "//": "Workaround to run this package's eslint in CI",
+    "test:ci": "npm run lint && npm run test:types && npm run test",
+    "test:dev": "vitest",
+    "test:types": "vue-tsc --noEmit && cd playground && vue-tsc --noEmit",
+    "test:watch": "vitest watch"
+  },
+  "keywords": [
+    "netlify",
+    "nuxt",
+    "nuxt-module",
+    "dev"
+  ],
+  "license": "MIT",
+  "repository": "netlify/primitives",
+  "bugs": {
+    "url": "https://github.com/netlify/primitives/issues"
+  },
+  "author": "Netlify Inc.",
+  "dependencies": {
+    "@netlify/dev": "^4.3.8",
+    "@netlify/dev-utils": "^3.2.2",
+    "@nuxt/kit": "^3.17.6",
+    "h3": "^1.15.3"
+  },
+  "devDependencies": {
+    "@nuxt/devtools": "^2.6.2",
+    "@nuxt/eslint-config": "^1.5.2",
+    "@nuxt/module-builder": "^1.0.1",
+    "@nuxt/schema": "^3.17.6",
+    "@nuxt/test-utils": "^3.19.2",
+    "@types/node": "latest",
+    "changelogen": "^0.6.2",
+    "eslint": "^9.30.1",
+    "nuxt": "^3.17.6",
+    "typescript": "~5.8.3",
+    "vitest": "^3.2.4",
+    "vue-tsc": "^3.0.1"
+  }
+}