vite-plugin-qrcode 0.3.0 → 0.4.1

package/README.md

@@ -15,9 +15,9 @@ npm install --save-dev vite-plugin-qrcode
 import { qrcode } from 'vite-plugin-qrcode';
 
 export default defineConfig({
-	plugins: [
-		qrcode() // only applies in dev mode
-	]
+  plugins: [
+    qrcode() // only applies in dev mode
+  ]
 });
 ```
 
@@ -41,7 +41,7 @@ Example:
 import { qrcode } from 'vite-plugin-qrcode';
 
 export default defineConfig({
-	plugins: [qrcode({ filter: (url) => url === 'http://192.168.1.1:4173' })]
+  plugins: [qrcode({ filter: (url) => url === 'http://192.168.1.1:4173' })]
 });
 ```
 

package/package.json

@@ -1,26 +1,22 @@
 {
   "name": "vite-plugin-qrcode",
   "description": "Show QR code on server start",
-  "version": "0.3.0",
+  "version": "0.4.1",
   "license": "MIT",
   "author": "bluwy",
   "type": "module",
-  "main": "dist/index.cjs",
-  "module": "dist/index.js",
-  "types": "dist/index.d.ts",
+  "types": "types/index.d.ts",
   "exports": {
     ".": {
-      "import": "./dist/index.js",
-      "require": "./dist/index.cjs"
+      "types": "./types/index.d.ts",
+      "default": "./src/index.js"
     },
     "./package.json": "./package.json"
   },
   "files": [
-    "dist"
+    "src",
+    "types"
   ],
-  "engines": {
-    "node": "^14.13.1 || ^16.0.0 || >=18"
-  },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/svitejs/vite-plugin-qrcode.git",
@@ -37,19 +33,19 @@
   },
   "homepage": "https://github.com/svitejs/vite-plugin-qrcode#readme",
   "dependencies": {
-    "qrcode-terminal": "^0.12.0"
+    "uqr": "^0.1.2"
   },
   "peerDependencies": {
-    "vite": "^3.0.0 || ^4.0.0 || ^5.0.0 || ^6.0.0 || ^7.0.0"
+    "vite": ">=3"
   },
   "devDependencies": {
-    "@types/qrcode-terminal": "^0.12.2",
-    "uvu": "^0.5.6",
-    "vite": "^6.0.0"
+    "vite": "^8.0.2",
+    "vitest": "^4.1.1"
   },
   "scripts": {
-    "dev": "tsup-node --sourcemap --watch src",
-    "build": "tsup-node --dts",
-    "test": "tsm node_modules/uvu/bin.js tests"
+    "check:publint": "publint --strict",
+    "check:types": "tsc --noEmit",
+    "generate:types": "dts-buddy -m \"vite-plugin-qrcode:src/public.d.ts\"",
+    "test": "vitest"
   }
 }

package/src/index.js

@@ -0,0 +1,68 @@
+import { renderUnicodeCompact } from 'uqr';
+
+/**
+ *
+ * @param {Partial<import('./public.d.ts').PluginOptions>} [options]
+ * @returns {import('vite').Plugin} vite-plugin-qrcode
+ */
+export function qrcode(options = {}) {
+	/** @type {import('vite').Plugin} */
+	const plugin = {
+		name: 'vite-plugin-qrcode',
+		apply: 'serve',
+		configureServer(server) {
+			const _listen = server.listen;
+			server.listen = function () {
+				const isRestart = arguments[1] === true;
+				if (!isRestart) {
+					server.httpServer?.on('listening', () => {
+						setTimeout(() => logQrcode(server, options), 0);
+					});
+				}
+				// @ts-expect-error arguments
+				return _listen.apply(this, arguments);
+			};
+		},
+		configurePreviewServer(server) {
+			server.httpServer?.on('listening', () => {
+				setTimeout(() => logQrcode(server, options), 0);
+			});
+		}
+	};
+	return plugin;
+}
+
+/**
+ *
+ * @param {import('vite').ViteDevServer | import('vite').PreviewServer } server
+ * @param {import('./public.d.ts').PluginOptions} options
+ */
+function logQrcode(server, options) {
+	let networkUrls = server.resolvedUrls?.network;
+
+	if (!networkUrls) return;
+
+	if (options.filter) {
+		networkUrls = networkUrls.filter(options.filter);
+	}
+
+	if (networkUrls.length === 0) return;
+
+	const info = server.config.logger.info;
+
+	info('\n  Visit page on mobile:');
+
+	for (const url of networkUrls) {
+		const qr = renderUnicodeCompact(url);
+		info(`  ${cyan(url)}\n  ${qr.replace(/\n/g, '\n  ')}`);
+	}
+}
+
+/**
+ *
+ * @param {string} str
+ * @returns {string}
+ */
+function cyan(str) {
+	return `\x1b[36m${str}\x1b[0m`;
+}

