[copilot] Add keybindings and proper config instructions

Author: smile13241324

layers/+web-services/github-copilot/README.org

@@ -6,6 +6,8 @@
 - [[#description][Description]]
   - [[#features][Features:]]
 - [[#install][Install]]
+  - [[#configuratiom][Configuratiom]]
+- [[#key-bindings][Key bindings]]
 
 * Description
 This layer enables usage of [[https://github.com/features/copilot][GitHub Copilot]] in Spacemacs using [[https://github.com/copilot-emacs/copilot.el][copilot.el]].
@@ -17,3 +19,33 @@ This layer enables usage of [[https://github.com/features/copilot][GitHub Copilo
 To use this configuration layer, add it to your =~/.spacemacs=. You will need to
 add =github-copilot= to the existing =dotspacemacs-configuration-layers= list in this
 file.
+
+In addition the github/copilot-language-server must be installed either manually with:
+#+BEGIN_SRC sh
+  $ npm install -g @github/copilot-language-server
+#+END_SRC
+
+or via elisp by pressing:
+#+BEGIN_SRC elisp
+  SPC SPC copilot-install-server
+#+END_SRC
+
+** Configuratiom
+Per default the service will run for every mode derived from prog mode. It will do
+automatic code suggestions. Key bindings for accepting an advice are bound automatically
+but can be rebound.
+
+In order to work properly =SPC SPC copilot login= must be have been run once on the device
+especially if a commercial license is available.
+
+    The mode itself tries to defer the language from the major mode however if this fails it may
+    be necessary to add the new binding manually. Details for this can be found [[https://github.com/copilot-emacs/copilot.el?tab=readme-ov-file#programming-language-detection][here]].
+
+* Key bindings
+
+| Key binding         | Description                                                           |
+|---------------------+-----------------------------------------------------------------------|
+| ~C-M-<return>~      | accept the current completion suggestion                              |
+| ~C-M-S-<return>~    | accept the current completion suggestion word by word                 |
+| ~C-<iso-lefttab>~   | show the next github copilot completion (and refresh completions)     |
+| ~C-M-<iso-lefttab>~ | show the previous github copilot completion (and refresh completions) |

layers/+web-services/github-copilot/packages.el

@@ -26,7 +26,30 @@
 
 (defun github-copilot/init-copilot ()
   (use-package copilot
+    :hook '(prog-mode-hook . copilot-mode)
     :custom
     (copilot-enable-predicates '(spacemacs//copilot-enable-predicate
                                  copilot--buffer-changed))
-    :defer t))
+    :defer t
+    :config
+    (with-eval-after-load 'company
+      (define-key copilot-completion-map (kbd "C-<iso-lefttab>") 'github-copilot/next-completion)
+      (define-key copilot-completion-map (kbd "C-M-<iso-lefttab>") 'github-copilot/previous-completion)
+      (define-key copilot-completion-map (kbd "C-M-<return>") 'copilot-accept-completion)
+      (define-key copilot-completion-map (kbd "C-M-S-<return>") 'copilot-accept-completion-by-word))))
+
+(defun github-copilot/next-completion ()
+  "Move to the next completion in the Copilot completion menu.
+This function will make sure to show the next completion,
+if necessary triggering a `copilot-complete' command beforehand."
+  (interactive)
+  (copilot-complete)
+  (copilot-next-completion))
+
+(defun github-copilot/previous-completion ()
+  "Move to the previous completion in the Copilot completion menu.
+This function will make sure to show the previous completion,
+if necessary triggering a `copilot-complete' command beforehand."
+  (interactive)
+  (copilot-complete)
+  (copilot-previous-completion))