@vue-scan/nuxt

@vue-scan/nuxt is the Nuxt module for enabling Vue Scan in Nuxt applications. It wires the client plugin for you and forwards the module options into runtimeConfig.public.vueScan.

Install

bun add -D @vue-scan/nuxt @vue-scan/scan

Usage

Add the module to your Nuxt config:

export default defineNuxtConfig({
  modules: ['@vue-scan/nuxt'],
  vueScan: {
    enabled: true,
    allowProduction: false,
    logging: false,
    toolbar: {
      enabled: true,
      showFps: true,
    },
  },
});

The module only boots on the client and stays disabled in production unless you explicitly set allowProduction: true.

Options

{
  enabled: true,
  allowProduction: false,
  logging: false,
  toolbar: {
    enabled: true,
    showFps: true,
  },
}

Legacy aliases are still accepted:

• dangerouslyForceRunInProduction
• log
• showToolbar
• showFPS

Related Packages

• @vue-scan/scan provides the core runtime used by this module
• @vue-scan/vite-plugin-vue-scan is the Vite integration for non-Nuxt projects

Repository Docs

• Project workflow, release flow, and hotfix policy: https://github.com/ivan-cavero/vue-scan#git-flow
• Full installation and integration guide: https://github.com/ivan-cavero/vue-scan