obug

obug

A lightweight JavaScript debugging utility, forked from debug, featuring TypeScript and ESM support.

[!NOTE] obug v1 retains most of the compatibility with debug, but drops support for older browsers and Node.js, making it a drop-in replacement.

The upcoming v2 refactors some API imports and usage for better support of ESM and TypeScript, easier customization, and an even smaller package size.

Key Differences from debug

• ✨ Minimal footprint
• 📦 Zero dependencies
• 📝 Full TypeScript support
• 🚀 Native ESM compatibility
• 🌐 Optimized for modern runtimes
  • ES2015+ browsers
  • Node.js 20.19 and above

Installation

npm install obug

Usage

Please refer to the original debug package for usage instructions.

Refactor Plan

The obug package is currently a direct fork of the debug package with minimal modifications. The following refactor plan outlines the intended changes to be made in future releases.

import { createDebug, disable, enable, enabled, namespaces } from 'obug'

// Get the currently enabled namespaces
console.log(namespaces())

// createDebug has no extra properties or methods.
const debug = createDebug('my-namespace', {
  // All options are optional

  useColors: true, // false, true, 'auto'
  color: 2, // custom color
  // custom formatArgs
  formatArgs(args) {},
  formatters: {},
  // Node.js only
  inspectOpts: {},

  // custom log
  log: console.log,
})

debug('This is a debug message')
console.log(
  debug.namespace, // 'my-namespace'
  debug.enabled, // Check if enabled
  debug.useColors, // true
  debug.color, // 2
  debug.formatArgs, // custom formatArgs
  debug.formatters, // {}
  debug.inspectOpts, // {}
  debug.log, // implemented log function
)

// Create a sub-namespace, and it will inherit options from the parent debugger
const sub = debug.extend('sub-namespace')
sub('This is a sub-namespace debug message')
console.log(sub.namespace) // 'my-namespace:sub-namespace'

For more details, please refer to the src/types-v2.ts.

Original Authors

As obug is a fork of debug, we would like to acknowledge the original authors:

• TJ Holowaychuk
• Nathan Rajlich
• Andrew Rhyne
• Josh Junon

Sponsors

License

MIT License © 2025-PRESENT Kevin Deng

The MIT License Copyright (c) 2014-2017 TJ Holowaychuk <[e-mail]>

The MIT License Copyright (c) 2018-2021 Josh Junon