Update program configuration settings

usenko-timur · usenko-timur · commit 2c4505f51668 · 2022-11-21T12:22:45.000Z
diff --git a/.github/workflows/bundle.yml b/.github/workflows/bundle.yml
@@ -28,5 +28,5 @@ jobs:
 
       - uses: actions/upload-artifact@v3
         with:
-          name: tarantool-local-lua-debugger-vscode
-          path: tarantool-local-lua-debugger-vscode-*.vsix
+          name: tarantool-lua-debugger-vscode
+          path: tarantool-lua-debugger-vscode-*.vsix
diff --git a/README.md b/README.md
@@ -18,53 +18,24 @@ Beginning in version 0.3.0, projects which use sourcemaps to debug code transpil
 ---
 ## Usage
 
-### Lua Stand-Alone Interpreter
-To debug a Lua program using a stand-alone interpreter, set `lua-local.interpreter` in your user or workspace settings:
-
-!["lua-local.interpreter": "lua5.1"](resources/settings.png '"lua-local.interpreter": "lua5.1"')
+### Tarantool Lua Stand-Alone Interpreter
+To debug a Lua program using a stand-alone interpreter, set `lua-tarantool.interpreter` in your user or workspace settings.
 
 Alternatively, you can set the interpreter and file to run in `launch.json`:
 ```json
 {
   "configurations": [
     {
-      "type": "lua-local",
+      "type": "lua-tarantool",
       "request": "launch",
       "name": "Debug",
       "program": {
-        "lua": "lua5.1",
-        "file": "main.lua"
+        "file": "init.lua"
       }
     }
   ]
 }
 ```
-
-### Custom Lua Environment
-To debug using a custom Lua executable, you must set up your `launch.json` with the name/path of the executable and any additional arguments that may be needed.
-```json
-{
-  "configurations": [
-    {
-      "type": "lua-local",
-      "request": "launch",
-      "name": "Debug Custom Executable",
-      "program": {
-        "command": "executable"
-      },
-      "args": [
-        "${workspaceFolder}"
-      ]
-    }
-  ]
-}
-```
-You must then manually start the debugger in your Lua code:
-```lua
-require("lldebugger").start()
-```
-Note that the path to `lldebugger` will automatically be appended to the `LUA_PATH` environment variable, so it can be found by Lua.
-
 ---
 ## Requirements & Limitations
 - The Lua environment must support communication via either stdio or pipes (named pipes on Windows, fifos on Linux).
diff --git a/extension/constants.ts b/extension/constants.ts
@@ -1 +1 @@
-export const EXTENSION_ID = "usenko-timur.tarantool-local-lua-debugger-vscode";
+export const EXTENSION_ID = "tarantool.tarantool-lua-debugger-vscode";
diff --git a/extension/extension.ts b/extension/extension.ts
@@ -25,10 +25,10 @@ import * as Net from "net";
 import * as path from "path";
 import {EXTENSION_ID} from "./constants";
 import {LuaDebugSession} from "./luaDebugSession";
-import {LaunchConfig, isCustomProgramConfig, LuaProgramConfig} from "./launchConfig";
+import {LaunchConfig, TarantoolProgramConfig} from "./launchConfig";
 
 const enableServer = true;
