[NFC][Coroutines] Use structured binding with llvm::enumerate in CoroSplit (#116879)
[llvm-project.git] / lldb / tools / lldb-dap / package.json
blob9155163c65ba5ced5844b3aebb4db9a5b84ff617
2   "name": "lldb-dap",
3   "displayName": "LLDB DAP",
4   "version": "0.2.6",
5   "publisher": "llvm-vs-code-extensions",
6   "homepage": "https://lldb.llvm.org",
7   "description": "LLDB debugging from VSCode",
8   "license": "Apache 2.0 License with LLVM exceptions",
9   "repository": {
10     "type": "git",
11     "url": "https://github.com/llvm/llvm-project.git",
12     "directory": "lldb/tools/lldb-dap/"
13   },
14   "bugs": {
15     "url": "https://github.com/llvm/llvm-project/issues"
16   },
17   "keywords": [
18     "C",
19     "C++",
20     "LLVM",
21     "LLDB"
22   ],
23   "engines": {
24     "vscode": "^1.75.0"
25   },
26   "categories": [
27     "Debuggers"
28   ],
29   "devDependencies": {
30     "@types/node": "^18.11.18",
31     "@types/vscode": "~1.74.0",
32     "@vscode/vsce": "^2.19.0",
33     "prettier-plugin-curly": "^0.1.3",
34     "prettier": "^3.1.1",
35     "typescript": "^4.6.4"
36   },
37   "activationEvents": [
38     "onDebug"
39   ],
40   "main": "./out/extension",
41   "scripts": {
42     "vscode:prepublish": "tsc -p ./",
43     "watch": "tsc -watch -p ./",
44     "format": "npx prettier './src-ts/' --write",
45     "package": "vsce package --out ./out/lldb-dap.vsix",
46     "publish": "vsce publish",
47     "vscode-uninstall": "code --uninstall-extension llvm.lldb-dap",
48     "vscode-install": "code --install-extension ./out/lldb-dap.vsix"
49   },
50   "contributes": {
51     "languages": [
52       {
53         "id": "lldb.disassembly",
54         "aliases": [
55           "Disassembly"
56         ],
57         "extensions": [
58           ".disasm"
59         ]
60       }
61     ],
62     "grammars": [
63       {
64         "language": "lldb.disassembly",
65         "scopeName": "source.disassembly",
66         "path": "./syntaxes/disassembly.json"
67       }
68     ],
69     "configuration": {
70       "type": "object",
71       "title": "lldb-dap",
72       "properties": {
73         "lldb-dap.executable-path": {
74           "scope": "resource",
75           "type": "string",
76           "description": "The path to the lldb-dap binary."
77         },
78         "lldb-dap.log-path": {
79           "scope": "resource",
80           "type": "string",
81           "description": "The log path for lldb-dap (if any)"
82         },
83         "lldb-dap.environment": {
84           "scope": "resource",
85           "type": "object",
86           "default": {},
87           "description": "The environment of the lldb-dap process.",
88           "additionalProperties": {
89              "type": "string"
90           }
91         }
92       }
93     },
94     "breakpoints": [
95       {
96         "language": "ada"
97       },
98       {
99         "language": "arm"
100       },
101       {
102         "language": "asm"
103       },
104       {
105         "language": "c"
106       },
107       {
108         "language": "cpp"
109       },
110       {
111         "language": "crystal"
112       },
113       {
114         "language": "d"
115       },
116       {
117         "language": "fortan"
118       },
119       {
120         "language": "fortran-modern"
121       },
122       {
123         "language": "nim"
124       },
125       {
126         "language": "objective-c"
127       },
128       {
129         "language": "objectpascal"
130       },
131       {
132         "language": "pascal"
133       },
134       {
135         "language": "rust"
136       },
137       {
138         "language": "swift"
139       }
140     ],
141     "debuggers": [
142       {
143         "type": "lldb-dap",
144         "label": "Native LLDB Debugger",
145         "program": "./bin/lldb-dap",
146         "windows": {
147           "program": "./bin/lldb-dap.exe"
148         },
149         "configurationAttributes": {
150           "launch": {
151             "required": [
152               "program"
153             ],
154             "properties": {
155               "program": {
156                 "type": "string",
157                 "description": "Path to the program to debug."
158               },
159               "args": {
160                 "type": [
161                   "array",
162                   "string"
163                 ],
164                 "description": "Program arguments.",
165                 "default": []
166               },
167               "cwd": {
168                 "type": "string",
169                 "description": "Program working directory.",
170                 "default": "${workspaceRoot}"
171               },
172               "env": {
173                 "anyOf": [
174                   {
175                     "type": "object",
176                     "description": "Additional environment variables to set when launching the program. E.g. `{ \"FOO\": \"1\" }`",
177                     "patternProperties": {
178                       ".*": {
179                         "type": "string"
180                       }
181                     },
182                     "default": {}
183                   },
184                   {
185                     "type": "array",
186                     "description": "Additional environment variables to set when launching the program. E.g. `[\"FOO=1\", \"BAR\"]`",
187                     "items": {
188                       "type": "string",
189                       "pattern": "^((\\w+=.*)|^\\w+)$"
190                     },
191                     "default": []
192                   }
193                 ]
194               },
195               "stopOnEntry": {
196                 "type": "boolean",
197                 "description": "Automatically stop after launch.",
198                 "default": false
199               },
200               "disableASLR": {
201                 "type": "boolean",
202                 "description": "Enable or disable Address space layout randomization if the debugger supports it.",
203                 "default": true
204               },
205               "disableSTDIO": {
206                 "type": "boolean",
207                 "description": "Don't retrieve STDIN, STDOUT and STDERR as the program is running.",
208                 "default": false
209               },
210               "shellExpandArguments": {
211                 "type": "boolean",
212                 "description": "Expand program arguments as a shell would without actually launching the program in a shell.",
213                 "default": false
214               },
215               "detachOnError": {
216                 "type": "boolean",
217                 "description": "Detach from the program.",
218                 "default": false
219               },
220               "sourcePath": {
221                 "type": "string",
222                 "description": "Specify a source path to remap \"./\" to allow full paths to be used when setting breakpoints in binaries that have relative source paths."
223               },
224               "sourceMap": {
225                 "anyOf": [
226                   {
227                     "type": "object",
228                     "description": "Specify an object of path remappings; each entry has a key containing the source path and a value containing the destination path. E.g `{ \"/the/source/path\": \"/the/destination/path\" }`. Overrides sourcePath.",
229                     "patternProperties": {
230                       ".*": {
231                         "type": "string"
232                       }
233                     },
234                     "default": {}
235                   },
236                   {
237                     "type": "array",
238                     "description": "Specify an array of path remappings; each element must itself be a two element array containing a source and destination path name. Overrides sourcePath.",
239                     "items": {
240                       "type": "array",
241                       "minItems": 2,
242                       "maxItems": 2,
243                       "items": {
244                         "type": "string"
245                       }
246                     },
247                     "default": []
248                   }
249                 ]
250               },
251               "debuggerRoot": {
252                 "type": "string",
253                 "description": "Specify a working directory to set the debug adapter to so relative object files can be located."
254               },
255               "targetTriple": {
256                 "type": "string",
257                 "description": "Triplet of the target architecture to override value derived from the program file."
258               },
259               "platformName": {
260                 "type": "string",
261                 "description": "Name of the execution platform to override value derived from the program file."
262               },
263               "initCommands": {
264                 "type": "array",
265                 "description": "Initialization commands executed upon debugger startup.",
266                 "default": []
267               },
268               "preRunCommands": {
269                 "type": "array",
270                 "description": "Commands executed just before the program is launched.",
271                 "default": []
272               },
273               "postRunCommands": {
274                 "type": "array",
275                 "description": "Commands executed just as soon as the program is successfully launched when it's in a stopped state prior to any automatic continuation.",
276                 "default": []
277               },
278               "launchCommands": {
279                 "type": "array",
280                 "description": "Custom commands that are executed instead of launching a process. A target will be created with the launch arguments prior to executing these commands. The commands may optionally create a new target and must perform a launch. A valid process must exist after these commands complete or the \"launch\" will fail. Launch the process with \"process launch -s\" to make the process to at the entry point since lldb-dap will auto resume if necessary.",
281                 "default": []
282               },
283               "stopCommands": {
284                 "type": "array",
285                 "description": "Commands executed each time the program stops.",
286                 "default": []
287               },
288               "exitCommands": {
289                 "type": "array",
290                 "description": "Commands executed when the program exits.",
291                 "default": []
292               },
293               "terminateCommands": {
294                 "type": "array",
295                 "description": "Commands executed when the debugging session ends.",
296                 "default": []
297               },
298               "runInTerminal": {
299                 "type": "boolean",
300                 "description": "Launch the program inside an integrated terminal in the IDE. Useful for debugging interactive command line programs",
301                 "default": false
302               },
303               "timeout": {
304                 "type": "string",
305                 "description": "The time in seconds to wait for a program to stop at entry point when launching with \"launchCommands\". Defaults to 30 seconds."
306               },
307               "enableAutoVariableSummaries": {
308                 "type": "boolean",
309                 "description": "Enable auto generated summaries for variables when no summaries exist for a given type. This feature can cause performance delays in large projects when viewing variables.",
310                 "default": false
311               },
312               "displayExtendedBacktrace": {
313                 "type": "boolean",
314                 "description": "Enable language specific extended backtraces.",
315                 "default": false
316               },
317               "enableSyntheticChildDebugging": {
318                 "type": "boolean",
319                 "description": "If a variable is displayed using a synthetic children, also display the actual contents of the variable at the end under a [raw] entry. This is useful when creating sythetic child plug-ins as it lets you see the actual contents of the variable.",
320                 "default": false
321               },
322               "commandEscapePrefix": {
323                 "type": "string",
324                 "description": "The escape prefix to use for executing regular LLDB commands in the Debug Console, instead of printing variables. Defaults to a back-tick (`). If it's an empty string, then all expression in the Debug Console are treated as regular LLDB commands.",
325                 "default": "`"
326               },
327               "customFrameFormat": {
328                 "type": "string",
329                 "description": "If non-empty, stack frames will have descriptions generated based on the provided format. See https://lldb.llvm.org/use/formatting.html for an explanation on format strings for frames. If the format string contains errors, an error message will be displayed on the Debug Console and the default frame names will be used. This might come with a performance cost because debug information might need to be processed to generate the description.",
330                 "default": ""
331               },
332               "customThreadFormat": {
333                 "type": "string",
334                 "description": "If non-empty, threads will have descriptions generated based on the provided format. See https://lldb.llvm.org/use/formatting.html for an explanation on format strings for threads. If the format string contains errors, an error message will be displayed on the Debug Console and the default thread names will be used. This might come with a performance cost because debug information might need to be processed to generate the description.",
335                 "default": ""
336               }
337             }
338           },
339           "attach": {
340             "properties": {
341               "program": {
342                 "type": "string",
343                 "description": "Path to the program to attach to."
344               },
345               "pid": {
346                 "type": [
347                   "number",
348                   "string"
349                 ],
350                 "description": "System process ID to attach to."
351               },
352               "waitFor": {
353                 "type": "boolean",
354                 "description": "If set to true, then wait for the process to launch by looking for a process with a basename that matches `program`. No process ID needs to be specified when using this flag.",
355                 "default": true
356               },
357               "sourcePath": {
358                 "type": "string",
359                 "description": "Specify a source path to remap \"./\" to allow full paths to be used when setting breakpoints in binaries that have relative source paths."
360               },
361               "sourceMap": {
362                 "anyOf": [
363                   {
364                     "type": "object",
365                     "description": "Specify an object of path remappings; each entry has a key containing the source path and a value containing the destination path. E.g `{ \"/the/source/path\": \"/the/destination/path\" }`. Overrides sourcePath.",
366                     "patternProperties": {
367                       ".*": {
368                         "type": "string"
369                       }
370                     },
371                     "default": {}
372                   },
373                   {
374                     "type": "array",
375                     "description": "Specify an array of path remappings; each element must itself be a two element array containing a source and destination path name. Overrides sourcePath.",
376                     "items": {
377                       "type": "array",
378                       "minItems": 2,
379                       "maxItems": 2,
380                       "items": {
381                         "type": "string"
382                       }
383                     },
384                     "default": []
385                   }
386                 ]
387               },
388               "debuggerRoot": {
389                 "type": "string",
390                 "description": "Specify a working directory to set the debug adapter to so relative object files can be located."
391               },
392               "targetTriple": {
393                 "type": "string",
394                 "description": "Triplet of the target architecture to override value derived from the program file."
395               },
396               "platformName": {
397                 "type": "string",
398                 "description": "Name of the execution platform to override value derived from the program file."
399               },
400               "attachCommands": {
401                 "type": "array",
402                 "description": "Custom commands that are executed instead of attaching to a process ID or to a process by name. These commands may optionally create a new target and must perform an attach. A valid process must exist after these commands complete or the \"attach\" will fail.",
403                 "default": []
404               },
405               "initCommands": {
406                 "type": "array",
407                 "description": "Initialization commands executed upon debugger startup.",
408                 "default": []
409               },
410               "preRunCommands": {
411                 "type": "array",
412                 "description": "Commands executed just before the program is attached to.",
413                 "default": []
414               },
415               "postRunCommands": {
416                 "type": "array",
417                 "description": "Commands executed just as soon as the program is successfully attached when it's in a stopped state prior to any automatic continuation.",
418                 "default": []
419               },
420               "stopCommands": {
421                 "type": "array",
422                 "description": "Commands executed each time the program stops.",
423                 "default": []
424               },
425               "exitCommands": {
426                 "type": "array",
427                 "description": "Commands executed when the program exits.",
428                 "default": []
429               },
430               "terminateCommands": {
431                 "type": "array",
432                 "description": "Commands executed when the debugging session ends.",
433                 "default": []
434               },
435               "coreFile": {
436                 "type": "string",
437                 "description": "Path to the core file to debug."
438               },
439               "timeout": {
440                 "type": "string",
441                 "description": "The time in seconds to wait for a program to stop when attaching using \"attachCommands\". Defaults to 30 seconds."
442               },
443               "gdb-remote-port": {
444                 "type": [
445                   "number",
446                   "string"
447                 ],
448                 "description": "TCP/IP port to attach to a remote system. Specifying both pid and port is an error."
449               },
450               "gdb-remote-hostname": {
451                 "type": "string",
452                 "description": "The hostname to connect to a remote system. The default hostname being used localhost."
453               },
454               "enableAutoVariableSummaries": {
455                 "type": "boolean",
456                 "description": "Enable auto generated summaries for variables when no summaries exist for a given type. This feature can cause performance delays in large projects when viewing variables.",
457                 "default": false
458               },
459               "displayExtendedBacktrace": {
460                 "type": "boolean",
461                 "description": "Enable language specific extended backtraces.",
462                 "default": false
463               },
464               "enableSyntheticChildDebugging": {
465                 "type": "boolean",
466                 "description": "If a variable is displayed using a synthetic children, also display the actual contents of the variable at the end under a [raw] entry. This is useful when creating sythetic child plug-ins as it lets you see the actual contents of the variable.",
467                 "default": false
468               },
469               "commandEscapePrefix": {
470                 "type": "string",
471                 "description": "The escape prefix character to use for executing regular LLDB commands in the Debug Console, instead of printing variables. Defaults to a back-tick (`). If empty, then all expression in the Debug Console are treated as regular LLDB commands.",
472                 "default": "`"
473               },
474               "customFrameFormat": {
475                 "type": "string",
476                 "description": "If non-empty, stack frames will have descriptions generated based on the provided format. See https://lldb.llvm.org/use/formatting.html for an explanation on format strings for frames. If the format string contains errors, an error message will be displayed on the Debug Console and the default frame names will be used. This might come with a performance cost because debug information might need to be processed to generate the description.",
477                 "default": ""
478               },
479               "customThreadFormat": {
480                 "type": "string",
481                 "description": "If non-empty, threads will have descriptions generated based on the provided format. See https://lldb.llvm.org/use/formatting.html for an explanation on format strings for threads. If the format string contains errors, an error message will be displayed on the Debug Console and the default thread names will be used. This might come with a performance cost because debug information might need to be processed to generate the description.",
482                 "default": ""
483               }
484             }
485           }
486         },
487         "initialConfigurations": [
488           {
489             "type": "lldb-dap",
490             "request": "launch",
491             "name": "Debug",
492             "program": "${workspaceRoot}/<your program>",
493             "args": [],
494             "env": [],
495             "cwd": "${workspaceRoot}"
496           }
497         ],
498         "configurationSnippets": [
499           {
500             "label": "LLDB: Launch",
501             "description": "",
502             "body": {
503               "type": "lldb-dap",
504               "request": "launch",
505               "name": "${2:Launch}",
506               "program": "^\"\\${workspaceRoot}/${1:<your program>}\"",
507               "args": [],
508               "env": [],
509               "cwd": "^\"\\${workspaceRoot}\""
510             }
511           }
512         ]
513       }
514     ]
515   }