Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/emacs-lsp/dap-mode

Emacs :heart: Debug Adapter Protocol
https://github.com/emacs-lsp/dap-mode

cpp debug debugger emacs emacs-lsp go java javascript lsp lua php powershell ruby rust swift typescript

Last synced: 5 days ago
JSON representation

Emacs :heart: Debug Adapter Protocol

Host: GitHub
URL: https://github.com/emacs-lsp/dap-mode
Owner: emacs-lsp
License: gpl-3.0
Created: 2018-05-19T20:10:50.000Z (over 6 years ago)
Default Branch: master
Last Pushed: 2024-08-03T05:44:24.000Z (5 months ago)
Last Synced: 2024-10-29T15:26:28.046Z (3 months ago)
Topics: cpp, debug, debugger, emacs, emacs-lsp, go, java, javascript, lsp, lua, php, powershell, ruby, rust, swift, typescript
Language: Emacs Lisp
Homepage: https://emacs-lsp.github.io/dap-mode
Size: 11.4 MB
Stars: 1,301
Watchers: 28
Forks: 182
Open Issues: 235
Metadata Files:
- Readme: README.org
- Changelog: CHANGELOG.org
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

awesome-golang-repositories - dap-mode

README

        [[https://melpa.org/#/dap-mode][file:https://melpa.org/packages/dap-mode-badge.svg]]

[[https://stable.melpa.org/#/dap-mode][file:https://stable.melpa.org/packages/dap-mode-badge.svg]]

[[http://spacemacs.org][file:https://cdn.rawgit.com/syl20bnr/spacemacs/442d025779da2f62fc86c2082703697714db6514/assets/spacemacs-badge.svg]]

[[https://github.com/emacs-lsp/dap-mode/actions][file:https://github.com/emacs-lsp/dap-mode/workflows/CI/badge.svg]]

[[https://discord.gg/swuxy5AAgT][file:https://discordapp.com/api/guilds/789885435026604033/widget.png?style=shield]]

* dap-mode

** Table of Contents :TOC_4_gh:noexport:

- [[#dap-mode][dap-mode]]

  - [[#summary][Summary]]

    - [[#project-status][Project status]]

  - [[#usage][Usage]]

    - [[#docker-usage][Docker usage]]

  - [[#features][Features]]

  - [[#configuration][Configuration]]

  - [[#gallery][Gallery]]

  - [[#extending-dap-with-new-debug-servers][Extending DAP with new Debug servers]]

  - [[#links][Links]]

  - [[#acknowledgments][Acknowledgments]]

** Summary

  Emacs client/library for [[https://microsoft.github.io/debug-adapter-protocol/][Debug Adapter Protocol]] is a wire protocol for

  communication between client and Debug Server. It's similar to the [[https://github.com/Microsoft/language-server-protocol][LSP]] but

  provides integration with debug server.

*** Project status

   The API considered unstable until 1.0 release is out. It is tested against

   Java, Python, Ruby, Elixir and LLDB (C/C++/Objective-C/Swift).

** Usage

  The main entry points are ~dap-debug~ and ~dap-debug-edit-template~. The first

  one asks for a registered debug template and starts the configuration using

  the default values for that particular configuration. The latter creates a

  debug template which could be customized before running.

  ~dap-debug-edit-template~ will prepare a template declaration inside a

  temporary buffer. You should execute this code using ~C-M-x~ for the changes to

  apply. You should also copy this code into your Emacs configuration if you wish to

  make it persistent.

  dap-mode also provides a [[https://github.com/abo-abo/hydra][hydra]] with ~dap-hydra~. You can automatically trigger

  the hydra when the program hits a breakpoint by using the following code.

  

  #+BEGIN_SRC elisp 

  (add-hook 'dap-stopped-hook

            (lambda (arg) (call-interactively #'dap-hydra)))

  #+END_SRC

  

*** Docker usage

    You can also use this tool with dockerized debug servers: configure it either with a ~.dir-locals~ file

    or drop an ~.lsp-docker.yml~ configuration file (use [[https://github.com/emacs-lsp/lsp-docker][lsp-docker]] for general reference).

    Basically you have one function ~dap-docker-register~ that performs all the heavy lifting (finding the original debug template,

    patching it, registering a debug provider e.t.c). This function examines a configuration file or falls back to the default configuration

    (which can be patched using the ~.dir-locals~ approach, take a note that the default configuration doesn't provide any sane defaults for debugging)

    and then operates on the combination of the two. This mechanism is the same as in ~lsp-docker~.

    Note: currently you cannot use this mode when using a network connection to connect to debuggers (this part is yet to be implemented).

    Still want to talk to debuggers over network? In order to do so you have to look at the ~launch-args~ patching

    done by ~dap-docker--dockerize-start-file-args~, you have to somehow assign ~nil~ to ~dap-server-path~ before it is passed further into session creation.

    

    If you want to stick to a configuration file, take a look at the example below:

    

    #+begin_src yaml

    lsp:

      server:

        # 'lsp-docker' fields

      mappings:

        - source: "/your/host/source/path" # used both by 'lsp-docker' and 'dap-docker'

          destination: "/your/local/path/inside/a/container" # used both by 'lsp-docker' and 'dap-docker'

      debug:

        type: docker # only docker is supported

        subtype: image # or 'container'

        name:  # you can omit this field

        # in this case the 'lsp-docker' ('server' section) image name is used

        enabled: true # you can explicitly disable 'dap-docker' by using 'false'

        provider: 

        template: 

        launch_command: 

        # e.g. if you have installed a debug server in a different directory, not used with 'container' subtype debuggers

    #+end_src

** [[https://emacs-lsp.github.io/dap-mode/page/features/][Features]]

** [[https://emacs-lsp.github.io/dap-mode/page/configuration/][Configuration]]

** [[https://emacs-lsp.github.io/dap-mode/page/gallery][Gallery]]

** [[https://emacs-lsp.github.io/dap-mode/page/adding-debug-server][Extending DAP with new Debug servers]]

** Links

  - [[https://code.visualstudio.com/docs/extensionAPI/api-debugging][Debug Adapter Protocol]]

  - [[https://github.com/emacs-lsp/lsp-java][LSP Java]]

  - [[https://microsoft.github.io/debug-adapter-protocol/implementors/adapters/][Debug Adapter Protocol Server Implementations]]

** Acknowledgments

  - [[https://github.com/danielmartin][Daniel Martin]] - LLDB integration.

  - [[https://github.com/kiennq][Kien Nguyen]] - NodeJS debugger, Edge debuggers, automatic extension installation.

  - [[https://github.com/Ladicle][Aya Igarashi]] - Go debugger integration.

  - [[https://github.com/nbfalcon][Nikita Bloshchanevich]] - launch.json support (+ variable expansion), debugpy

    support, (with some groundwork by yyoncho) runInTerminal support, various

    bug fixes.

  - [[https://github.com/factyy][Andrei Mochalov]] - Docker (debugging in containers) integration.