package
Structured diagnostic code library
npm install nosticsGitHub-flavored package documentation.
Across all versions.
Download trend unavailable.
Runtime metadata.
Estimated unpacked size across 1 packages.
94.9 kB
Includes dependencies.
Errors worth reading.
nostics helps you replace ad hoc error strings with stable diagnostic codes, actionable fixes, source locations, and docs links.
[NUXT_B2011] Plugin `./runtime/analytics.server.ts` is server-only but was registered with mode `client`.
├▶ fix: Rename the file or register it with mode `server`.
├▶ sources: modules/analytics.ts:18:5
╰▶ see: https://nuxt.com/e/b2011pnpm add nosticsimport { createConsoleReporter, defineDiagnostics } from 'nostics'
export const diagnostics = defineDiagnostics({
docsBase: (code) => `https://nuxt.com/e/${code.replace('NUXT_', '').toLowerCase()}`,
reporters: [createConsoleReporter()],
codes: {
NUXT_B2011: {
why: (p: { src: string; mode: 'client' | 'server' }) => {
const expected = p.mode === 'client' ? 'server' : 'client'
return `Plugin "${p
Use the generated handles where the problem happens:
const plugin = resolvePlugin()
const source = locatePluginCall(plugin)
const config = loadNuxtConfig()
diagnostics.NUXT_B2011({
src: plugin.src,
mode: plugin.mode,
sources: [source],
})
throw diagnostics.NUXT_B5001({
configPath: config.filepath,
value: config.compatibilityDate,
example: '2024-04-03',
})Calling a handle reports the diagnostic and returns a Diagnostic. Throwing the return value raises it. The params are inferred from your why and fix functions.
Install the plugin to give Claude skills for your diagnostic catalog:
claude plugin add https://github.com/vercel-labs/nosticsClaude will automatically pick up the nostics API reference and an add-diagnostic skill that finds the right catalog, chooses the next free code, and wires the call site.
Prefer just the skills, without the plugin? Install them with npx skills into any supported agent (Claude Code, Codex, Cursor, opencode, and more):
npx skills add vercel-labs/nosticsDiagnostic instances that extend Error.The structured shape also makes diagnostics easier for tools and coding agents to read, without making that the main workflow.
Build-time plugins live in the separate @nostics/unplugin package:
pnpm add -D @nostics/unpluginFor library builds, use the strip plugin:
import { nosticsStrip } from '@nostics/unplugin/strip-transform'
export default defineConfig({
plugins: [nosticsStrip.vite()],
})For browser diagnostics during Vite dev, use createDevReporter() in the browser and nosticsCollector in the consuming app:
import { nosticsCollector } from '@nostics/unplugin/dev-server-collector'
export default defineConfig({
plugins: [nosticsCollector.vite()],
})See the docs site for the guide, production build notes, dev collector setup, and API reference.
posva
posva13@gmail.com