@vingy/vuebugger 0.3.0 → 0.3.3

package/README.md

@@ -0,0 +1,48 @@
+# Vuebugger
+
+Vue devtools provide an easy way to inspect component state. But when having something like a composable, you actually need to catch all the returned values in order for them to show up in the devtools. This is where this package can come in handy.
+
+## Features
+
+- Debug composables and reactive state easily
+- Tree-shakable with zero runtime overhead
+- Simple API: just call `debug(name, state)`
+
+## Quick start
+
+```bash
+pnpm add -D @vingy/vuebugger
+```
+
+Register the plugin in your app:
+
+```ts
+import Vuebugger from '@vingy/vuebugger'
+
+createApp(App).use(Vuebugger)
+```
+
+## Usage
+
+`debug()` registers values from composables so they show up in Vue Devtools.
+
+```ts
+import { debug } from '@vingy/vuebugger'
+
+export const useFoo = (initial: number) => {
+  const multiplier = ref(1) // not easy to debug if something goes wrong
+
+  const inc = () => multiplier.value++
+  const dec = () => multiplier.value--
+
+  const value = computed(() => initial * multiplier)
+
+  debug('useFoo', { multiplier }) // now visible in devtools
+
+  return { value, inc, dec }
+}
+```
+
+See the demo app in [demo/](../../demo/).
+
+> **Note:** This plugin is tree-shakable and has zero runtime overhead when `debug()` calls are not used.

package/dist/index.d.mts

@@ -27,6 +27,6 @@ type PluginOptions = {
 declare const debug: <T extends Record<string, any>>(groupId: VuebuggerEntry["groupId"], state: T) => T;
 //#endregion
 //#region src/index.d.ts
-declare const plugin$1: Plugin<PluginOptions | undefined>;
+declare const plugin$1: Plugin<[PluginOptions?]>;
 //#endregion
 export { plugin$1 as DebugPlugin, plugin$1 as default, debug };

package/dist/index.mjs

@@ -63,7 +63,7 @@ const debug = (groupId, state) => {
 };
 
 //#endregion
-//#region ../../node_modules/.pnpm/@vue+devtools-shared@8.0.5/node_modules/@vue/devtools-shared/dist/index.js
+//#region ../../node_modules/.pnpm/@vue+devtools-shared@8.0.6/node_modules/@vue/devtools-shared/dist/index.js
 var __create$1 = Object.create;
 var __defProp$1 = Object.defineProperty;
 var __getOwnPropDesc$1 = Object.getOwnPropertyDescriptor;
@@ -496,7 +496,7 @@ function createHooks() {
 }
 
 //#endregion
-//#region ../../node_modules/.pnpm/@vue+devtools-kit@8.0.5/node_modules/@vue/devtools-kit/dist/index.js
+//#region ../../node_modules/.pnpm/@vue+devtools-kit@8.0.6/node_modules/@vue/devtools-kit/dist/index.js
 var __create = Object.create;
 var __defProp = Object.defineProperty;
 var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
@@ -3954,7 +3954,6 @@ const plugin = { install: (app, options) => {
 	if (options?.uidFn) setUidGenerator(options.uidFn);
 	setupComposableDevtools(app);
 } };
-var src_default = plugin;
 
 //#endregion
-export { plugin as DebugPlugin, debug, src_default as default };
+export { plugin as DebugPlugin, plugin as default, debug };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vingy/vuebugger",
-  "version": "0.3.0",
+  "version": "0.3.3",
   "description": "Vue devtools plugin to debug anything.",
   "keywords": [
     "composable",
@@ -15,7 +15,7 @@
   "author": "vingy",
   "repository": {
     "type": "git",
-    "url": "https://github.com/vinpogo/vuebugger"
+    "url": "https://github.com/vinpogo/vue-utils"
   },
   "files": [
     "dist"
@@ -40,8 +40,6 @@
     "vue": "^3.5.0"
   },
   "scripts": {
-    "test": "vitest",
-    "test:ci": "vitest run --coverage",
     "build": "tsdown",
     "dev": "tsdown -w"
   }