-const debuggerType = "lua-local";
+const debuggerType = "lua-tarantool";
 const interpreterSetting = `${debuggerType}.interpreter`;
 
 function abortLaunch(message: string) {
@@ -53,29 +53,30 @@ const configurationProvider: vscode.DebugConfigurationProvider = {
             config.type = debuggerType;
         }
 
-        if (typeof config.program === "undefined" || !isCustomProgramConfig(config.program)) {
-            const luaConfig: Partial<LuaProgramConfig> = config.program ?? {};
-            if (typeof luaConfig.lua === "undefined") {
-                const luaBin: string | undefined = vscode.workspace.getConfiguration().get(interpreterSetting);
-                if (typeof luaBin === "undefined" || luaBin.length === 0) {
-                    return abortLaunch(
-                        `You must set "${interpreterSetting}" in your settings, or "program.lua" `
-                        + "in your launch.json, to debug with a lua interpreter."
-                    );
-                }
-                luaConfig.lua = luaBin;
+        const luaConfig: Partial<TarantoolProgramConfig> = {
+            tarantool: config.program?.tarantool,
+            file: config.program?.file,
+        };
+        if (typeof luaConfig.tarantool === "undefined") {
+            const luaBin: string | undefined = vscode.workspace.getConfiguration().get(interpreterSetting);
+            if (typeof luaBin === "undefined" || luaBin.length === 0) {
+                return abortLaunch(
+                    `You must set "${interpreterSetting}" in your settings, or "program.lua" `
+                    + "in your launch.json, to debug with a lua interpreter."
+                );
             }
-            if (typeof luaConfig.file === "undefined") {
-                if (typeof editor === "undefined"
-                    || editor.document.languageId !== "lua"
-                    || editor.document.isUntitled
-                ) {
-                    return abortLaunch("'program.file' not set in launch.json");
-                }
-                luaConfig.file = editor.document.uri.fsPath;
+            luaConfig.tarantool = luaBin;
+        }
+        if (typeof luaConfig.file === "undefined") {
+            if (typeof editor === "undefined"
+                || editor.document.languageId !== "lua"
+                || editor.document.isUntitled
+            ) {
+                return abortLaunch("'program.file' not set in launch.json");
             }
-            config.program = luaConfig as LuaProgramConfig;
+            luaConfig.file = editor.document.uri.fsPath;
         }
+        config.program = luaConfig as TarantoolProgramConfig;
 
         if (Array.isArray(config.scriptFiles)) {
             const nonString = config.scriptFiles.find(p => typeof p !== "string");
diff --git a/extension/launchConfig.ts b/extension/launchConfig.ts
@@ -20,21 +20,16 @@
 //OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 //SOFTWARE.
 
-export interface LuaProgramConfig {
-    lua: string;
+export interface TarantoolProgramConfig {
+    tarantool?: string;
     file: string;
     communication?: string;
 }
 
-export interface CustomProgramConfig {
-    command: string;
-    communication?: string;
-}
-
 export interface LaunchConfig {
     extensionPath: string;
     workspacePath: string;
-    program: LuaProgramConfig | CustomProgramConfig;
+    program: TarantoolProgramConfig;
     args?: string[];
     cwd: string;
     env?: { [name: string]: string };
@@ -46,7 +41,3 @@ export interface LaunchConfig {
     scriptFiles?: string[];
     ignorePatterns?: string[];
 }
-
-export function isCustomProgramConfig(config: LuaProgramConfig | CustomProgramConfig): config is CustomProgramConfig {
-    return typeof (config as CustomProgramConfig).command !== "undefined";
-}
diff --git a/extension/luaDebugSession.ts b/extension/luaDebugSession.ts
@@ -40,8 +40,8 @@ import * as childProcess from "child_process";
 import * as path from "path";
 import * as fs from "fs";
 import {Message} from "./message";
-import {LaunchConfig, isCustomProgramConfig} from "./launchConfig";
-import {createFifoPipe, createNamedPipe, DebugPipe} from "./debugPipe";
+import {LaunchConfig} from "./launchConfig";
+import {createFifoPipe, DebugPipe} from "./debugPipe";
 
 interface MessageHandler<T extends LuaDebug.Message = LuaDebug.Message> {
     (msg: T): void;
@@ -213,7 +213,7 @@ export class LuaDebugSession extends LoggingDebugSession {
             env: Object.assign({}, process.env),
             cwd,
             shell: true,
-            detached: process.platform !== "win32"
+            detached: true,
         };
 
         if (typeof this.config.env !== "undefined") {
@@ -241,11 +241,7 @@ export class LuaDebugSession extends LoggingDebugSession {
 
         //Open pipes
         if (this.config.program.communication === "pipe") {
-            if (process.platform === "win32") {
-                this.debugPipe = createNamedPipe();
-            } else {
-                this.debugPipe = createFifoPipe();
-            }
+            this.debugPipe = createFifoPipe();
             this.debugPipe.open(
                 data => { void this.onDebuggerOutput(data); },
                 err => { this.showOutput(`${err}`, OutputCategory.Error); }
@@ -262,28 +258,22 @@ export class LuaDebugSession extends LoggingDebugSession {
         this.updateLuaPath("LUA_PATH", processOptions.env, true);
 
         //Launch process
-        let processExecutable: string;
-        let processArgs: string[];
-        if (isCustomProgramConfig(this.config.program)) {
-            processExecutable = `"${this.config.program.command}"`;
-            processArgs = typeof this.config.args !== "undefined" ? this.config.args : [];
+        const processExecutable = `"${this.config.program.tarantool}"`;
+        const configArgs = (typeof this.config.args !== "undefined")
+            ? `, ${this.config.args.map(a => `[[${a}]]`)}`
+            : "";
+        const processArgs: string[] = [
+            "-e",
+            "\"require 'strict'.off()\"",
+            "-e",
+            "\"require('lldebugger').runFile("
+            + `[[${this.config.program.file}]],`
+            + "true,"
+            + `{[-1]=[[${this.config.program.tarantool}]],[0]=[[${this.config.program.file}]]${configArgs}}`
+            + ")\""
+        ];
 
-        } else {
-            processExecutable = `"${this.config.program.lua}"`;
-            const programArgs = (typeof this.config.args !== "undefined")
-                ? `, ${this.config.args.map(a => `[[${a}]]`)}`
-                : "";
-            processArgs = [
-                "-e",
-                "\"require('lldebugger').runFile("
-                + `[[${this.config.program.file}]],`
-                + "true,"
-                + `{[-1]=[[${this.config.program.lua}]],[0]=[[${this.config.program.file}]]${programArgs}}`
-                + ")\""
-            ];
-        }
         this.process = childProcess.spawn(processExecutable, processArgs, processOptions);
-
         this.showOutput(
             `launching \`${processExecutable} ${processArgs.join(" ")}\` from "${cwd}"`,
             OutputCategory.Info
@@ -703,11 +693,7 @@ export class LuaDebugSession extends LoggingDebugSession {
         this.showOutput("terminateRequest", OutputCategory.Request);
 
         if (this.process !== null) {
-            if (process.platform === "win32") {
-                childProcess.spawn("taskkill", ["/pid", this.assert(this.process.pid).toString(), "/f", "/t"]);
-            } else {
-                process.kill(-this.assert(this.process.pid), "SIGKILL");
-            }
+            process.kill(-this.assert(this.process.pid), "SIGKILL");
         }
 
         this.isRunning = false;
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,9 +1,9 @@
 {
-  "name": "tarantool-local-lua-debugger-vscode",
-  "publisher": "usenko-timur",
-  "version": "0.3.3",
-  "description": "Tarantool Local Lua Debugger - tarantool local lua debugger with no dependencies",
-  "displayName": "Tarantool Local Lua Debugger",
+  "name": "tarantool-lua-debugger-vscode",
+  "publisher": "tarantool",
+  "version": "0.4.0",
+  "description": "Tarantool Lua Debugger - tarantool lua debugger with no dependencies",
+  "displayName": "Tarantool Lua Debugger",
   "icon": "resources/tarantool-logo-small_128x128.png",
   "repository": {
     "type": "github",
@@ -20,9 +20,6 @@
     "tstl",
     "typescripttolua",
     "typescript-to-lua",
-    "love",
-    "löve",
-    "corona",
     "tarantool"
   ],
   "scripts": {
@@ -59,12 +56,12 @@
   "contributes": {
     "configuration": [
       {
-        "title": "Local Lua Debugger",
+        "title": "Tarantool Lua Debugger",
         "properties": {
-          "lua-local.interpreter": {
+          "lua-tarantool.interpreter": {
             "type": "string",
-            "default": "",
-            "description": "Lua stand-alone interpreter to use when none is specified in launch.json"
+            "default": "tarantool",
+            "description": "Tarantool Lua stand-alone interpreter to use when none is specified in launch.json"
           }
         }
       }
@@ -76,29 +73,21 @@
     ],
     "debuggers": [
       {
-        "type": "lua-local",
-        "label": "Local Lua Debugger",
+        "type": "lua-tarantool",
+        "label": "Tarantool Lua Debugger",
         "program": "./extension/debugAdapter.js",
         "runtime": "node",
         "languages": [
           "lua"
         ],
         "initialConfigurations": [
           {
-            "name": "Debug Lua Interpreter",
-            "type": "lua-local",
+            "name": "Debug Tarantool Lua Interpreter",
+            "type": "lua-tarantool",
             "request": "launch",
             "program": {
-              "lua": "lua",
+              "tarantool": "tarantool",
               "file": "${file}"
-            }
-          },
-          {
-            "name": "Debug Custom Lua Environment",
-            "type": "lua-local",
-            "request": "launch",
-            "program": {
-              "command": "command"
             },
             "args": []
           }
@@ -172,40 +161,25 @@
                   {
                     "type": "object",
                     "properties": {
-                      "lua": {
+                      "tarantool": {
                         "type": "string",
-                        "description": "Lua stand-alone interpreter to use",
-                        "default": "lua"
+                        "description": "Tarantool Lua stand-alone interpreter to use",
+                        "default": "tarantool"
                       },
                       "file": {
                         "type": "string",
                         "description": "The entry point file of the program",
                         "default": "${file}"
                       },
                       "communication": {
-                        "enum": ["stdio", "pipe"],
-                        "description": "Communication method between extension and debugger.",
-                        "default": "stdio"
-                      }
-                    },
-                    "additionalProperties": false
-                  },
-                  {
-                    "type": "object",
-                    "properties": {
-                      "command": {
-                        "type": "string",
-                        "description": "The custom command to run"
-                      },
-                      "communication": {
-                        "enum": ["stdio", "pipe"],
+                        "enum": [
+                          "stdio",
+                          "pipe"
+                        ],
                         "description": "Communication method between extension and debugger.",
                         "default": "stdio"
                       }
                     },
-                    "required": [
-                      "command"
-                    ],
                     "additionalProperties": false
                   }
                 ]
diff --git a/resources/Lua-Logo_128x128.png b/resources/Lua-Logo_128x128.png
diff --git a/resources/settings.png b/resources/settings.png

Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-export const EXTENSION_ID = "usenko-timur.tarantool-local-lua-debugger-vscode";`
	`1`	`+export const EXTENSION_ID = "tarantool.tarantool-lua-debugger-vscode";`