Skip to content

Commit 7296f0b

Browse files
committed
Update README
1 parent 7317efe commit 7296f0b

File tree

1 file changed

+16
-5
lines changed

1 file changed

+16
-5
lines changed

README.md

Lines changed: 16 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,6 @@ An example with a minimal configuration to start using `lsp-dart`:
2424
;; Optional packages
2525
(use-package lsp-ui :ensure t)
2626
(use-package company-capf :ensure t)
27-
2827
```
2928

3029
## Features
@@ -75,16 +74,22 @@ You can disable the feature setting `lsp-dart-flutter-widget-guides` to `nil`.
7574

7675
### Debug
7776

78-
For emacs debugging, `lsp-dart` uses [`dap-mode`](https://github.com/emacs-lsp/dap-mode#dart) to debug.
79-
You only need to run `dap-dart-setup` one time to setup the debugger.
77+
For debugging, `lsp-dart` uses [`dap-mode`](https://github.com/emacs-lsp/dap-mode#dart).
78+
You only need to run `dap-dart-setup` one time to setup the debugger to your Emacs and `dap-debug` to start the debug.
8079

8180
![debug](https://raw.githubusercontent.com/emacs-lsp/lsp-dart/screenshots/debug.gif)
8281

82+
#### Flutter
83+
84+
`lsp-dart` support Flutter debugging too via `dap-debug` with an option to select the device to debug.
85+
86+
![flutter-debug](https://raw.githubusercontent.com/emacs-lsp/lsp-dart/screenshots/flutter-debug.gif)
87+
8388
#### DevTools
8489

8590
You can also open the [Dart DevTools](https://dart.dev/tools/dart-devtools) on the current debug session with `lsp-dart-dap-devtools-open`.
8691

87-
##### :warning:* Features only available for Dart SDK version 2.8.0 (currently the dev branch) or above.
92+
###### :warning:* Features only available for Dart SDK version 2.8.0 (currently the dev branch) or above.
8893

8994
## Supported settings
9095

@@ -105,7 +110,13 @@ You can also open the [Dart DevTools](https://dart.dev/tools/dart-devtools) on t
105110
* `lsp-dart-test-code-lens` - Enable the `Run` code lens on tests. Defaults to t.
106111
* `lsp-dart-dap-extension-version` - The debugger extension version. Defaults to [3.9.1](https://github.com/Dart-Code/Dart-Code/releases/tag/v3.9.1)
107112
* `lsp-dart-dap-debugger-path` - The debugger extension path.
108-
* `lsp-dart-dap-debugger-program` - The command to execute the debugger extension.
113+
* `lsp-dart-dap-dart-debugger-program` - The command to execute the debugger extension on dart projects.
114+
* `lsp-dart-dap-flutter-debugger-program` - The command to execute the debugger extension on flutter projects.
115+
* `lsp-dart-dap-debug-external-libraries` - Whether to enable the debug on external libraries. Defaults to nil.
116+
* `lsp-dart-dap-debug-sdk-libraries` - Whether to enable the debug on Dart SDK libraries. Defaults to nil.
117+
* `lsp-dart-dap-flutter-track-widget-creation` - Whether to pass –track-widget-creation to Flutter apps. Required to support 'Inspect Widget'.
118+
* `lsp-dart-dap-flutter-structured-errors` - Whether to pass `–track-widget-creation` to Flutter apps. Required to support 'Inspect Widget'.
119+
* `lsp-dart-dap-flutter-verbose-log` - Whether to enable verbose logs from Flutter DAP.
109120
* `lsp-dart-dap-devtools-theme` - The devtools theme when openning via `lsp-dart-dap-open-devtools`.
110121
* `lsp-dart-dap-devtools-hide-options` - What to hide when openning DevTools via `lsp-dart-dap-open-devtools`. Defaults to `debugger`.
111122

0 commit comments

Comments
 (0)