vite-plugin-url-copy

vite-plugin-url-copy

⚡️ Auto copy the vite server URL & generate a QR code when dev or preview.

[!IMPORTANT] Recommended minimum vite version is v4.

Usage

Install

pnpm i -D vite-plugin-url-copy

Add plugin to your vite.config.ts

import ServerUrlCopy from 'vite-plugin-url-copy'

export default defineConfig({
  plugins: [ServerUrlCopy()],
  server: {
    host: true,
  },
  preview: {
    host: true,
  },
})

QR code is disabled by default and needs to be explicitly enabled

ServerUrlCopy({
  // QR code using network URL
  qrcode: {
    disabled: false
  }
})

Configuration

ServerUrlCopy({
  copy: {
    // 'local' | 'network', default 'local'
    mode: 'local',
    // Custom any string to copy when the server start, It will overwrite the server URL
    custom: '',
    // Disable Copy, default false
    disabled: false,
  },
  qrcode: {
    // Custom any string for the generate network QR code, It will overwrite the server URL
    custom: '',
    // Disable QRCode, default true
    disabled: true,
  },
  // Disable plugin, default false
  disabled: false,
  // Log config info, default false
  debug: false,
})

Network may need to enable host

// package.json
{
  "scripts": {
    "dev": "vite --host"
  }
}

// or vite.config.ts
export default defineConfig({
  plugins: [ServerUrlCopy()],
  server: {
    host: true,
  },
})

License

MIT License © 2023 XioDone