Merge pull request #2 from ericdallo/screenshot-option

Screenshot option

Author: ericdallo

.github/workflows/test.yml

@@ -2,9 +2,6 @@ name: Tests CI
 
 on:
   push:
-    paths-ignore:
-    - '**/*.md'
-    - '**/*.org'
 
 jobs:
   build:

README.md

@@ -29,12 +29,15 @@ For example you can bind `hover-run-or-hot-reload` to `C-M-z` in dart-mode. Whil
 | Variable  |  Description  | Default value |
 | ------------------- | ------------------- | ----------------|
 | `hover-command-path` |  Path to the hover executable command | tries to use `hover` if exists in $PATH |
-|  `hover-flutter-sdk-path` |  Path to flutter sdk path to find flutter executable command | tries to find `flutter` executable in $PATH |
+| `hover-flutter-sdk-path` |  Path to flutter sdk path to find flutter executable command | tries to find `flutter` executable in $PATH |
 | `hover-hot-reload-on-save` | On buffer save, triggers hover hot-reload (if hover is running) | nil |
+| `hover-screenshot-path` | If non-nil, save hover screenshot on specified folder. | project root |
+| `hover-screenshot-prefix` | Prefix for file name on `hover-take-screenshot`. | hover- |
+| `hover-observatory-uri` | Hover custom observatory-uri. | http://127.0.0.1:50300 |
 
 # Example
 
-The following example uses all available configurations above, you can customize as you wish.
+The following example uses **all available** configurations above, you can customize as you wish.
 
 ```elisp
 ;; Assuming usage with dart-mode
@@ -47,11 +50,15 @@ The following example uses all available configurations above, you can customize
   :after dart-mode
   :bind (:map dart-mode-map
               ("C-M-z" . #'hover-run-or-hot-reload)
-              ("C-M-x" . #'hover-run-or-hot-restart))
+              ("C-M-x" . #'hover-run-or-hot-restart)
+              ("C-M-p" . #'hover-take-screenshot'))
   :init
   (setq flutter-sdk-path (concat (getenv "HOME") "/flutter") ; remove if `flutter` is already in $PATH
         hover-command-path (concat (getenv "GOPATH") "/bin/hover") ; remove if `hover` is already in $PATH
-        hover-hot-reload-on-save t))
+        hover-hot-reload-on-save t
+        hover-screenshot-path (concat (getenv "HOME") "/Pictures"
+        hover-screenshot-prefix "my-prefix-"
+        hover-observatory-uri "http://my-custom-host:50300")))
 ```
 
 _Thanks to [flutter.el](https://github.com/amake/flutter.el) which inspired this project._

hover.el

@@ -55,6 +55,23 @@
   :type '(choice (const nil) (other t))
   :group 'hover)
 
+(defcustom hover-screenshot-path nil
+  "If non-nil, save hover screenshot on specified folder.
+Default to project root."
+  :type 'string
+  :group 'hover)
+
+(defcustom hover-screenshot-prefix "hover-"
+  "Prefix for file name on `hover-take-screenshot`."
+  :type 'string
+  :group 'hover)
+
+(defcustom hover-observatory-uri "http://127.0.0.1:50300"
+  "Hover custom observatory-uri.
+Default is hover's default uri"
+  :type 'string
+  :group 'hover)
+
 (defvar hover-mode-map (copy-keymap comint-mode-map)
   "Basic mode map for `hover-run'.")
 
@@ -103,7 +120,7 @@ The function's name will be NAME prefixed with 'hover-'."
 
 (defun hover--project-get-root ()
   "Find the root of the current project."
-  (or (locate-dominating-file default-directory "go")
+  (or (expand-file-name (locate-dominating-file default-directory "go"))
       (error "This does not appear to be a Hover project (go folder not found), did you already run `hover init`?")))
 
 (defun hover--running-p ()
@@ -122,6 +139,18 @@ The function's name will be NAME prefixed with 'hover-'."
   (when (hover--running-p)
     (hover--run-command-on-hover-buffer "r")))
 
+(defun hover--build-screenshot-file-name ()
+  "Build screenshot file name with a timestamp."
+  (let ((formatted-timestamp (format-time-string "%Y-%m-%dT%T")))
+    (concat hover-screenshot-prefix formatted-timestamp ".png")))
+
+(defun hover--take-screenshot (file-path uri)
+  "Run `fluter screenshot` to take a screenshot of hover application.
+Save on FILE-PATH and use the observatory URI given."
+  (compilation-start
+   (format "%s screenshot --type=rasterizer --out=%s --observatory-uri=%s" (hover-build-flutter-command) file-path uri)
+   t))
+
 
 ;;; Key bindings
 
@@ -140,7 +169,6 @@ The function's name will be NAME prefixed with 'hover-'."
     ("z" . elevation-checker)
     ("P" . performance-overlay)
     ("a" . timeline-events)
-    ("s" . screenshot)
     ("d" . detatch)
     ("q" . quit)))
 
@@ -169,6 +197,12 @@ the `hover` process."
         "hover"
       (error (format "Hover command not found in go path '%s'. Try to configure `hover-command-path`" hover-command-path)))))
 
+(defun hover-build-flutter-command ()
+  "Check if command exists and return the flutter command."
+  (if hover-flutter-sdk-path
+      (concat (file-name-as-directory hover-flutter-sdk-path) "bin/flutter")
+    "flutter"))
+
 ;;;###autoload
 (defun hover-run (&optional args)
   "Execute `hover run` inside Emacs.
@@ -199,6 +233,19 @@ args."
      (hover--run-command-on-hover-buffer "R")
     (hover-run)))
 
+; flutter screenshot --observatory-uri=http://127.0.0.1:50300 --type=rasterizer
+;;;###autoload
+(defun hover-take-screenshot ()
+  "Take screenshot of current `hover` application using `flutter screenshot`.
+Saves screenshot on `hover-screenshot-path`."
+  (interactive)
+  (let* ((screenshot-path (or (if hover-screenshot-path
+                                  (file-name-as-directory hover-screenshot-path))
+                              (hover--project-get-root)))
+         (file-name (hover--build-screenshot-file-name))
+         (file-path (concat screenshot-path file-name)))
+    (hover--take-screenshot file-path hover-observatory-uri)))
+
 ;;;###autoload
 (define-derived-mode hover-mode comint-mode "Hover"
   "Major mode for `hover-run'."