next-dev-qr 1.1.0

package/LICENSE

@@ -0,0 +1,7 @@
+Copyright [2026] [Raunak]
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, so subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,71 @@
+# next-dev-qr
+
+A lightweight, **zero-config** utility to generate a QR code in your terminal when starting the Next.js development server. Perfect for instant mobile testing without manually typing local IP addresses.
+
+Built for modern Next.js (14, 15+), supporting both **Webpack** and **Turbopack**.
+
+## Features
+
+* **🚀 Zero Friction:** Scan and open your dev site on mobile instantly.
+* **🛠 Turbopack Ready:** Uses the Next.js `instrumentation` hook to work with the latest compilers.
+* **🌐 Smart IP Detection:** Automatically finds your local network IP.
+* **🧹 Dev-Only:** Automatically disables itself in production environments to keep logs clean.
+
+## Installation
+
+```bash
+npm install next-dev-qr
+# or
+pnpm add next-dev-qr
+# or
+yarn add next-dev-qr
+```
+
+## Usage
+
+Next.js 14.1+ supports an `instrumentation` file that runs code when the server starts. This is the recommended way to use `next-dev-qr`.
+
+### 1. Enable Instrumentation
+Ensure your `next.config.js` allows the instrumentation hook (this is default in Next.js 15).
+
+```javascript
+/** @type {import('next').NextConfig} */
+const nextConfig = {
+  experimental: {
+    instrumentationHook: true,
+  },
+}
+
+module.exports = nextConfig
+```
+
+### 2. Create the Hook
+Create an `instrumentation.ts` (or `.js`) file in your **root directory** (or inside `/src` if you use it).
+
+```typescript
+export async function register() {
+  if (process.env.NEXT_RUNTIME === 'nodejs') {
+    const { register: registerQR } = await import('next-dev-qr');
+    registerQR();
+  }
+}
+```
+
+### 3. Run
+Start your server as usual:
+
+```bash
+npm run dev
+```
+
+The QR code will appear in your terminal immediately after the server initializes.
+
+## Why not a Webpack Plugin?
+Traditional Next.js plugins modify the Webpack config. However, with the move toward **Turbopack (Rust-based compiler)**, Webpack plugins are being phased out. `next-dev-qr` uses the **Instrumentation API**, making it bundler-agnostic and future-proof.
+
+## Contributing
+This project aims to demonstrate the utility of QR-based mobile debugging for potential inclusion in Next.js core. Feel free to open issues or PRs.
+
+## License
+MIT
+

package/index.js

@@ -0,0 +1,27 @@
+const qrcode = require('qrcode-terminal');
+const ip = require('address');
+
+/**
+ * The register() function is called by Next.js during server initialization.
+ * This works with both Webpack and Turbopack.
+ */
+function register() {
+  // Only execute in development mode and on the server side
+  if (process.env.NODE_ENV === 'development' && typeof window === 'undefined') {
+    
+    // Check a global flag to prevent double-logging in some environments
+    if (!global.__NEXT_QR_LOGGED__) {
+      const port = process.env.PORT || 3000;
+      const localIp = ip.ip();
+      const url = `http://${localIp}:${port}`;
+
+      console.log('\n\x1b[35m%s\x1b[0m', '🚀 Next.js Mobile Access:');
+      qrcode.generate(url, { small: true });
+      console.log(`Network: ${url}\n`);
+
+      global.__NEXT_QR_LOGGED__ = true;
+    }
+  }
+}
+
+module.exports = { register };

package/package.json

@@ -0,0 +1,17 @@
+{
+"name": "next-dev-qr",
+  "version": "1.1.0",
+  "main": "index.js",
+  "description": "QR code generator for Next.js dev server (Turbopack compatible)",
+  "keywords": ["nextjs", "turbopack", "dx", "qrcode", "mobile-testing"],
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "author": "Raunak",
+  "license": "MIT",
+  "type": "commonjs",
+  "dependencies": {
+    "address": "^2.0.3",
+    "qrcode-terminal": "^0.12.0"
+  }
+}