Debug

Debug package usage guide. Use when adding debug logging, understanding log namespaces, or implementing debugging features. Triggers on debug logging requests or logging implementation.

mahabdalla Updated

File contents

Debug Package Usage Guide

Basic Usage

import debug from 'debug';

// Format: lobe-[module]:[submodule]
const log = debug('lobe-server:market');

log('Simple message');
log('With variable: %O', object);
log('Formatted number: %d', number);

Namespace Conventions

  • Desktop: lobe-desktop:[module]
  • Server: lobe-server:[module]
  • Client: lobe-client:[module]
  • Router: lobe-[type]-router:[module]

Format Specifiers

  • %O - Object expanded (recommended for complex objects)
  • %o - Object
  • %s - String
  • %d - Number

Enable Debug Output

Browser

localStorage.debug = 'lobe-*';

Node.js

DEBUG=lobe-* npm run dev
DEBUG=lobe-* pnpm dev

Electron

process.env.DEBUG = 'lobe-*';

Example

// src/server/routers/edge/market/index.ts
import debug from 'debug';

const log = debug('lobe-edge-router:market');

log('getAgent input: %O', input);

Converted and distributed by TomeVault | Claim this content

mahabdalla/skills-registry/tree/main/lobehub--lobehub--debug commit 3af6c09859

Frequently asked questions

npx skillmds@latest add mahabdalla/debug