# view source

example/web.ts

export {}
//!? 'hello world'
const someVar = 123
//!warn 'warning', someVar
//!time 'time'
//!timeEnd 'time'
console.log('sink', someVar)
//!> alert('hello')

# debugEnvName – Environment name. Default: ROLLUP_DEBUG

src/rollup-plugin-debug.ts#L26

string

# debugMatcher – Debug matcher (overrides Env variable)

src/rollup-plugin-debug.ts#L24

string

# exclude – Exclude patterns.

src/rollup-plugin-debug.ts#L22

null | string | RegExp | string | RegExp []

# include – Include patterns.

src/rollup-plugin-debug.ts#L20

null | string | RegExp | string | RegExp []

# printId – Whether to print colored label ids. Default: true

src/rollup-plugin-debug.ts#L30

boolean

# removeIfUnmatched – Whether to erase the comment completely when not matched. Default: false

src/rollup-plugin-debug.ts#L32

boolean

# removeParts – Parts of the label namespace to remove. Default: ['lib', 'src', 'dist', 'esm', 'cjs']

src/rollup-plugin-debug.ts#L34

string []

# runtimeDebug – Enable runtime localStorage.DEBUG='<regexp>'

src/rollup-plugin-debug.ts#L28

boolean

# replacer(payload, kind, id, color) – Custom replacer function.
src/rollup-plugin-debug.ts#L36
# payload

string

# kind

DebugKind

# id

string

# color

string

replacer(payload, kind, id, color)  =>

string

keyof Console | "literal" | "?" | ">"

Enables the following:

//!? 'foo', bar
//!warn 'xyz'
//!time 'bench'
//!> if (x) { ... }

// is compiled to:

console.log('foo', bar)
console.warn('xyz')
console.time('bench')
if (x) { ... }

Along with colored label ids namespaced to the package name + filename (excluding specific common parts like src or lib or dist, configurable).

To enable a namespace, or all it is using the same pattern matching as the debug package:

ROLLUP_DEBUG='some-module:*,other:*,-notthis*' npm run build

Will enable the logs just for these modules. The main difference from the debug package, aside from being compile time rather than runtime, is that in DevTools you get the proper file/line link as the call sites of console.* are in the right place, instead of being one module deep, which would point you to debug.js which was not helpful.

default(options)  =>

Plugin