debug

Original🇺🇸 English
Translated

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

9installs
Added on

NPX Install

npx skill4agent add lobehub/lobehub debug

Debug Package Usage Guide

Basic Usage

typescript
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

javascript
localStorage.debug = 'lobe-*';

Node.js

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

Electron

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

Example

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

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

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