feat: disable toggleComboKey option (#46)

Author: webfansplz

README.md

@@ -122,8 +122,9 @@ interface VitePluginInspectorOptions {
   * examples: control-shift, control-o, control-alt-s  meta-x control-meta
   * Some keys have native behavior (e.g. alt-s opens history menu on firefox).
   * To avoid conflicts or accidentally typing into inputs, modifier only combinations are recommended.
+  * You can also disable it by setting `false`.
   */
-  toggleComboKey?: string
+  toggleComboKey?: string | false
 
   /**
   * Toggle button visibility

package.json

@@ -15,7 +15,7 @@
     "play:vue3": "pnpm run -r --filter=./packages/playground/vue3 dev",
     "play:vue2": "pnpm run -r --filter=./packages/playground/vue2 dev",
     "lint": "eslint --fix --ext .js,.ts,.vue .",
-    "stub": "pnpm run -r --filter=./packages/core stub",
+    "dev": "pnpm run -r --filter=./packages/core dev",
     "build": "pnpm run -r --filter=./packages/{core,unplugin} build",
     "release": "pnpm build && changeset && changeset version && changeset publish"
   },
@@ -28,7 +28,6 @@
     "tsup": "^5.12.1",
     "tsx": "^3.12.2",
     "typescript": "^4.9.4",
-    "unbuild": "^1.1.1",
     "vite": "^4.0.3",
     "vue": "^3.2.45"
   },

packages/core/package.json

@@ -38,7 +38,7 @@
   ],
   "scripts": {
     "lint": "eslint --fix --ext .js,.ts,.vue .",
-    "stub": "unbuild",
+    "dev": "tsup --watch",
     "build": "tsup"
   },
   "peerDependencies": {
@@ -58,15 +58,5 @@
   "devDependencies": {
     "@types/babel__core": "^7.1.20",
     "unplugin": "^1.0.1"
-  },
-  "unbuild": {
-    "entries": [
-      "./src/index"
-    ],
-    "clean": true,
-    "declaration": true,
-    "rollup": {
-      "emitCJS": true
-    }
   }
 }

packages/core/src/Overlay.vue

@@ -18,7 +18,7 @@ export default {
       containerRef: null,
       floatsRef: null,
       enabled: inspectorOptions.enabled,
-      toggleCombo: inspectorOptions.toggleComboKey?.toLowerCase().split('-'),
+      toggleCombo: inspectorOptions.toggleComboKey?.toLowerCase?.()?.split?.('-') ?? false,
       overlayVisible: false,
       position: {
         x: 0,

packages/core/src/index.ts

@@ -47,8 +47,9 @@ export interface VitePluginInspectorOptions {
   * examples: control-shift, control-o, control-alt-s  meta-x control-meta
   * Some keys have native behavior (e.g. alt-s opens history menu on firefox).
   * To avoid conflicts or accidentally typing into inputs, modifier only combinations are recommended.
+  * You can also disable it by setting `false`.
   */
-  toggleComboKey?: string
+  toggleComboKey?: string | false
 
   /**
   * Toggle button visibility
@@ -149,13 +150,13 @@ function VitePluginInspector(options: VitePluginInspectorOptions = DEFAULT_INSPE
     },
     configureServer(server) {
       const _printUrls = server.printUrls
+      const { toggleComboKey } = normalizedOptions
 
-      server.printUrls = () => {
-        const { toggleComboKey } = normalizedOptions
+      toggleComboKey && (server.printUrls = () => {
         const keys = normalizeComboKeyPrint(toggleComboKey)
         _printUrls()
         console.log(`  ${green('➜')}  ${bold('Vue Inspector')}: ${green(`Press ${yellow(keys)} in App to toggle the Inspector`)}\n`)
-      }
+      })
     },
     transformIndexHtml(html) {
       if (normalizedOptions.appendTo)

packages/unplugin/src/nuxt.ts

@@ -13,10 +13,10 @@ export default (options: Options, nuxt: any) => {
   })
   let printed = false
   nuxt.hook('vite:serverCreated', () => {
-    if (printed)
-      return
     const normalizedOptions = { ...DEFAULT_INSPECTOR_OPTIONS, ...options }
     const { toggleComboKey } = normalizedOptions
+    if (printed || !toggleComboKey)
+      return
     const keys = normalizeComboKeyPrint(toggleComboKey)
     console.log(`  ${'> Vue Inspector'}: ${green(`Press ${yellow(keys)} in App to toggle the Inspector`)}\n`)
     printed = true