Add Tarantool debugging facilities#26
Merged
georgiy-belyanin merged 1 commit intomainfrom Nov 18, 2025
Merged
Conversation
There was a problem hiding this comment.
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.
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 file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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