Merge pull request #505 from puremourning/delve-output

Make output visible for delve

Author: mergify[bot]

Makefile

@@ -0,0 +1,15 @@
+.PHONY: check vim-docs schema-docs docs
+
+check:
+	@echo "Running flake8..."
+	flake8 python3/ *.py
+	@echo "Running vint..."
+	vint autoload/ compiler/ plugin/ tests/ syntax/
+
+vim-docs: README.md
+	$(CURDIR)/update-vim-docs
+
+schema-docs: docs/*.md docs/schema/*.json
+	$(CURDIR)/update-schema-docs
+
+docs: vim-docs schema-docs

README.md

@@ -1512,6 +1512,9 @@ Use Variables to configure the following:
 
 * `dlvFlags`: (string) additional command line arguments to pass to delve
 
+The debugger (delve) is launched in a terminal window so that you can see its
+output and pass input to the debuggee.
+
 See [vscode-go docs](https://github.com/golang/vscode-go/blob/master/docs/debugging.md#launchjson-attributes) for full launch options.
 Yes, it seems that's the only place they are documented (apparently, they are
 not documented by delve itself).

autoload/vimspector/internal/balloon.vim

@@ -137,7 +137,7 @@ function! s:MatchKey( key, candidates ) abort
     " is a single key (anyway), and so we assume any string starting with < is a
     " special key (which will be the common case) and try and map it. If it
     " fails... it fails.
-    if candidate[ 0 ] == '<'
+    if candidate[ 0 ] ==# '<'
       try
         execute 'let candidate = "\' . candidate . '"'
       endtry

autoload/vimspector/internal/channel.vim

@@ -49,7 +49,7 @@ function! vimspector#internal#channel#StartDebugSession( config ) abort
 
   " If we _also_ have a command line, then start the actual job. This allows for
   " servers which start up and listen on some port
-  if has_key( a:config, 'command' )
+  if has_key( a:config, 'command' ) && !get( a:config, 'tty', 0 )
     let s:job = job_start( a:config[ 'command' ],
           \                {
           \                    'in_mode': 'raw',

autoload/vimspector/internal/neochannel.vim

@@ -49,7 +49,7 @@ function! vimspector#internal#neochannel#StartDebugSession( config ) abort
 
   " If we _also_ have a command line, then start the actual job. This allows for
   " servers which start up and listen on some port
-  if has_key( a:config, 'command' )
+  if has_key( a:config, 'command' ) && !get( a:config, 'tty', 0 )
     let old_env={}
     try
       let old_env = vimspector#internal#neoterm#PrepareEnvironment(

autoload/vimspector/internal/neopopup.vim

@@ -107,7 +107,7 @@ function! vimspector#internal#neopopup#Confirm( confirm_id,
   " in popup.vim), i.e.:
   "  - 1-based index of selected item, or
   "  - -1 or 0 for cancellation
-  if result == ''
+  if result ==# ''
     " User pressed ESC/ctrl-c
     let result = -1
   else

doc/vimspector.txt

@@ -1782,6 +1782,9 @@ Use Variables to configure the following:
 
 - 'dlvFlags': (string) additional command line arguments to pass to delve
 
+The debugger (delve) is launched in a terminal window so that you can see its
+output and pass input to the debuggee.
+
 See vscode-go docs [38] for full launch options. Yes, it seems that's the only
 place they are documented (apparently, they are not documented by delve
 itself).

docs/schema-doc/gadgets.schema.html

@@ -173,54 +173,56 @@
       }
     },
     "adapter": {
-      "oneOf": [
+      "allOf": [
+        { "type": "object" },
+        { "$ref": "#/definitions/variables" },
         {
-          "allOf": [
-            { "type": "object" },
-            { "$ref": "#/definitions/variables" },
-            {
-              "properties": {
-                "name": {
-                  "type": "string",
-                  "description": "Passed to the adapter in the initialization request. Some adapters are particularly picky about what value goes here. Usually it can be omitted and Vimspector will send a generic value"
-                },
-                "configuration": {
-                  "type": "object",
-                  "description": "Base debug configuration. Can be used to set default values for all debug configurations. When reading individual debug configurations from 'configurations', those configurations are merged with this object. Definitions in the debug configuration override anything in this object. Typical usage for this is to set the 'type' parameter, which some debug adapters are very picky about, or to set e.g. the path to an underlying debugger."
-                }
-              }
-            },
-            { "$ref": "#/definitions/adapter-launchattach" },
-            {
-              "anyOf": [
-                { "required": [ "command" ] },
-                { "required": [ "port" ] },
-                { "required": [ "command", "port" ] }
-              ]
+          "properties": {
+            "name": {
+              "type": "string",
+              "description": "Passed to the adapter in the initialization request. Some adapters are particularly picky about what value goes here. Usually it can be omitted and Vimspector will send a generic value"
             },
+            "configuration": {
+              "type": "object",
+              "description": "Base debug configuration. Can be used to set default values for all debug configurations. When reading individual debug configurations from 'configurations', those configurations are merged with this object. Definitions in the debug configuration override anything in this object. Typical usage for this is to set the 'type' parameter, which some debug adapters are very picky about, or to set e.g. the path to an underlying debugger."
+            }
+          }
+        },
+        { "$ref": "#/definitions/adapter-launchattach" },
+        {
+          "anyOf": [
+            { "required": [ "command" ] },
+            { "required": [ "port" ] },
             {
+              "required": [ "command", "port" ],
               "properties": {
-                "host": {
-                  "type": "string",
-                  "default": "127.0.0.1",
-                  "description": "Connect to this host in multi-session mode"
-                },
-                "port": {
-                  "oneOf": [
-                    { "type": "string" },
-                    { "type": "integer" }
-                  ],
-                  "description": "If supplied, indicates that a socket connection should be made to this port on 'host'. If the value is 'ask', then the user is asked to enter the port number to connect to."
+                "tty": {
+                  "type": "boolean",
+                  "description": "Set to True to launch 'command' in a terminal. Only valid when both 'command' and 'port' are supplied."
                 }
               }
-            }
+            },
+            { "required": [ "extends" ] }
           ]
         },
         {
-          "type": "object",
-          "required": [ "extends" ],
           "properties": {
-            "extends": { "type": "string" }
+            "host": {
+              "type": "string",
+              "default": "127.0.0.1",
+              "description": "Connect to this host in multi-session mode"
+            },
+            "port": {
+              "oneOf": [
+                { "type": "string" },
+                { "type": "integer" }
+              ],
+              "description": "If supplied, indicates that a socket connection should be made to this port on 'host'. If the value is 'ask', then the user is asked to enter the port number to connect to."
+            },
+            "extends": {
+              "type": "string",
+              "description": "Name of another adapter from which to inherit all properties"
+            }
           }
         }
       ]
@@ -236,89 +238,86 @@
     "configurations": {
       "type": "object",
       "additionalProperties": {
-        "oneOf": [
+        "allOf": [
+          { "$ref": "#/definitions/variables" },
+          {
+            "oneOf": [
+              { "required": [ "adapter", "configuration" ] },
+              { "required": [ "extends" ] }
+            ]
+          },
           {
-            "allOf": [
-              { "$ref": "#/definitions/variables" },
-              {
+            "type": "object",
+            "properties": {
+              "adapter": {
+                "description": "Adapter configuration to use for this debug session",
+                "oneOf": [
+                  { "$ref": "#/definitions/adapter" },
+                  {
+                    "type": "string",
+                    "description": "Name of an adapter in the 'adapters' mapping"
+                  }
+                ]
+              },
+              "extends": {
+                "type": "string",
+                "description": "Name of another configuration to inherit properties from."
+              },
+              "remote-request": {
+                "enum": [ "launch", "attach" ],
+                "description": "When the 'remote' block is defined in the adapter configuration, this can be used to override the actual action taken (remotely). Usually the actual 'configuration' will contain 'request' of 'attach', but in order to remotely 'launch' the process (e.g. under gdbserver or equivalent), use remote-attach set to 'launch'"
+              },
+              "remote-cmdLine": {
+                "type": [ "string", "array" ],
+                "description": "Defines the value of the special token %CMD% in remote-launch 'runCommand(s)'. The value is inserted into the command line where an entry matching '%CMD%' is found in 'runCommand(s)' command array."
+              },
+              "default": {
+                "type": "boolean",
+                "description": "When true, this configuration is picked by default"
+              },
+              "autoselect": {
+                "type": "boolean",
+                "description": "When false, this configuration is _never_ picked by default"
+              },
+              "filetypes": {
+                "type": "array",
+                "description": "List of Vim filetypes that this configuration applies to. The configuraiton is only used if one of the current filetypes appears in this list, or if this list is not supplied,"
+              },
+              "configuration": {
                 "type": "object",
+                "required": [ "request" ],
                 "properties": {
-                  "adapter": {
-                    "description": "Adapter configuration to use for this debug session",
-                    "oneOf": [
-                      { "$ref": "#/definitions/adapter" },
-                      {
-                        "type": "string",
-                        "description": "Name of an adapter in the 'adapters' mapping"
-                      }
-                    ]
-                  },
-                  "remote-request": {
+                  "request": {
                     "enum": [ "launch", "attach" ],
-                    "description": "When the 'remote' block is defined in the adapter configuration, this can be used to override the actual action taken (remotely). Usually the actual 'configuration' will contain 'request' of 'attach', but in order to remotely 'launch' the process (e.g. under gdbserver or equivalent), use remote-attach set to 'launch'"
-                  },
-                  "remote-cmdLine": {
-                    "type": [ "string", "array" ],
-                    "description": "Defines the value of the special token %CMD% in remote-launch 'runCommand(s)'. The value is inserted into the command line where an entry matching '%CMD%' is found in 'runCommand(s)' command array."
-                  },
-                  "default": {
-                    "type": "boolean",
-                    "description": "When true, this configuration is picked by default"
-                  },
-                  "autoselect": {
-                    "type": "boolean",
-                    "description": "When false, this configuration is _never_ picked by default"
-                  },
-                  "filetypes": {
-                    "type": "array",
-                    "description": "List of Vim filetypes that this configuration applies to. The configuraiton is only used if one of the current filetypes appears in this list, or if this list is not supplied,"
-                  },
-                  "configuration": {
+                    "description": "Type of session - launch process or attach to process"
+                  }
+                },
+                "additionalProperties": {
+                  "description": "Additional properties are passed to the debug adapter in the 'launch' or 'attach' request and are specific to the debug adapter."
+                }
+              },
+              "breakpoints": {
+                "type": "object",
+                "properties": {
+                  "exception": {
                     "type": "object",
-                    "required": [ "request" ],
-                    "properties": {
-                      "request": {
-                        "enum": [ "launch", "attach" ],
-                        "description": "Type of session - launch process or attach to process"
-                      }
-                    },
+                    "description": "Exception breakpoints configuration, mapping the server's exception filter to enabled/disable/default flag",
                     "additionalProperties": {
-                      "description": "Additional properties are passed to the debug adapter in the 'launch' or 'attach' request and are specific to the debug adapter."
-                    }
-                  },
-                  "breakpoints": {
-                    "type": "object",
-                    "properties": {
-                      "exception": {
-                        "type": "object",
-                        "description": "Exception breakpoints configuration, mapping the server's exception filter to enabled/disable/default flag",
-                        "additionalProperties": {
-                          "oneOf": [
-                            {
-                              "type": "boolean",
-                              "description": "true = enable, false = disable"
-                            },
-                            {
-                              "type": "string",
-                              "enum": [ "Y", "N", "" ],
-                              "description": "Y = enable, N = disable, '' = default"
-                            }
-                          ]
+                      "oneOf": [
+                        {
+                          "type": "boolean",
+                          "description": "true = enable, false = disable"
+                        },
+                        {
+                          "type": "string",
+                          "enum": [ "Y", "N", "" ],
+                          "description": "Y = enable, N = disable, '' = default"
                         }
-                      }
+                      ]
                     }
                   }
                 }
               }
-            ]
-          },
-          {
-            "type": "object",
-            "required": [ "extends" ],
-            "properties": {
-              "extends": {
-                "type": "string"
-              }
             }
           }
         ]