From c0660674fbdaad25b69ffbd52233ea187bb6037a Mon Sep 17 00:00:00 2001 From: Jarred Sumner Date: Tue, 7 Oct 2025 20:08:57 -0700 Subject: [PATCH] Fix outdated doc --- .cursor/rules/building-bun.mdc | 2 +- CONTRIBUTING.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.cursor/rules/building-bun.mdc b/.cursor/rules/building-bun.mdc index 0a5fa27f2c..2fef59b551 100644 --- a/.cursor/rules/building-bun.mdc +++ b/.cursor/rules/building-bun.mdc @@ -30,7 +30,7 @@ bun bd <...args> Debug logs look like this: ```zig -const log = bun.Output.scoped(.${SCOPE}, false); +const log = bun.Output.scoped(.${SCOPE}, .hidden); // ...later log("MY DEBUG LOG", .{}) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c39fd4463a..b5ff50b2d4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -149,7 +149,7 @@ Bun generally takes about 2.5 minutes to compile a debug build when there are Zi - Batch up your changes - Ensure zls is running with incremental watching for LSP errors (if you use VSCode and install Zig and run `bun run build` once to download Zig, this should just work) - Prefer using the debugger ("CodeLLDB" in VSCode) to step through the code. -- Use debug logs. `BUN_DEBUG_=1` will enable debug logging for the corresponding `Output.scoped(., false)` logs. You can also set `BUN_DEBUG_QUIET_LOGS=1` to disable all debug logging that isn't explicitly enabled. To dump debug lgos into a file, `BUN_DEBUG=.log`. Debug logs are aggressively removed in release builds. +- Use debug logs. `BUN_DEBUG_=1` will enable debug logging for the corresponding `Output.scoped(., .hidden)` logs. You can also set `BUN_DEBUG_QUIET_LOGS=1` to disable all debug logging that isn't explicitly enabled. To dump debug lgos into a file, `BUN_DEBUG=.log`. Debug logs are aggressively removed in release builds. - src/js/\*\*.ts changes are pretty much instant to rebuild. C++ changes are a bit slower, but still much faster than the Zig code (Zig is one compilation unit, C++ is many). ## Code generation scripts