Skip to content

Commit

Permalink
chore: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
sssooonnnggg committed Nov 21, 2024
1 parent 3c9c68c commit d8a7eb3
Show file tree
Hide file tree
Showing 3 changed files with 121 additions and 97 deletions.
30 changes: 27 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,31 @@ A debugger for Luau with debug adapter protocol(DAP) support.
- `cmake --build --preset <build preset>`
- Or use other IDE such as VSCode or Visual Studio

## TODO
## Usage

- Install `luau-debugger` extension
- Open lua folders in VSCode
- Add a launch configuration in `launch.json`
```json
{
"configurations": [
{
"type": "luau",
"request": "attach",
"name": "attach to luau debugger",
"address": "localhost",
"port": 58000
}
]
}
```
- Using `luaud` to execute lua script with debug support
```bash
luaud 58000 <script>
```
- Press `F5` to start debugging

## Features

- [ ] Debugger features
- [x] Attach
Expand Down Expand Up @@ -58,8 +82,8 @@ A debugger for Luau with debug adapter protocol(DAP) support.
- [ ] userdata
- [ ] Set variables
- [x] Repl
- [ ] Watch
- [ ] Hover
- [x] Watch
- [x] Hover
- [x] Single step
- [x] Step in
- [x] Step over
Expand Down
Binary file modified extensions/vscode/images/logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
188 changes: 94 additions & 94 deletions extensions/vscode/package.json
Original file line number Diff line number Diff line change
@@ -1,101 +1,101 @@
{
"name": "luau-debugger",
"displayName": "A Luau Debugger",
"version": "0.0.1",
"publisher": "sssooonnnggg",
"description": "A Luau debugger",
"author": {
"name": "sssooonnnggg"
},
"license": "MIT",
"keywords": [
"luau",
"debugger"
"name": "luau-debugger",
"displayName": "A Luau Debugger",
"version": "0.0.1",
"publisher": "sssooonnnggg",
"description": "A Luau debugger",
"author": {
"name": "sssooonnnggg"
},
"license": "MIT",
"keywords": [
"luau",
"debugger"
],
"engines": {
"vscode": "^1.89.0"
},
"icon": "images/logo.png",
"categories": [
"Debuggers"
],
"repository": {
"type": "git",
"url": "https://github.com/sssooonnnggg/luau-debugger"
},
"bugs": {
"url": "https://github.com/sssooonnnggg/luau-debugger/issues"
},
"activationEvents": [
"onDebug"
],
"contributes": {
"breakpoints": [
{
"language": "lua"
}
],
"engines": {
"vscode": "^1.89.0"
},
"icon": "images/logo.png",
"categories": [
"Debuggers"
],
"repository": {
"type": "git",
"url": "https://github.com/Microsoft/vscode-mock-debug.git"
},
"bugs": {
"url": "https://github.com/Microsoft/vscode-mock-debug/issues"
},
"activationEvents": [
"onDebug"
],
"contributes": {
"breakpoints": [
{
"language": "lua"
"debuggers": [
{
"type": "luau",
"languages": [
"lua"
],
"label": "Luau Debug",
"configurationAttributes": {
"attach": {
"properties": {
"address": {
"type": "string",
"description": "IP address of the Luau debugger to connect to"
},
"port": {
"type": "number",
"description": "Port of the Luau debugger to connect to"
}
}
}
},
"initialConfigurations": [
{
"type": "luau",
"request": "attach",
"name": "attach to luau debugger",
"address": "localhost",
"port": 58000
}
],
"debuggers": [
{
"type": "luau",
"languages": [
"lua"
],
"label": "Luau Debug",
"configurationAttributes": {
"attach": {
"properties": {
"address": {
"type": "string",
"description": "IP address of the Luau debugger to connect to"
},
"port": {
"type": "number",
"description": "Port of the Luau debugger to connect to"
}
}
}
},
"initialConfigurations": [
{
"type": "luau",
"request": "attach",
"name": "attach to luau debugger",
"address": "localhost",
"port": 58000
}
],
"configurationSnippets": [
{
"label": "Luau Debug",
"description": "Configuration for debugging a Luau program",
"body": {
"type": "luau",
"request": "attach",
"name": "attach to luau debugger",
"address": "localhost",
"port": 58000
}
}
]
"configurationSnippets": [
{
"label": "Luau Debug",
"description": "Configuration for debugging a Luau program",
"body": {
"type": "luau",
"request": "attach",
"name": "attach to luau debugger",
"address": "localhost",
"port": 58000
}
}
]
},
"scripts": {
"vscode:prepublish": "npm run compile",
"compile": "tsc -p ./",
"watch": "tsc -watch -p ./"
},
"devDependencies": {
"@types/node": "^17.0.21",
"@types/vscode": "1.89.0",
"@vscode/vsce": "2.26.1",
"eslint": "^8.11.0",
"typescript": "^4.0.2"
},
"dependencies": {
"@vscode/debugadapter": "^1.61.0",
"@vscode/debugprotocol": "^1.61.0"
},
"main": "./out/extension.js"
}
]
},
"scripts": {
"vscode:prepublish": "npm run compile",
"compile": "tsc -p ./",
"watch": "tsc -watch -p ./"
},
"devDependencies": {
"@types/node": "^17.0.21",
"@types/vscode": "1.89.0",
"@vscode/vsce": "2.26.1",
"eslint": "^8.11.0",
"typescript": "^4.0.2"
},
"dependencies": {
"@vscode/debugadapter": "^1.61.0",
"@vscode/debugprotocol": "^1.61.0"
},
"main": "./out/extension.js"
}

0 comments on commit d8a7eb3

Please sign in to comment.