GitLab's annual major release is around the corner. Along with a lot of new and exciting features, there will be a few breaking changes. Learn more here.

my-spacemacs-user-config.org 18 KB
Newer Older
1 2
#+TITLE: My Spacemacs User Config
#+property: header-args:elisp :tangle ~/.spacemacs.d/user-config.el :comments org
3
#+LAST_MODIFIED: [2021-03-20 Sat 16:06]
4 5 6

* Preamble

Neil Mather's avatar
Neil Mather committed
7
This is the [[file:literate-configuration.org][literate]] source for my [[file:spacemacs.org][spacemacs]] user config.  I use [[file:org-babel.org][org-babel]] to tangle it together into the actual config file.
8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134

#+begin_src elisp :exports none
  ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
  ;;; GENERATED FROM USER-CONFIG.ORG - DON'T EDIT THIS DIRECTLY!
  ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
#+end_src

#+TOC: headlines 2

* Coding

** PHP

*** Set up keyboard shortcuts for PHPUnit
#+begin_src elisp
  (with-eval-after-load 'php-mode
    (define-key php-mode-map (kbd "C-c C-t t") 'phpunit-current-test)
    (define-key php-mode-map (kbd "C-c C-t c") 'phpunit-current-class)
    (define-key php-mode-map (kbd "C-c C-t p") 'phpunit-current-project))
#+end_src

*** Use web-mode for Laravel templates.
#+begin_src elisp
  (add-to-list 'auto-mode-alist '("\\.blade.php\\'" . web-mode))
#+end_src
    
* Productivity

** org
    
*** Agenda

**** Use org-super-agenda a nicer looking agenda.
#+begin_src elisp
  (org-super-agenda-mode)
  (setq org-agenda-custom-commands
        '(("g" "Super groups"
           agenda ""
           ((org-super-agenda-groups
             '((:auto-property "agenda-group")))))
          ("u" "Super view"
           agenda ""
           ((org-super-agenda-groups
             '(;; Each group has an implicit boolean OR operator between its selectors.
               (:name "Today"  ; Optionally specify section name
                      :time-grid t  ; Items that appear on the time grid
                      :tag "today"
                      :todo "TODAY")  ; Items that have this TODO keyword
               (:name "Important"
                      ;; Single arguments given alone
                      :tag "bills"
                      :priority "A")
               ;; Set order of multiple groups at once
               (:name "Quick wins (< 20 mins)"
                      :effort< "0:20")
               (:name "Cleaning"
                      :tag "cleaning"
                      :order 5)
               (:name "Chores"
                      :tag "chore"
                      :order 5)
               (:name "Stuck"
                      :tag "stuck"
                      :order 2)
               (:name "Town"
                      :tag ("town" "@town")
                      :order 9)
               (:order-multi (2 (:name "Shopping in town"
                                       ;; Boolean AND group matches items that match all subgroups
                                       :and (:tag "shopping" :tag "@town"))
                                ;;(:name "Personal"
                                ;;       :habit t
                                ;;       :tag "personal")
                                (:name "Food-related"
                                       ;; Multiple args given in list with implicit OR
                                          :tag ("food" "dinner"))))
                  ;; Groups supply their own section names when none are given
                  (:todo "WAITING" :order 8)  ; Set order of this section
                  (:todo ("SOMEDAY" "TO-READ" "CHECK" "TO-WATCH" "WATCHING")
                        ;; Show this group at the end of the agenda (since it has the
                        ;; highest number). If you specified this group last, items
                        ;; with these todo keywords that e.g. have priority A would be
                        ;; displayed in that group instead, because items are grouped
                        ;; out in the order the groups are listed.
                        :order 9)
                  (:priority<= "B"
                              ;; Show this section after "Today" and "Important", because
                              ;; their order is unspecified, defaulting to 0. Sections
                              ;; are displayed lowest-number-first.
                              :order 3)
                  ;; After the last group, the agenda will display items that didn't
                  ;; match any of these groups, with the default order position of 99
                  ))))))
  #+end_src

*** Capturing
   
**** capture templates
 #+begin_src elisp
   (require 'org-protocol)
   (add-to-list 'load-path "/home/neil/.emacs.d/private/org-protocol-capture-html")
   (require 'org-protocol-capture-html)

   (setq org-capture-templates
         (quote
          (("c" "TODO scheduled today"
            entry (file+headline "~/org/_GTD.org" "Inbox")
            "** TODO %?\n SCHEDULED: %t\n")
           ("w" "Web site"
            entry (file+olp "/home/shared/commonplace/clippings.org" "Clippings")
            "** %c :website:\n%U %?%:initial"))))

   ;; to start in insert mode when creating via capture template
   (add-hook 'org-capture-mode-hook 'evil-insert-state)
 #+end_src

*** Refiling
   
 #+begin_src elisp
   (setq org-refile-targets '((nil :maxlevel . 9)
                              (org-agenda-files :maxlevel . 9)))
   (setq org-outline-path-complete-in-steps nil)         ; Refile in a single go
   (setq org-refile-use-outline-path t)                  ; Show full paths for refiling

 #+end_src

*** Babel
135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150
#+begin_src elisp
;; babel
(with-eval-after-load 'org
  (org-babel-do-load-languages
   'org-babel-load-languages
   '((sql . t)
     (python . t)
     (plantuml . t)
     (sqlite . t)
     (shell . t))))
#+end_src

Without this, the indentation in org-babel src blocks always gets indented without me wanting it to.  See: https://github.com/syl20bnr/spacemacs/issues/13255

#+begin_src elisp
(setq org-src-preserve-indentation t)
151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227
 #+end_src

*** Misc
**** Deleting links
See: https://emacs.stackexchange.com/questions/10707/in-org-mode-how-to-remove-a-link
 #+begin_src elisp
   (defun ngm/org-delete-link ()
     "Replace an org link of the format [[LINK][DESCRIPTION]] with DESCRIPTION.
       If the link is of the format [[LINK]], delete the whole org link.

       In both the cases, save the LINK to the kill-ring.

       Execute this command while the point is on or after the hyper-linked org link."
     (interactive)
     (when (derived-mode-p 'org-mode)
       (let ((search-invisible t) start end)
         (save-excursion
           (when (re-search-backward "\\[\\[" nil :noerror)
             (when (re-search-forward "\\[\\[\\(.*?\\)\\(\\]\\[.*?\\)*\\]\\]" nil :noerror)
               (setq start (match-beginning 0))
               (setq end   (match-end 0))
               (kill-new (match-string-no-properties 1)) ; Save the link to kill-ring
               (replace-regexp "\\[\\[.*?\\(\\]\\[\\(.*?\\)\\)*\\]\\]" "\\2" nil start end)))))))
#+end_src

**** org-timeline
#+begin_src elisp
     (require 'org-timeline)
     (add-hook 'org-agenda-finalize-hook 'org-timeline-insert-timeline :append)
 #+end_src

* Writing and knowledge management

   I do my writing mostly in org-journal and org-roam.
   
#+begin_src elisp
  (setq org-journal-file-format "%Y-%m-%d.org")
#+end_src

** Writing mode

   A couple of customisations to make writing prose a nice experience.
   
#+begin_src elisp

    (defun ngm-visual-line-motion ()
      "So j and k move up and down more like you'd expect in visual line mode"
      (interactive)
      (define-key evil-motion-state-map "j" 'evil-next-visual-line)
      (define-key evil-motion-state-map "k" 'evil-previous-visual-line))

    (defun ngm-journal-mode ()
      "Set up journalling mode the way that I like it"
      (interactive)
      (olivetti-mode)
      (variable-pitch-mode 1)
      (face-remap-add-relative 'variable-pitch '(:family "Roboto Slab" :height 140))
      (ngm-visual-line-motion)
      (setq company-backends '(company-capf)) ; for org-roam completion
      )

    #+end_src

** org-roam
   
org-roam builds on top of org-mode, but I feel like it deserves it's own section.
   
*** Prefer immediate DB update method.

This updates the DB on save, rather than on an idle timer.  I was finding idle timer frustrating, as the unexpected DB update interrupted my flow.  Updating on save works better for me, as I tend to pause momentarily after a save anyway, as I usually save at the end of a sentence.
#+begin_src elisp
  (setq org-roam-db-update-method 'immediate)
#+end_src

*** Wikilink syntax for adding links

For inserting links to other wiki pages more quickly, essentially with wikilink syntax.
Neil Mather's avatar
Neil Mather committed
228
See: [[file:using-fuzzy-links-aka-wikilinks-in-org-roam.org][Using fuzzy links AKA wikilinks in org-roam]].
229 230 231 232 233 234 235 236 237 238 239 240
#+begin_src elisp
  (require 'key-chord)
  (key-chord-mode 1)
  (key-chord-define org-mode-map "[[" #'ngm/insert-roam-link)

  (defun ngm/insert-roam-link ()
    "Inserts an Org-roam link."
    (interactive)
    (insert "[[roam:]]")
    (backward-char 2))
#+end_src

Neil Mather's avatar
Neil Mather committed
241 242 243 244 245
*** Tags
#+begin_src elisp
  (setq org-roam-tag-sources '(prop last-directory))
#+end_src

246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286
*** org-roam capture templates

    Add CREATED and LAST_MODIFIED properties to the new note.
#+begin_src elisp
  (setq org-roam-capture-templates
        '(("d" "default" plain (function org-roam--capture-get-point)
            "%?"
            :file-name "${slug}"
            :head "#+title: ${title}\n#+CREATED: %U\n#+LAST_MODIFIED: %U\n\n"
            :unnarrowed t)))

  (setq org-roam-dailies-directory "journal")
  (setq org-roam-dailies-capture-templates '(("d" "daily" plain (function org-roam-capture--get-point) ""
                                              :immediate-finish t
                                              :file-name "journal/%<%Y-%m-%d>"
                                              :head "#+TITLE: %<%Y-%m-%d>")))

 #+end_src

 #+RESULTS:
 
*** Updating timestamps on save

    I would prefer to do this on org-roam files only.
    See  [[https://org-roam.discourse.group/t/update-a-field-last-modified-at-save/321/19][Update a field (#+LAST_MODIFIED: ) at save - How To - Org-roam]].
    Doesn't seem to work though.
#+begin_src elisp
  (setq time-stamp-active t
        time-stamp-start "#\\+LAST_MODIFIED:[ \t]*"
        time-stamp-end "$"
        time-stamp-format "\[%04y-%02m-%02d %3a %02H:%02M\]")
  (add-hook 'before-save-hook 'time-stamp nil)
#+end_src

*** Graph settings

Exclude some of the big files from the graph.
#+begin_src elisp
  (setq org-roam-graph-exclude-matcher '("sitemap" "index" "recentchanges"))
#+end_src

Neil Mather's avatar
Neil Mather committed
287 288 289 290 291 292 293 294 295 296 297
*** org-roam-server

#+begin_src elisp
  (setq org-roam-server-light-dir "~/Code/org-roam-server-light")

  (setq org-roam-server-light-network-vis-options
        "{ \"edges\": { \"arrows\": { \"to\": { \"enabled\": true,\"scaleFactor\": 1.5 } } } }"
        ;; change background color of web application
        org-roam-server-light-style "body.darkmode { background-color: #121212!important; }"
        ;; set default set of excluded or included tags
        ;; customize only the value of id, in this case "test" and "journal"
Neil Mather's avatar
Neil Mather committed
298
        org-roam-server-light-default-exclude-filters "[{ \"tags\": \"journal\", \"id\" : \"Recent changes\", \"id\":\"recentchanges\"  }]"
Neil Mather's avatar
Neil Mather committed
299 300 301 302
        )
  ;; finally load the main elisp file
  (load (expand-file-name "org-roam-server-light.el" org-roam-server-light-dir))

Neil Mather's avatar
Neil Mather committed
303
  (setq org-roam-server-default-exclude-filters "[{ \"tags\": \"journal\", \"id\" : \"Recent changes\", \"id\":\"recentchanges\"  }]")
Neil Mather's avatar
Neil Mather committed
304 305
#+end_src

306 307
* Look'n'feel

Neil Mather's avatar
Neil Mather committed
308
** Themes
309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367
#+begin_src elisp
    (doom-themes-treemacs-config)
    (doom-themes-org-config)
#+end_src

** Solaire
   
See https://github.com/hlissner/emacs-solaire-mode
#+begin_src elisp
  (require 'solaire-mode)
  ;; Enable solaire-mode anywhere it can be enabled
  (solaire-global-mode +1)
  ;; To enable solaire-mode unconditionally for certain modes:
  (add-hook 'ediff-prepare-buffer-hook #'solaire-mode)

  ;; ...if you use auto-revert-mode, this prevents solaire-mode from turning
  ;; itself off every time Emacs reverts the file
  (add-hook 'after-revert-hook #'turn-on-solaire-mode)

  ;; highlight the minibuffer when it is activated:
  (add-hook 'minibuffer-setup-hook #'solaire-mode-in-minibuffer)

  ;; if the bright and dark background colors are the wrong way around, use this
  ;; to switch the backgrounds of the `default` and `solaire-default-face` faces.
  ;; This should be used *after* you load the active theme!
  ;;
  ;; NOTE: This is necessary for themes in the doom-themes package!
  (solaire-mode-swap-bg)
#+end_src

** Tabs (centaur)
   
   Not currently using this, as I think it broke something.
#+begin_src elisp
  ;; centaur-tabs configuration
  ;; https://github.com/ema2159/centaur-tabs
                                        ;(require 'centaur-tabs)
                                        ;(centaur-tabs-mode t)
                                        ;(global-set-key (kbd "C-<prior>")  'centaur-tabs-backward)
                                        ;(global-set-key (kbd "C-<next>") 'centaur-tabs-forward)
                                        ;(centaur-tabs-mode)
                                        ;(centaur-tabs-headline-match)
                                        ;(setq centaur-tabs-set-modified-marker t
                                        ;      centaur-tabs-modified-marker " ● "
                                        ;      centaur-tabs-cycle-scope 'tabs
                                        ;      centaur-tabs-height 35
                                        ;      centaur-tabs-set-icons t
                                        ;      centaur-tabs-close-button " × ")
                                        ;(dolist (centaur-face '(centaur-tabs-selected
                                        ;                        centaur-tabs-selected-modified
                                        ;                        centaur-tabs-unselected
                                        ;                        centaur-tabs-unselected-modified))
                                        ;  (set-face-attribute centaur-face nil :family "Noto Sans Mono" :height 100))

#+end_src

** Helm
  
 #+begin_src elisp
Neil Mather's avatar
Neil Mather committed
368 369 370 371 372 373 374 375 376 377 378 379 380
       (defun open-local-file-projectile (directory)
         "Helm action function, open projectile file within DIRECTORY
     specify by the keyword projectile-default-file define in
     `dir-locals-file'"
         (let ((default-file (f-join directory (nth 1
                                                     (car (-tree-map (lambda (node)
                                                                       (when (eq (car node) 'projectile-default-file)
                                                                         (format "%s" (cdr node))))
                                                                     (dir-locals-get-class-variables (dir-locals-read-from-dir directory))))))))
           (if (f-exists? default-file)
               (find-file default-file)
             (message "The file %s doesn't exist in the select project" default-file)
             )
381 382 383
           )
         )

Neil Mather's avatar
Neil Mather committed
384 385 386 387 388
   (with-eval-after-load "helm-projectile"
     (helm-add-action-to-source "Open default file"
                                 'open-local-file-projectile
                                 helm-source-projectile-projects)
     )
389

Neil Mather's avatar
Neil Mather committed
390
       ;; (add-to-list 'helm-source-projectile-projects-actions '("Open default file" . open-local-file-projectile) t)
391 392


Neil Mather's avatar
Neil Mather committed
393 394 395 396 397 398 399 400 401 402 403
    ;; https://github.com/syl20bnr/spacemacs/issues/13100
    ;(setq completion-styles '(helm-flex))


     #+end_src
     
*** Remove duplicates in helm command history
    
See: https://github.com/syl20bnr/spacemacs/issues/13564
#+begin_src elisp
  (setq history-delete-duplicates t)
404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483
 #+end_src


* Communications
  
** mu4e (mail)
  
 #+begin_src elisp
     ;; mu4e
     (setq mu4e-maildir "~/Maildir"
           mu4e-attachment-dir "~/downloads"
           mu4e-sent-folder "/Sent"
           mu4e-drafts-folder "/Drafts"
           mu4e-trash-folder "/Trash"
           mu4e-refile-folder "/Archive")

     (setq user-mail-address "neil@doubleloop.net"
           user-full-name  "Neil Mather")

     ;; Get mail
     (setq mu4e-get-mail-command "mbsync protonmail"
           mu4e-change-filenames-when-moving t   ; needed for mbsync
           mu4e-update-interval 120)             ; update every 2 minutes

     (defun htmlize-and-send ()
       "When in an org-mu4e-compose-org-mode message, htmlize and send it."
       (interactive)
       (when (member 'org~mu4e-mime-switch-headers-or-body post-command-hook)
         (org-mime-htmlize)
         (message-send-and-exit)))

     (add-hook 'org-ctrl-c-ctrl-c-hook 'htmlize-and-send t)

     ;; composing mail
                                           ;(setq mu4e-compose-format-flowed nil)
                                           ;(add-hook 'mu4e-compose-mode-hook (lambda () (turn-off-auto-fill) (use-hard-newlines -1)))
     ;; enable format=flowed
     ;; - mu4e sets up visual-line-mode and also fill (M-q) to do the right thing
     ;; - each paragraph is a single long line; at sending, emacs will add the
     ;;   special line continuation characters.
     ;; - also see visual-line-fringe-indicators setting below
     (setq mu4e-compose-format-flowed t)
     ;; because it looks like email clients are basically ignoring format=flowed,
     ;; let's complicate their lives too. send format=flowed with looong lines. :)
     ;; https://www.ietf.org/rfc/rfc2822.txt
     (setq fill-flowed-encode-column 998)
     ;; in mu4e with format=flowed, this gives me feedback where the soft-wraps are
     (setq visual-line-fringe-indicators '(left-curly-arrow right-curly-arrow))

     ;; Send mail
     (setq message-send-mail-function 'smtpmail-send-it
           smtpmail-auth-credentials "~/.authinfo" ;; Here I assume you encrypted the credentials
           smtpmail-smtp-server "127.0.0.1"
           smtpmail-smtp-service 1025)

     ;; look'n'feel
     (setq mu4e-html2text-command 'mu4e-shr2text)
     (setq shr-color-visible-luminance-min 60)
     (setq shr-color-visible-distance-min 5)
     (setq shr-use-colors nil)
     (advice-add #'shr-colorize-region :around (defun shr-no-colourise-region (&rest ignore)))

 #+end_src

** IRC (erc)
  
#+begin_src elisp
    (setq erc-hide-list '("JOIN" "PART" "QUIT"))
#+end_src

* Misc
  
** Tidal
#+begin_src elisp
    ;; tidal
    ;;(add-to-list 'load-path "/home/neil/.emacs.d/private/tidal")
    ;;(require 'tidal)
#+end_src