-
Notifications
You must be signed in to change notification settings - Fork 0
Add Tarantool debugging facilities #26
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR adds basic Tarantool debugging support via EmmyLuaDebugger.
- Introduces
insertDebuggerCodeinsrc/utils.tsto inject a Lua snippet for debugging. - Registers a new VS Code command
tarantool.debugger-codeand updatespackage.json. - Updates documentation and changelog to describe debugger usage.
Reviewed Changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| src/utils.ts | Implements insertDebuggerCode and debugger snippet |
| src/extension.ts | Registers the tarantool.debugger-code command |
| package.json | Declares the new debugger insertion command |
| README.md | Adds debugger usage instructions |
| CHANGELOG.md | Logs added support for EmmyLua-based debugging |
Comments suppressed due to low confidence (5)
README.md:59
- [nitpick] Fix the grammar here. For example, replace 'It is employs' with 'It employs' to improve readability.
Tarantool VS Code extension provides debugger facility for developing Tarantool applications. It is employs EmmyLuaDebugger that is a stop-the-world Lua debugger.
README.md:34
- This line was removed but the initialization command may still be available. If so, restore or update this step to keep the usage instructions complete.
* Run `Tarantool: Initialize VS Code extension in existing app` command from the command palette (`Ctrl+Shift+P` or `Cmd+Shift+P` on macOS).
src/utils.ts:52
- The new
insertDebuggerCodefunction lacks any test coverage. Consider adding unit tests for its platform-specific path logic and snippet insertion behavior.
export async function insertDebuggerCode() {
src/utils.ts:36
- The global function
emmyHelperInit()is never defined. You should call the init method exposed by theemmy_coremodule (e.g.,dbg.init()or assigndbg.initto_G.emmyHelperInit) so the debugger actually starts.
_G.emmyHelperInit()
src/utils.ts:33
- [nitpick] This assignment of
_G.emmyHelperis duplicated and never used elsewhere. Consider removing it or clarifying its purpose to avoid global clutter.
rawset(_G, 'emmyHelper', {})
3dadb29 to
c4c3168
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
Copilot reviewed 11 out of 11 changed files in this pull request and generated 3 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This patch introduces basic Tarantool debugging facilities into the extension. Basically it is done using EmmyLuaDebugger [^1]. Set up the debugger using the following instructions. * Insert debugger code in Tarantool application by pressing `Ctrl+Shift+P` (or `Cmd+Shift+P` on MacOS) and running `Tarantool: Insert debugger code` command. * Start single Tarantool instance. * Press `F5` or run `Debug: Start debugging` command by pressing `Ctrl+Shift+P` (or `Cmd+Shift+P` on MacOS). * Choose `EmmyLua New Debugger` in the list. This debugging configuration would run automatically from now. * Set up breakpoints & access the Tarantool instance through `Debug console` in the bottom panel. These features are supported. * Breakpoints. * Step-by-step execution within the fiber. * Multiple files support. * Interacting with the local variables, console at the debug mode. Needs EmmyLua/EmmyLuaDebugger#75 to be tested on MacOS on arm64. Closes #19 [^1] EmmyLua/EmmyLuaDebugger#75
c4c3168 to
ca353d3
Compare
This patch introduces basic Tarantool debugging facilities into the
extension. Basically it is done using EmmyLuaDebugger [^1].
Set up the debugger using the following instructions.
Ctrl+Shift+P(orCmd+Shift+Pon MacOS) and runningTarantool: Insert debugger codecommand.F5or runDebug: Start debuggingcommand by pressingCtrl+Shift+P(orCmd+Shift+Pon MacOS).EmmyLua New Debuggerin the list. This debuggingconfiguration would run automatically from now.
Debug consolein the bottom panel.These features are supported.
Needs EmmyLua/EmmyLuaDebugger#75 to be tested
on MacOS on arm64.
Closes #19
[^1] EmmyLua/EmmyLuaDebugger#75