Improve debug output + add new lsp-dart-run command

Fixes #115

Author: ericdallo

README.md

@@ -104,7 +104,9 @@ Display widget guide lines from parent to child widgets on flutter. [:warning:*]
 
 You can disable the feature setting `lsp-dart-flutter-widget-guides` to `nil`.
 
-### Debug
+### Run or Debug
+
+To run your app you can use `lsp-dart-run` which will use `dap-mode` but for running without debug. to pass custom arguments it's possible to pass a prefix-argument with arguments separated by space.
 
 For debugging, `lsp-dart` uses [`dap-mode`](https://github.com/emacs-lsp/dap-mode#dart).
 You only need to run `lsp-dart-dap-setup` one time to setup the debugger to your Emacs and `dap-debug` to start the debug.
@@ -176,7 +178,7 @@ lsp-dart supports running Flutter and Dart commands as following:
 | `lsp-dart-show-todos`                            | Whether to generate diagnostics for TODO comments. If unspecified, diagnostics will not be generated.                                                                                | `nil`             |
 | `lsp-dart-complete-function-calls`               | Completes functions/methods with their required parameters.                                                                                                                          | `t`               |
 | `lsp-dart-extra-library-directories`             | Extra libs to analyze besides Dart SDK libs                                                                                                                                          | `'()`             |
-| `lsp-dart-only-analyze-projects-with-open-files` | Analysis will only be performed for projects that have open files rather than the root workspace folder                                                                              | `nil`               |
+| `lsp-dart-only-analyze-projects-with-open-files` | Analysis will only be performed for projects that have open files rather than the root workspace folder                                                                              | `nil`             |
 | `lsp-dart-suggest-from-unimported-libraries`     | Completion will not include symbols that are not already imported into the current file.                                                                                             | `t`               |
 | `lsp-dart-closing-labels`                        | Enable the closing labels feature on server lsp                                                                                                                                      | `t`               |
 | `lsp-dart-closing-labels-prefix`                 | The prefix string to be concatenated with the closing label                                                                                                                          | `""`              |
@@ -205,7 +207,7 @@ lsp-dart supports running Flutter and Dart commands as following:
 | `lsp-dart-dap-vm-additional-args`                | Additional args for dart debugging VM when the debugging.                                                                                                                            | `""`              |
 | `lsp-dart-dap-flutter-track-widget-creation`     | Whether to pass –track-widget-creation to Flutter apps. Required to support 'Inspect Widget'.                                                                                        | `t`               |
 | `lsp-dart-dap-flutter-structured-errors`         | Whether to use Flutter’s structured error support for improve error display.                                                                                                         | `t`               |
-| `lsp-dart-dap-flutter-verbose-log`               | Whether to enable verbose logs from Flutter DAP                                                                                                                                      | `nil`             |
+| `lsp-dart-dap-only-essential-log`                | Whether to logs only essential log                                                                                                                                                   | `nil`             |
 | `lsp-dart-dap-flutter-hot-reload-on-save`        | When enabled, every buffer save triggers a `lsp-dart-dap-flutter-hot-reload`                                                                                                         | `nil`             |
 | `lsp-dart-dap-flutter-hot-restart-on-save`       | When enabled, every buffer save triggers a `lsp-dart-dap-flutter-hot-restart`                                                                                                        | `nil`             |
 | `lsp-dart-devtools-theme`                        | The devtools theme when openning via `lsp-dart-dap-open-devtools`                                                                                                                    | `"dark"`          |

lsp-dart-dap.el

@@ -117,8 +117,8 @@ Required to support 'Inspect Widget'."
   :group 'lsp-dart
   :type 'string)
 
-(defcustom lsp-dart-dap-flutter-verbose-log nil
-  "Whether to enable logs from Flutter DAP."
+(defcustom lsp-dart-dap-only-essential-log nil
+  "Whether to log only essential log from debugger."
   :group 'lsp-dart
   :type 'boolean)
 
@@ -139,6 +139,13 @@ Required to support 'Inspect Widget'."
   "Log MSG with ARGS adding lsp-dart-dap prefix."
   (apply #'lsp-dart-custom-log "[DAP]" msg args))
 
+(defun lsp-dart-dap--flutter-debugger-args (conf)
+  "Add capabilities args on CONF checking dart SDK version."
+  (-> conf
+      (dap--put-if-absent :flutterSdkPath (lsp-dart-get-flutter-sdk-dir))
+      (dap--put-if-absent :flutterTrackWidgetCreation lsp-dart-dap-flutter-track-widget-creation)
+      (dap--put-if-absent :useFlutterStructuredErrors lsp-dart-dap-flutter-structured-errors)))
+
 (defun lsp-dart-dap--capabilities-debugger-args (conf)
   "Add capabilities args on CONF checking dart SDK version."
   (-> conf
@@ -147,21 +154,18 @@ Required to support 'Inspect Widget'."
 
 (defun lsp-dart-dap--base-debugger-args (conf)
   "Return the base args for debugging merged with CONF."
-  (let ((conf conf))
-    (dap--put-if-absent conf :request "launch")
-    (dap--put-if-absent conf :dartSdkPath (lsp-dart-get-sdk-dir))
-    (dap--put-if-absent conf :maxLogLineLength lsp-dart-dap-max-log-line-length)
-    (dap--put-if-absent conf :cwd (lsp-dart-get-project-root))
-    (dap--put-if-absent conf :vmAdditionalArgs lsp-dart-dap-vm-additional-args)
-    (dap--put-if-absent conf :vmServicePort lsp-dart-dap-vm-service-port)
-    (dap--put-if-absent conf :debugExternalLibraries lsp-dart-dap-debug-external-libraries)
-    (dap--put-if-absent conf :debugSdkLibraries lsp-dart-dap-debug-sdk-libraries)
-    (dap--put-if-absent conf :evaluateGettersInDebugViews lsp-dart-dap-evaluate-getters-in-debug-views)
-    (dap--put-if-absent conf :evaluateToStringInDebugViews lsp-dart-dap-evaluate-tostring-in-debug-views)
-    (dap--put-if-absent conf :flutterSdkPath (lsp-dart-get-flutter-sdk-dir))
-    (dap--put-if-absent conf :flutterTrackWidgetCreation lsp-dart-dap-flutter-track-widget-creation)
-    (dap--put-if-absent conf :useFlutterStructuredErrors lsp-dart-dap-flutter-structured-errors)
-    (lsp-dart-dap--capabilities-debugger-args conf)))
+  (dap--put-if-absent conf :request "launch")
+  (dap--put-if-absent conf :dartSdkPath (lsp-dart-get-sdk-dir))
+  (dap--put-if-absent conf :maxLogLineLength lsp-dart-dap-max-log-line-length)
+  (dap--put-if-absent conf :cwd (lsp-dart-get-project-root))
+  (dap--put-if-absent conf :vmAdditionalArgs lsp-dart-dap-vm-additional-args)
+  (dap--put-if-absent conf :vmServicePort lsp-dart-dap-vm-service-port)
+  (dap--put-if-absent conf :debugExternalLibraries lsp-dart-dap-debug-external-libraries)
+  (dap--put-if-absent conf :debugSdkLibraries lsp-dart-dap-debug-sdk-libraries)
+  (dap--put-if-absent conf :evaluateGettersInDebugViews lsp-dart-dap-evaluate-getters-in-debug-views)
+  (dap--put-if-absent conf :evaluateToStringInDebugViews lsp-dart-dap-evaluate-tostring-in-debug-views)
+  (lsp-dart-dap--flutter-debugger-args conf)
+  (lsp-dart-dap--capabilities-debugger-args conf))
 
 (defun lsp-dart-dap--enable-mode (&rest _)
   "Enable `lsp-dart-dap-mode'."
@@ -186,6 +190,7 @@ Required to support 'Inspect Widget'."
       (dap--put-if-absent :type "dart")
       (dap--put-if-absent :name "Dart")
       (dap--put-if-absent :dap-server-path lsp-dart-dap-dart-debugger-program)
+      (dap--put-if-absent :output-filter-function #'lsp-dart-dap--output-filter-function)
       (dap--put-if-absent :program (lsp-dart-get-project-entrypoint))))
 
 (dap-register-debug-provider "dart" 'lsp-dart-dap--populate-dart-start-file-args)
@@ -221,21 +226,28 @@ Call CALLBACK when the device is chosen and started successfully."
    (lambda (devices)
      (if (seq-empty-p devices)
          (lsp-dart-log "No devices found. Try to create a device first via `flutter emulators` command")
-       (let ((chosen-device (dap--completing-read "Select a device to use: "
+       (let ((chosen-device (dap--completing-read "Select a device to debug/run: "
                                                   devices
                                                   (-lambda ((&FlutterDaemonDevice :id :name :is-device? :platform-type platform))
                                                     (lsp-dart-dap--device-label id name is-device? platform))
                                                   nil
                                                   t)))
          (lsp-dart-flutter-daemon-launch chosen-device callback))))))
 
+(defun lsp-dart-dap--output-filter-function (msg)
+  "Output filter for dap-mode when parsing MSG."
+  (if lsp-dart-dap-only-essential-log
+      msg
+    ""))
+
 (defun lsp-dart-dap--populate-flutter-start-file-args (conf)
   "Populate CONF with the required arguments for Flutter debug."
   (let ((pre-conf (-> conf
                       lsp-dart-dap--base-debugger-args
                       (dap--put-if-absent :type "flutter")
                       (dap--put-if-absent :flutterMode "debug")
                       (dap--put-if-absent :dap-server-path lsp-dart-dap-flutter-debugger-program)
+                      (dap--put-if-absent :output-filter-function #'lsp-dart-dap--output-filter-function)
                       (dap--put-if-absent :program (lsp-dart-get-project-entrypoint)))))
     (lambda (start-debugging-callback)
       (lsp-dart-dap--flutter-get-or-start-device
@@ -274,12 +286,24 @@ Call CALLBACK when the device is chosen and started successfully."
   (when lsp-dart-dap--flutter-progress-reporter
     (progress-reporter-update lsp-dart-dap--flutter-progress-reporter)))
 
+(defun lsp-dart-dap--parse-log-message (raw)
+  "Parse log RAW from debugger events."
+  (let ((msg (--> raw
+                  (replace-regexp-in-string (regexp-quote "<== ") "" it nil)
+                  (replace-regexp-in-string (regexp-quote "==> ") "" it nil)
+                  (replace-regexp-in-string (regexp-quote "\^M") "" it nil))))
+    (condition-case nil
+        (if (booleanp (lsp--read-json msg))
+            nil)
+      ('error msg))))
+
 (cl-defmethod dap-handle-event ((_event (eql dart.log)) _session params)
   "Handle debugger uris EVENT for SESSION with PARAMS."
-  (when lsp-dart-dap-flutter-verbose-log
-    (-let* (((&hash "message") params)
-            (msg (replace-regexp-in-string (regexp-quote "\n") "" message nil 'literal)))
-      (lsp-dart-dap-log msg))))
+  (unless lsp-dart-dap-only-essential-log
+    (when-let (dap-session (dap--cur-session))
+      (-let* (((&hash "message") params))
+        (when-let (msg (lsp-dart-dap--parse-log-message message))
+          (dap--print-to-output-buffer dap-session msg))))))
 
 (cl-defmethod dap-handle-event ((_event (eql dart.progressStart)) _session params)
   "Handle debugger uris EVENT for SESSION with PARAMS."
@@ -355,23 +379,25 @@ Call CALLBACK when the device is chosen and started successfully."
 
 ;; Public
 
-(defun lsp-dart-dap-run-dart (path)
-  "Start Dart application without debugging from PATH."
+(defun lsp-dart-dap-run-dart (&optional path args)
+  "Start Dart application without debugging.
+Run program PATH if not nil passing ARGS if not nil."
   (-> (list :type "dart"
             :name "Dart Run"
             :program path
-            :noDebug t
-            :shouldConnectDebugger nil)
+            :args args
+            :noDebug t)
       lsp-dart-dap--populate-dart-start-file-args
       dap-start-debugging))
 
-(defun lsp-dart-dap-run-flutter (path)
-  "Start Flutter app without debugging from PATH."
+(defun lsp-dart-dap-run-flutter (&optional path args)
+  "Start Flutter app without debugging.
+Run program PATH if not nil passing ARGS if not nil."
   (-> (list :type "flutter"
             :name "Flutter Run"
             :program path
-            :noDebug t
-            :shouldConnectDebugger nil)
+            :args args
+            :noDebug t)
       lsp-dart-dap--populate-flutter-start-file-args
       (funcall #'dap-start-debugging)))
 

lsp-dart.el

@@ -194,6 +194,20 @@ If the version number could not be determined, signal an error."
                                      project-entrypoint-string)
                                "\n"))))
 
+;;;###autoload
+(defun lsp-dart-run (&optional args)
+  "Run application without debug mode.
+
+ARGS is an optional space-delimited string of the same flags passed to
+`flutter` when running from CLI.  Call with a prefix to be prompted for
+args."
+  (interactive
+   (list (when current-prefix-arg
+           (split-string (read-string "Args: ") " "))))
+  (if (lsp-dart-flutter-project-p)
+      (lsp-dart-dap-run-flutter nil args)
+    (lsp-dart-dap-run-dart nil args)))
+
 
 ;;;###autoload(with-eval-after-load 'lsp-mode (require 'lsp-dart))