ReviewOS

bughq/sdk

public
Clone

Push over the same URL. A password will not work: create a token under access tokens and use it in place of one.

Star 0 Watch 0

bughq error-tracking SDKs — core, Vue, Nuxt, Stacks/stx

main
· 35 commits

Mirrored from bughq/sdk · synced 11 minutes ago

5a72128 chore: release v0.3.0 Chris Breuer 19 days ago History
README.md

bughq SDKs

Official JavaScript / TypeScript SDKs for bughq error tracking. Add error tracking to any app in one line, with framework-aware capture (Vue component errors, Nuxt SSR, Stacks server errors) on top of window error + unhandled-rejection handling.

Packages

PackageForInstall
@bughq/sdkAny JS/TS app (core)bun add @bughq/sdk
@bughq/vueVue 3bun add @bughq/vue
@bughq/nuxtNuxt 3/4bun add @bughq/nuxt
@bughq/stxStacks / stx (client + server)bun add @bughq/stx

Quick start

import { bughq } from '@bughq/sdk'

bughq.init({
  project: 'acme-web-9f2c1a',
  key: 'your-public-ingest-key', // safe to ship: a revocable identifier, not a secret
  release: '1.4.0',
  environment: 'production',
})

Vue:

import BugHQ from '@bughq/vue'
app.use(BugHQ, { project: 'acme-web', key: 'pk_...' })

Nuxt:

export default defineNuxtConfig({
  modules: ['@bughq/nuxt'],
  bughq: { project: 'acme-web', key: 'pk_...' },
})

You can also pass a single dsn: 'https://<key>@<host>/<project>'. See each package's README for details.

Develop

bun install
bun run build     # builds all packages (sdk first)
bun test          # runs all package tests

Release

bun run publish:packages   # builds, then publishes each package to npm

CI publishes on a v* tag (needs an NPM_TOKEN secret). See .github/workflows.

License

MIT