npm.io
1.0.2 • Published 3 months ago

@mushi-mushi/svelte

Licence
MIT
Version
1.0.2
Deps
0
Vulns
0
Weekly
0
Stars
3

@mushi-mushi/svelte

Your AI wrote it. Mushi tells you why it broke.

Svelte SDK for Mushi Mushi bug reporting. API-only — captures errors and submits reports but does not include the widget UI. Add @mushi-mushi/web alongside this package for the full Shadow DOM widget experience.

One-command setup: npx mushi-mushi auto-detects Svelte / SvelteKit and installs this package + @mushi-mushi/web.

Other frameworks: @mushi-mushi/react · @mushi-mushi/vue · @mushi-mushi/angular · @mushi-mushi/react-native · @mushi-mushi/capacitor · @mushi-mushi/web (vanilla JS)

Install

npm install @mushi-mushi/svelte @mushi-mushi/web
# or: npx mushi-mushi

Environment variables

Stack Project ID API key
Vite / SvelteKit VITE_MUSHI_PROJECT_ID VITE_MUSHI_API_KEY

See Project ID & API keys.

Usage

import { initMushi, getMushi } from '@mushi-mushi/svelte'

initMushi({
  projectId: import.meta.env.VITE_MUSHI_PROJECT_ID,
  apiKey: import.meta.env.VITE_MUSHI_API_KEY,
})

const mushi = getMushi()
mushi.submitReport({ title: 'broken', description: '...' })
With widget UI
import { initMushi } from '@mushi-mushi/svelte'
import { Mushi } from '@mushi-mushi/web'

initMushi({
  projectId: import.meta.env.VITE_MUSHI_PROJECT_ID,
  apiKey: import.meta.env.VITE_MUSHI_API_KEY,
})

Mushi.init({
  projectId: import.meta.env.VITE_MUSHI_PROJECT_ID,
  apiKey: import.meta.env.VITE_MUSHI_API_KEY,
})
SvelteKit error handler
import { createMushiErrorHandler } from '@mushi-mushi/svelte'

export const handleError = createMushiErrorHandler()

API

Export Purpose
initMushi(config) Initialize once at app startup
getMushi() Access the SDK instance
createMushiErrorHandler() SvelteKit handleError integration

Peer dependencies

  • svelte >= 4

License

MIT

Keywords