package/src/public.d.ts

@@ -0,0 +1,18 @@
+export interface PluginOptions {
+	/**
+	 * filter list of shown QR codes. Useful if you have multiple interfaces and only need one
+	 *
+	 *  examples:
+	 *    url => url.startsWith('http://192.')
+	 *    url => !url.startsWith('http://172.)
+	 *    url => url === 'http://192.168.1.70:4173'
+	 *
+	 * @param url {string} ip address
+	 * @returns {boolean}
+	 */
+
+	filter?: (url: string) => boolean;
+}
+
+// eslint-disable-next-line n/no-missing-import
+export * from './index.js';

package/types/index.d.ts

@@ -0,0 +1,25 @@
+declare module 'vite-plugin-qrcode' {
+	export interface PluginOptions {
+		/**
+		 * filter list of shown QR codes. Useful if you have multiple interfaces and only need one
+		 *
+		 *  examples:
+		 *    url => url.startsWith('http://192.')
+		 *    url => !url.startsWith('http://172.)
+		 *    url => url === 'http://192.168.1.70:4173'
+		 *
+		 * @param url ip address
+		 * */
+
+		filter?: (url: string) => boolean;
+	}
+	/**
+	 *
+	 * @returns vite-plugin-qrcode
+	 */
+	export function qrcode(options?: Partial<PluginOptions>): import("vite").Plugin;
+
+	export {};
+}
+
+//# sourceMappingURL=index.d.ts.map

package/types/index.d.ts.map

@@ -0,0 +1,18 @@
+{
+	"version": 3,
+	"file": "index.d.ts",
+	"names": [
+		"PluginOptions",
+		"qrcode"
+	],
+	"sources": [
+		"../src/public.d.ts",
+		"../src/index.js"
+	],
+	"sourcesContent": [
+		null,
+		null
+	],
+	"mappings": ";kBAAiBA,aAAaA;;;;;;;;;;;;;;;;;;iBCOdC,MAAMA",
+	"ignoreList": []
+}

package/dist/index.cjs

@@ -1,89 +0,0 @@
-"use strict";
-var __create = Object.create;
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __getProtoOf = Object.getPrototypeOf;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
-  // If the importer is in node compatibility mode or this is not an ESM
-  // file that has been converted to a CommonJS file using a Babel-
-  // compatible transform (i.e. "__esModule" has not been set), then set
-  // "default" to the CommonJS "module.exports" for node compatibility.
-  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
-  mod
-));
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-
-// src/index.ts
-var src_exports = {};
-__export(src_exports, {
-  qrcode: () => qrcode
-});
-module.exports = __toCommonJS(src_exports);
-var import_qrcode_terminal = __toESM(require("qrcode-terminal"), 1);
-function qrcode(options = {}) {
-  return {
-    name: "vite-plugin-qrcode",
-    apply: "serve",
-    configureServer(server) {
-      const _listen = server.listen;
-      server.listen = function() {
-        var _a;
-        const isRestart = arguments[1] === true;
-        if (!isRestart) {
-          (_a = server.httpServer) == null ? void 0 : _a.on("listening", () => {
-            setTimeout(() => logQrcode(server, options), 0);
-          });
-        }
-        return _listen.apply(this, arguments);
-      };
-    },
-    configurePreviewServer(server) {
-      var _a;
-      if ("resolvedUrls" in server) {
-        (_a = server.httpServer) == null ? void 0 : _a.on("listening", () => {
-          setTimeout(() => logQrcode(server, options), 0);
-        });
-      }
-    }
-  };
-}
-function logQrcode(server, options) {
-  var _a;
-  let networkUrls = (_a = server.resolvedUrls) == null ? void 0 : _a.network;
-  if (!networkUrls)
-    return;
-  if (options.filter) {
-    networkUrls = networkUrls.filter(options.filter);
-  }
-  if (networkUrls.length === 0)
-    return;
-  const info = server.config.logger.info;
-  info("\n  Visit page on mobile:");
-  for (const url of networkUrls) {
-    import_qrcode_terminal.default.generate(url, { small: true }, (result) => {
-      info(`  ${cyan(url)}
-  ${result.replace(/\n/g, "\n  ")}`);
-    });
-  }
-}
-function cyan(str) {
-  return `\x1B[36m${str}\x1B[0m`;
-}
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  qrcode
-});

