microsoft / vscode-cmake-tools

CMake integration in Visual Studio Code
https://marketplace.visualstudio.com/items?itemName=vector-of-bool.cmake-tools
MIT License
1.46k stars 450 forks source link

Please remove your `debugger;` statements in production builds #4056

Open paulober opened 1 week ago

paulober commented 1 week ago

Brief Issue Summary

Currently the released main.js in the cmake-tools extension includes serveral debugger; statements like in line 11006, 110061, 97194, 97223, 97311 and some more. Since CMake-tools already floods the dev console, these debugger statements only add to the frustration, making it even more difficult to debug your own extensions when the extension is installed and enabled. Especially when working with virtual workspaces, it's all too common to get stuck in your own source code.

CMake Tools Diagnostics

<ERROR>

Debug Log

<ERROR>

Additional Information

An excerpt from the dev console:

console.ts:137 [Extension Host] [CMakeTools] 2024-09-10T16:46:08.694Z [info] [proc] Executing command: "C:\Program Files\Microsoft Visual Studio\2022\Community\Common7\IDE\CommonExtensions\Microsoft\CMake\CMake\bin\cmake.exe" --version (at console.<anonymous> (c:\Users\MyUser\AppData\Local\Programs\Microsoft VS Code\resources\app\out\vs\workbench\api\node\extensionHostProcess.js:151:47754))
console.ts:137 [Extension Host] [CMakeTools] 2024-09-10T16:46:08.825Z [info] [proc] Executing command: "C:\Program Files\Microsoft Visual Studio\2022\Community\Common7\IDE\CommonExtensions\Microsoft\CMake\CMake\bin\cmake.exe" -E capabilities (at console.<anonymous> (c:\Users\MyUser\AppData\Local\Programs\Microsoft VS Code\resources\app\out\vs\workbench\api\node\extensionHostProcess.js:151:47754))
console.ts:137 [Extension Host] [CMakeTools] 2024-09-10T16:46:08.955Z [debug] [main] Safe constructing new CMakeProject instance (at console.<anonymous> (c:\Users\MyUser\AppData\Local\Programs\Microsoft VS Code\resources\app\out\vs\workbench\api\node\extensionHostProcess.js:151:47754))
console.ts:137 [Extension Host] [CMakeTools] 2024-09-10T16:46:08.956Z [debug] [variant] Constructing VariantManager (at console.<anonymous> (c:\Users\MyUser\AppData\Local\Programs\Microsoft VS Code\resources\app\out\vs\workbench\api\node\extensionHostProcess.js:151:47754))
console.ts:137 [Extension Host] [CMakeTools] 2024-09-10T16:46:08.957Z [debug] [main] Constructing new CMakeProject instance (at console.<anonymous> (c:\Users\MyUser\AppData\Local\Programs\Microsoft VS Code\resources\app\out\vs\workbench\api\node\extensionHostProcess.js:151:47754))
console.ts:137 [Extension Host] [CMakeTools] 2024-09-10T16:46:08.958Z [debug] [main] Starting CMake Tools second-phase init (at console.<anonymous> (c:\Users\MyUser\AppData\Local\Programs\Microsoft VS Code\resources\app\out\vs\workbench\api\node\extensionHostProcess.js:151:47754))
console.ts:137 [Extension Host] [CMakeTools] 2024-09-10T16:46:08.959Z [debug] [expand] expanded ${workspaceFolder} (at console.<anonymous> (c:\Users\MyUser\AppData\Local\Programs\Microsoft VS Code\resources\app\out\vs\workbench\api\node\extensionHostProcess.js:151:47754))
console.ts:137 [Extension Host] [CMakeTools] 2024-09-10T16:46:08.982Z [debug] [kit] Reading kits file C:\Users\MyUser\AppData\Local\CMakeTools\cmake-tools-kits.json (at console.<anonymous> (c:\Users\MyUser\AppData\Local\Programs\Microsoft VS Code\resources\app\out\vs\workbench\api\node\extensionHostProcess.js:151:47754))
console.ts:137 [Extension Host] [CMakeTools] 2024-09-10T16:46:09.057Z [info] [kit] Successfully loaded 0 kits from C:\Users\MyUser\AppData\Local\CMakeTools\cmake-tools-kits.json (at console.<anonymous> (c:\Users\MyUser\AppData\Local\Programs\Microsoft VS Code\resources\app\out\vs\workbench\api\node\extensionHostProcess.js:151:47754))
console.ts:137 [Extension Host] [CMakeTools] 2024-09-10T16:46:09.209Z [debug] [kit] Not reading non-existent kits file: c:\Users\MyUser\PicoDevTest\sdgsdfg\.vscode\cmake-kits.json (at console.<anonymous> (c:\Users\MyUser\AppData\Local\Programs\Microsoft VS Code\resources\app\out\vs\workbench\api\node\extensionHostProcess.js:151:47754))
console.ts:137 [Extension Host] [CMakeTools] 2024-09-10T16:46:09.238Z [info] [variant] Loaded new set of variants (at console.<anonymous> (c:\Users\MyUser\AppData\Local\Programs\Microsoft VS Code\resources\app\out\vs\workbench\api\node\extensionHostProcess.js:151:47754))
console.ts:137 [Extension Host] [CMakeTools] 2024-09-10T16:46:09.239Z [debug] [main] CMakeProject instance initialization complete. (at console.<anonymous> (c:\Users\MyUser\AppData\Local\Programs\Microsoft VS Code\resources\app\out\vs\workbench\api\node\extensionHostProcess.js:151:47754))
console.ts:137 [Extension Host] [CMakeTools] 2024-09-10T16:46:09.240Z [debug] [main] Safe constructing new CMakeProject instance (at console.<anonymous> (c:\Users\MyUser\AppData\Local\Programs\Microsoft VS Code\resources\app\out\vs\workbench\api\node\extensionHostProcess.js:151:47754))
console.ts:137 [Extension Host] [CMakeTools] 2024-09-10T16:46:09.241Z [debug] [variant] Constructing VariantManager (at console.<anonymous> (c:\Users\MyUser\AppData\Local\Programs\Microsoft VS Code\resources\app\out\vs\workbench\api\node\extensionHostProcess.js:151:47754))
console.ts:137 [Extension Host] [CMakeTools] 2024-09-10T16:46:09.242Z [debug] [main] Constructing new CMakeProject instance (at console.<anonymous> (c:\Users\MyUser\AppData\Local\Programs\Microsoft VS Code\resources\app\out\vs\workbench\api\node\extensionHostProcess.js:151:47754))
console.ts:137 [Extension Host] [CMakeTools] 2024-09-10T16:46:09.243Z [debug] [main] Starting CMake Tools second-phase init (at console.<anonymous> (c:\Users\MyUser\AppData\Local\Programs\Microsoft VS Code\resources\app\out\vs\workbench\api\node\extensionHostProcess.js:151:47754))
console.ts:137 [Extension Host] [CMakeTools] 2024-09-10T16:46:09.245Z [warning] [expand] Invalid variable reference ${workspaceFolder} in string: ${workspaceFolder} (at console.<anonymous> (c:\Users\MyUser\AppData\Local\Programs\Microsoft VS Code\resources\app\out\vs\workbench\api\node\extensionHostProcess.js:151:47754))
C @ console.ts:137
console.ts:137 [Extension Host] [CMakeTools] 2024-09-10T16:46:09.246Z [debug] [expand] expanded ${workspaceFolder} (at console.<anonymous> (c:\Users\MyUser\AppData\Local\Programs\Microsoft VS Code\resources\app\out\vs\workbench\api\node\extensionHostProcess.js:151:47754))
log.ts:439   ERR [Extension Host] [CMakeTools] 2024-09-10T16:46:09.251Z [error] [rollbar] "sourceDirectory" is not a directory {"sourceDirectory":"${workspaceFolder}"}
console.ts:137 [Extension Host] [CMakeTools] 2024-09-10T16:46:09.251Z [error] [rollbar] "sourceDirectory" is not a directory {"sourceDirectory":"${workspaceFolder}"} (at console.<anonymous> (c:\Users\MyUser\AppData\Local\Programs\Microsoft VS Code\resources\app\out\vs\workbench\api\node\extensionHostProcess.js:151:47754))
C @ console.ts:137
console.ts:137 [Extension Host] [CMakeTools] 2024-09-10T16:46:24.820Z [debug] [main] Not starting CMake driver: no kit selected (at console.<anonymous> (c:\Users\MyUser\AppData\Local\Programs\Microsoft VS Code\resources\app\out\vs\workbench\api\node\extensionHostProcess.js:151:47754))
console.ts:137 [Extension Host] [CMakeTools] 2024-09-10T16:46:24.834Z [debug] [kit] Reading kits file C:\Users\MyUser\AppData\Local\CMakeTools\cmake-tools-kits.json (at console.<anonymous> (c:\Users\MyUser\AppData\Local\Programs\Microsoft VS Code\resources\app\out\vs\workbench\api\node\extensionHostProcess.js:151:47754))
console.ts:137 [Extension Host] [CMakeTools] 2024-09-10T16:46:24.864Z [info] [kit] Successfully loaded 0 kits from C:\Users\MyUser\AppData\Local\CMakeTools\cmake-tools-kits.json (at console.<anonymous> (c:\Users\MyUser\AppData\Local\Programs\Microsoft VS Code\resources\app\out\vs\workbench\api\node\extensionHostProcess.js:151:47754))
console.ts:137 [Extension Host] [CMakeTools] 2024-09-10T16:46:25.121Z [debug] [kit] Not reading non-existent kits file: \.vscode\cmake-kits.json (at console.<anonymous> (c:\Users\MyUser\AppData\Local\Programs\Microsoft VS Code\resources\app\out\vs\workbench\api\node\extensionHostProcess.js:151:47754))
console.ts:137 [Extension Host] [CMakeTools] 2024-09-10T16:46:25.122Z [debug] [expand] expanded ${workspaceFolder} (at console.<anonymous> (c:\Users\MyUser\AppData\Local\Programs\Microsoft VS Code\resources\app\out\vs\workbench\api\node\extensionHostProcess.js:151:47754))
log.ts:439   ERR [Extension Host] [CMakeTools] 2024-09-10T16:46:25.123Z [error] [rollbar] "sourceDirectory" is not a directory {"sourceDirectory":""}
console.ts:137 [Extension Host] [CMakeTools] 2024-09-10T16:46:25.123Z [error] [rollbar] "sourceDirectory" is not a directory {"sourceDirectory":""} (at console.<anonymous> (c:\Users\MyUser\AppData\Local\Programs\Microsoft VS Code\resources\app\out\vs\workbench\api\node\extensionHostProcess.js:151:47754))
C @ console.ts:137
console.ts:137 [Extension Host] [CMakeTools] 2024-09-10T16:46:26.317Z [info] [variant] Loaded new set of variants (at console.<anonymous> (c:\Users\MyUser\AppData\Local\Programs\Microsoft VS Code\resources\app\out\vs\workbench\api\node\extensionHostProcess.js:151:47754))
console.ts:137 [Extension Host] [CMakeTools] 2024-09-10T16:46:26.318Z [debug] [main] CMakeProject instance initialization complete. (at console.<anonymous> (c:\Users\MyUser\AppData\Local\Programs\Microsoft VS Code\resources\app\out\vs\workbench\api\node\extensionHostProcess.js:151:47754))
log.ts:439   ERR [Extension Host] [CMakeTools] 2024-09-10T16:46:26.373Z [fatal] [rollbar] Unhandled exception: Unhandled Promise rejection: Post-folder-open false [object Object]
console.ts:137 [Extension Host] [CMakeTools] 2024-09-10T16:46:26.373Z [fatal] [rollbar] Unhandled exception: Unhandled Promise rejection: Post-folder-open false [object Object] (at console.<anonymous> (c:\Users\MyUser\AppData\Local\Programs\Microsoft VS Code\resources\app\out\vs\workbench\api\node\extensionHostProcess.js:151:47754))
C @ console.ts:137
console.ts:137 [Extension Host] [CMakeTools] 2024-09-10T16:46:32.313Z [debug] [main] Not starting CMake driver: no kit selected (at console.<anonymous> (c:\Users\MyUser\AppData\Local\Programs\Microsoft VS Code\resources\app\out\vs\workbench\api\node\extensionHostProcess.js:151:47754))
gcampbell-msft commented 1 week ago

@paulober You can control how much logging comes from our extension by setting the cmake.loggingLevel to info and maybe of these will not be sent.