package/dist/index.d.cts

@@ -1,19 +0,0 @@
-import { Plugin } from 'vite';
-
-declare function qrcode(options?: PluginOptions): Plugin;
-interface PluginOptions {
-    /**
-     * filter list of shown QR codes. Useful if you have multiple interfaces and only need one
-     *
-     *  examples:
-     *    url => url.startsWith('http://192.')
-     *    url => !url.startsWith('http://172.)
-     *    url => url === 'http://192.168.1.70:4173'
-     *
-     * @param url {string} ip address
-     * @returns {boolean}
-     */
-    filter?: (url: string) => boolean;
-}
-
-export { type PluginOptions, qrcode };

package/dist/index.d.ts

@@ -1,19 +0,0 @@
-import { Plugin } from 'vite';
-
-declare function qrcode(options?: PluginOptions): Plugin;
-interface PluginOptions {
-    /**
-     * filter list of shown QR codes. Useful if you have multiple interfaces and only need one
-     *
-     *  examples:
-     *    url => url.startsWith('http://192.')
-     *    url => !url.startsWith('http://172.)
-     *    url => url === 'http://192.168.1.70:4173'
-     *
-     * @param url {string} ip address
-     * @returns {boolean}
-     */
-    filter?: (url: string) => boolean;
-}
-
-export { type PluginOptions, qrcode };

package/dist/index.js

@@ -1,54 +0,0 @@
-// src/index.ts
-import qr from "qrcode-terminal";
-function qrcode(options = {}) {
-  return {
-    name: "vite-plugin-qrcode",
-    apply: "serve",
-    configureServer(server) {
-      const _listen = server.listen;
-      server.listen = function() {
-        var _a;
-        const isRestart = arguments[1] === true;
-        if (!isRestart) {
-          (_a = server.httpServer) == null ? void 0 : _a.on("listening", () => {
-            setTimeout(() => logQrcode(server, options), 0);
-          });
-        }
-        return _listen.apply(this, arguments);
-      };
-    },
-    configurePreviewServer(server) {
-      var _a;
-      if ("resolvedUrls" in server) {
-        (_a = server.httpServer) == null ? void 0 : _a.on("listening", () => {
-          setTimeout(() => logQrcode(server, options), 0);
-        });
-      }
-    }
-  };
-}
-function logQrcode(server, options) {
-  var _a;
-  let networkUrls = (_a = server.resolvedUrls) == null ? void 0 : _a.network;
-  if (!networkUrls)
-    return;
-  if (options.filter) {
-    networkUrls = networkUrls.filter(options.filter);
-  }
-  if (networkUrls.length === 0)
-    return;
-  const info = server.config.logger.info;
-  info("\n  Visit page on mobile:");
-  for (const url of networkUrls) {
-    qr.generate(url, { small: true }, (result) => {
-      info(`  ${cyan(url)}
-  ${result.replace(/\n/g, "\n  ")}`);
-    });
-  }
-}
-function cyan(str) {
-  return `\x1B[36m${str}\x1B[0m`;
-}
-export {
-  qrcode
-};