[emacs] display time and battery in mode-line
[~bandali/configs] / init.org
... / ...
CommitLineData
1#+title: =aminb='s Literate Emacs Configuration
2#+author: Amin Bandali
3#+babel: :cache yes
4#+property: header-args :tangle yes
5
6* About
7:PROPERTIES:
8:CUSTOM_ID: about
9:END:
10
11This org file is my literate configuration for GNU Emacs, and is
12tangled to [[./init.el][init.el]]. Packages are installed and managed using
13[[https://github.com/emacscollective/borg][Borg]]. Over the years, I've taken inspiration from configurations of
14many different people. Some of the configurations that I can remember
15off the top of my head are:
16
17- [[https://github.com/dieggsy/dotfiles][dieggsy/dotfiles]]: literate Emacs and dotfiles configuration, uses
18 straight.el for managing packages
19- [[https://github.com/dakra/dmacs][dakra/dmacs]]: literate Emacs configuration, using Borg for managing
20 packages
21- [[http://pages.sachachua.com/.emacs.d/Sacha.html][Sacha Chua's literate Emacs configuration]]
22- [[https://github.com/dakrone/eos][dakrone/eos]]
23- Ryan Rix's [[http://doc.rix.si/cce/cce.html][Complete Computing Environment]] ([[http://doc.rix.si/projects/fsem.html][about cce]])
24- [[https://github.com/jwiegley/dot-emacs][jwiegley/dot-emacs]]: nix-based configuration
25- [[https://github.com/wasamasa/dotemacs][wasamasa/dotemacs]]
26- [[https://github.com/hlissner/doom-emacs][Doom Emacs]]
27
28I'd like to have a fully reproducible Emacs setup (part of the reason
29why I store my configuration in this repository) but unfortunately out
30of the box, that's not achievable with =package.el=, not currently
31anyway. So, I've opted to use Borg. For what it's worth, I briefly
32experimented with [[https://github.com/raxod502/straight.el][straight.el]], but found that it added about 2 seconds
33to my init time; which is unacceptable for me: I use Emacs as my
34window manager (via EXWM) and coming from bspwm, I'm too used to
35having fast startup times.
36
37** Installation
38
39To use this config for your Emacs, first you need to clone this repo,
40then bootstrap Borg, tell Borg to retrieve package submodules, and
41byte-compiled the packages. Something along these lines should work:
42
43#+begin_src sh :tangle no
44git clone https://github.com/aminb/dotfiles ~/.emacs.d
45cd ~/.emacs.d
46make bootstrap-borg
47make tangle-init
48make bootstrap
49make build
50#+end_src
51
52* Contents :toc_1:noexport:
53
54- [[#about][About]]
55- [[#header][Header]]
56- [[#initial-setup][Initial setup]]
57- [[#core][Core]]
58- [[#post-initialization][Post initialization]]
59- [[#footer][Footer]]
60
61* Header
62:PROPERTIES:
63:CUSTOM_ID: header
64:END:
65
66** First line
67
68#+begin_src emacs-lisp :comments none
69;;; init.el --- Amin Bandali's Emacs config -*- lexical-binding: t ; eval: (view-mode 1)-*-
70#+end_src
71
72Enable =view-mode=, which both makes the file read-only (as a reminder
73that =init.el= is an auto-generated file, not supposed to be edited),
74and provides some convenient key bindings for browsing through the
75file.
76
77** License
78
79#+begin_src emacs-lisp :comments none
80;; Copyright (C) 2018 Amin Bandali <amin@aminb.org>
81
82;; This program is free software: you can redistribute it and/or modify
83;; it under the terms of the GNU General Public License as published by
84;; the Free Software Foundation, either version 3 of the License, or
85;; (at your option) any later version.
86
87;; This program is distributed in the hope that it will be useful,
88;; but WITHOUT ANY WARRANTY; without even the implied warranty of
89;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
90;; GNU General Public License for more details.
91
92;; You should have received a copy of the GNU General Public License
93;; along with this program. If not, see <https://www.gnu.org/licenses/>.
94#+end_src
95
96** Commentary
97
98#+begin_src emacs-lisp :comments none
99;;; Commentary:
100
101;; Emacs configuration of Amin Bandali, computer scientist and functional
102;; programmer.
103
104;; THIS FILE IS AUTO-GENERATED FROM `init.org'.
105#+end_src
106
107** Naming conventions
108
109The conventions below were inspired by [[https://github.com/hlissner/doom-emacs][Doom]]'s conventions, found
110[[https://github.com/hlissner/doom-emacs/blob/5dacbb7cb1c6ac246a9ccd15e6c4290def67757c/core/core.el#L3-L17][here]]. Naturally, I use my initials, =ab=, instead of =doom=.
111
112#+begin_src emacs-lisp :comments none
113;; Naming conventions:
114;;
115;; ab-... public variables or non-interactive functions
116;; ab--... private anything (non-interactive), not safe for direct use
117;; ab/... an interactive function; safe for M-x or keybinding
118;; ab:... an evil operator, motion, or command
119;; ab|... a hook function
120;; ab*... an advising function
121;; ab@... a hydra command
122;; ...! a macro
123#+end_src
124
125* Initial setup
126:PROPERTIES:
127:CUSTOM_ID: initial-setup
128:END:
129
130#+begin_src emacs-lisp :comments none
131;;; Code:
132#+end_src
133
134** Emacs initialization
135
136I'd like to do a couple of measurements of Emacs' startup time. First,
137let's see how long Emacs takes to start up, before even loading
138=init.el=, i.e. =user-init-file=:
139
140#+begin_src emacs-lisp
141(defvar ab--before-user-init-time (current-time)
142 "Value of `current-time' when Emacs begins loading `user-init-file'.")
143(message "Loading Emacs...done (%.3fs)"
144 (float-time (time-subtract ab--before-user-init-time
145 before-init-time)))
146#+end_src
147
148Also, temporarily increase ~gc-cons-threshhold~ and
149~gc-cons-percentage~ during startup to reduce garbage collection
150frequency. Clearing the ~file-name-handler-alist~ seems to help reduce
151startup time as well.
152
153#+begin_src emacs-lisp
154(defvar ab--gc-cons-threshold gc-cons-threshold)
155(defvar ab--gc-cons-percentage gc-cons-percentage)
156(defvar ab--file-name-handler-alist file-name-handler-alist)
157(setq gc-cons-threshold (* 400 1024 1024) ; 400 MiB
158 gc-cons-percentage 0.6
159 file-name-handler-alist nil
160 ;; sidesteps a bug when profiling with esup
161 esup-child-profile-require-level 0)
162#+end_src
163
164Of course, we'd like to set them back to their defaults once we're
165done initializing.
166
167#+begin_src emacs-lisp
168(add-hook
169 'after-init-hook
170 (lambda ()
171 (let ((elapsed (float-time (time-subtract (current-time)
172 ab--before-user-init-time))))
173 (message "Loading %s...done (%.3fs) [after-init]"
174 user-init-file elapsed))
175 (setq gc-cons-threshold ab--gc-cons-threshold
176 gc-cons-percentage ab--gc-cons-percentage
177 file-name-handler-alist ab--file-name-handler-alist)))
178#+end_src
179
180Increase the number of lines kept in message logs (the =*Messages*=
181buffer).
182
183#+begin_src emacs-lisp
184(setq message-log-max 20000)
185#+end_src
186
187Optionally, we could suppress some byte compiler warnings like below,
188but for now I've decided to keep them enabled. See documentation for
189~byte-compile-warnings~ for more details.
190
191#+begin_src emacs-lisp
192;; (setq byte-compile-warnings
193;; '(not free-vars unresolved noruntime lexical make-local))
194#+end_src
195
196** Package management
197
198*** No =package.el=
199
200I can do all my package management things with Borg, and don't need
201Emacs' built-in =package.el=. Emacs 27 lets us disable =package.el= in
202the =early-init-file= (see [[https://git.savannah.gnu.org/cgit/emacs.git/commit/?id=24acb31c04b4048b85311d794e600ecd7ce60d3b][here]]).
203
204#+begin_src emacs-lisp :tangle early-init.el
205(setq package-enable-at-startup nil)
206#+end_src
207
208But since Emacs 27 isn't out yet (Emacs 26 is just around the corner
209right now), and even when released it'll be long before most distros
210ship in their repos, I'll still put the old workaround with the
211commented call to ~package-initialize~ here anyway.
212
213#+begin_src emacs-lisp
214(setq package-enable-at-startup nil)
215;; (package-initialize)
216#+end_src
217
218*** Borg
219
220#+begin_quote
221Assimilate Emacs packages as Git submodules
222#+end_quote
223
224[[https://github.com/emacscollective/borg][Borg]] is at the heart of package management of my Emacs setup. In
225short, it creates a git submodule in =lib/= for each package, which
226can then be managed with the help of Magit or other tools.
227
228#+begin_src emacs-lisp
229(setq user-init-file (or load-file-name buffer-file-name)
230 user-emacs-directory (file-name-directory user-init-file))
231(add-to-list 'load-path
232 (expand-file-name "lib/borg" user-emacs-directory))
233(require 'borg)
234(borg-initialize)
235#+end_src
236
237*** =use-package=
238
239#+begin_quote
240A use-package declaration for simplifying your .emacs
241#+end_quote
242
243[[https://github.com/jwiegley/use-package][use-package]] is an awesome utility for managing and configuring
244packages (in our case especially the latter) in a neatly organized way
245and without compromising on performance.
246
247#+begin_src emacs-lisp
248(require 'use-package)
249(if nil ; set to t when need to debug init
250 (setq use-package-verbose t
251 use-package-expand-minimally nil
252 use-package-compute-statistics t
253 debug-on-error t)
254 (setq use-package-verbose nil
255 use-package-expand-minimally t))
256#+end_src
257
258*** Epkg
259
260#+begin_quote
261Browse the Emacsmirror package database
262#+end_quote
263
264Epkg provides access to a local copy of the [[https://emacsmirror.net][Emacsmirror]] package
265database, low-level functions for querying the database, and a
266=package.el=-like user interface for browsing the available packages.
267
268#+begin_src emacs-lisp
269(use-package epkg
270 :defer t)
271#+end_src
272
273** No littering in =~/.emacs.d=
274
275#+begin_quote
276Help keeping ~/.emacs.d clean
277#+end_quote
278
279By default, even for Emacs' built-in packages, the configuration files
280and persistent data are all over the place. Use =no-littering= to help
281contain the mess.
282
283#+begin_src emacs-lisp
284(use-package no-littering
285 :demand t
286 :config
287 (savehist-mode 1)
288 (add-to-list 'savehist-additional-variables 'kill-ring)
289 (save-place-mode 1)
290 (setq auto-save-file-name-transforms
291 `((".*" ,(no-littering-expand-var-file-name "auto-save/") t))))
292#+end_src
293
294** Custom file (=custom.el=)
295
296I'm not planning on using the custom file much, but even so, I
297definitely don't want it mixing with =init.el=. So, here; let's give
298it it's own file. While at it, treat themes as safe.
299
300#+begin_src emacs-lisp
301(use-package custom
302 :no-require t
303 :config
304 (setq custom-file (no-littering-expand-etc-file-name "custom.el"))
305 (when (file-exists-p custom-file)
306 (load custom-file))
307 (setf custom-safe-themes t))
308#+end_src
309
310** Better =$PATH= handling
311
312Let's use [[https://github.com/purcell/exec-path-from-shell][exec-path-from-shell]] to make Emacs use the =$PATH= as set up
313in my shell.
314
315#+begin_src emacs-lisp
316(use-package exec-path-from-shell
317 :defer 1
318 :init
319 (setq exec-path-from-shell-check-startup-files nil)
320 :config
321 (exec-path-from-shell-initialize)
322 ;; while we're at it, let's fix access to our running ssh-agent
323 (exec-path-from-shell-copy-env "SSH_AGENT_PID")
324 (exec-path-from-shell-copy-env "SSH_AUTH_SOCK"))
325#+end_src
326
327** Server
328
329Start server if not already running. Alternatively, can be done by
330issuing =emacs --daemon= in the terminal, which can be automated with
331a systemd service or using =brew services start emacs= on macOS. I use
332Emacs as my window manager (via EXWM), so I always start Emacs on
333login; so starting the server from inside Emacs is good enough for me.
334
335See [[https://www.gnu.org/software/emacs/manual/html_node/emacs/Emacs-Server.html#Emacs-Server][Using Emacs as a Server]].
336
337#+begin_src emacs-lisp
338(use-package server
339 :config (or (server-running-p) (server-mode)))
340#+end_src
341
342* Core
343:PROPERTIES:
344:CUSTOM_ID: core
345:END:
346
347** Defaults
348
349*** Time and battery in mode-line
350
351Enable displaying time and battery in the mode-line, since I'm not
352using the Xfce panel anymore. Also, I don't need to see the load
353average on a regular basis, so disable that.
354
355#+begin_src emacs-lisp
356(use-package time
357 :ensure nil
358 :init
359 (setq display-time-default-load-average nil)
360 :config
361 (display-time-mode))
362
363(use-package battery
364 :ensure nil
365 :config
366 (display-battery-mode))
367#+end_src
368
369*** Smaller fringe
370
371Might want to set the fringe to a smaller value, especially if using
372EXWM. I'm fine with the default for now.
373
374#+begin_src emacs-lisp
375;; (fringe-mode '(3 . 1))
376(fringe-mode nil)
377#+end_src
378
379*** Disable disabled commands
380
381Emacs disables some commands by default that could persumably be
382confusing for novice users. Let's disable that.
383
384#+begin_src emacs-lisp
385(setq disabled-command-function nil)
386#+end_src
387
388*** Kill-ring
389
390Save what I copy into clipboard from other applications into Emacs'
391kill-ring, which would allow me to still be able to easily access it
392in case I kill (cut or copy) something else inside Emacs before
393yanking (pasting) what I'd originally intended to.
394
395#+begin_src emacs-lisp
396(setq save-interprogram-paste-before-kill t)
397#+end_src
398
399*** Minibuffer
400
401#+begin_src emacs-lisp
402(setq enable-recursive-minibuffers t
403 resize-mini-windows t)
404#+end_src
405
406*** Lazy-person-friendly yes/no prompts
407
408Lazy people would prefer to type fewer keystrokes, especially for yes
409or no questions. I'm lazy.
410
411#+begin_src emacs-lisp
412(defalias 'yes-or-no-p #'y-or-n-p)
413#+end_src
414
415*** Startup screen and =*scratch*=
416
417Firstly, let Emacs know that I'd like to have =*scratch*= as my
418startup buffer.
419
420#+begin_src emacs-lisp
421(setq initial-buffer-choice t)
422#+end_src
423
424Now let's customize the =*scratch*= buffer a bit. First off, I don't
425need the default hint.
426
427#+begin_src emacs-lisp
428(setq initial-scratch-message nil)
429#+end_src
430
431Also, let's use Text mode as the major mode, in case I want to
432customize it (=*scratch*='s default major mode, Fundamental mode,
433can't really be customized).
434
435#+begin_src emacs-lisp
436(setq initial-major-mode 'text-mode)
437#+end_src
438
439Inhibit the buffer list when more than 2 files are loaded.
440
441#+begin_src emacs-lisp
442(setq inhibit-startup-buffer-menu t)
443#+end_src
444
445I don't really need to see the startup screen or echo area message
446either.
447
448#+begin_src emacs-lisp
449(advice-add #'display-startup-echo-area-message :override #'ignore)
450(setq inhibit-startup-screen t
451 inhibit-startup-echo-area-message user-login-name)
452#+end_src
453
454*** More useful frame titles
455
456Show either the file name or the buffer name (in case the buffer isn't
457visiting a file). Borrowed from Emacs Prelude.
458
459#+begin_src emacs-lisp
460(setq frame-title-format
461 '("" invocation-name " - "
462 (:eval (if (buffer-file-name)
463 (abbreviate-file-name (buffer-file-name))
464 "%b"))))
465#+end_src
466
467*** Backups
468
469Emacs' default backup settings aren't that great. Let's use more
470sensible options. See documentation for the ~make-backup-file~
471variable.
472
473#+begin_src emacs-lisp
474(setq backup-by-copying t
475 version-control t)
476#+end_src
477
478** Packages
479
480The packages in this section are absolutely essential to my everyday
481workflow, and they play key roles in how I do my computing. They
482immensely enhance the Emacs experience for me; both using Emacs, and
483customizing it.
484
485*** [[https://github.com/emacscollective/auto-compile][auto-compile]]
486
487#+begin_src emacs-lisp
488(use-package auto-compile
489 :demand t
490 :config
491 (auto-compile-on-load-mode)
492 (auto-compile-on-save-mode)
493 (setq auto-compile-display-buffer nil
494 auto-compile-mode-line-counter t
495 auto-compile-source-recreate-deletes-dest t
496 auto-compile-toggle-deletes-nonlib-dest t
497 auto-compile-update-autoloads t)
498 (add-hook 'auto-compile-inhibit-compile-hook
499 'auto-compile-inhibit-compile-detached-git-head))
500#+end_src
501
502*** TODO [[https://github.com/Kungsgeten/ryo-modal][ryo-modal]]
503
504#+begin_quote
505Roll your own modal mode
506#+end_quote
507
508*** [[https://github.com/ch11ng/exwm][EXWM]] (window manager)
509
510#+begin_src emacs-lisp
511(use-package exwm
512 :demand t
513 :config
514 (require 'exwm-config)
515 (exwm-config-default)
516 (require 'exwm-systemtray)
517 (exwm-systemtray-enable)
518 (require 'exwm-randr)
519 (exwm-randr-enable))
520#+end_src
521
522*** [[https://orgmode.org/][Org mode]]
523
524#+begin_quote
525Org mode is for keeping notes, maintaining TODO lists, planning
526projects, and authoring documents with a fast and effective plain-text
527system.
528#+end_quote
529
530In short, my favourite way of life.
531
532#+begin_src emacs-lisp
533(setq org-src-tab-acts-natively t
534 org-src-preserve-indentation nil
535 org-edit-src-content-indentation 0)
536#+end_src
537
538*** [[https://magit.vc/][Magit]]
539
540#+begin_quote
541It's Magit! A Git porcelain inside Emacs.
542#+end_quote
543
544Not just how I do git, but /the/ way to do git.
545
546#+begin_src emacs-lisp
547(use-package magit
548 :defer t
549 :bind (("s-g" . magit-status)
550 ("C-x g" . magit-status)
551 ("C-x M-g" . magit-dispatch-popup))
552 :config
553 (magit-add-section-hook 'magit-status-sections-hook
554 'magit-insert-modules
555 'magit-insert-stashes
556 'append))
557#+end_src
558
559*** [[https://github.com/abo-abo/swiper][Ivy]] (and friends)
560
561#+begin_quote
562Ivy - a generic completion frontend for Emacs, Swiper - isearch with
563an overview, and more. Oh, man!
564#+end_quote
565
566There's no way I could top that, so I won't attempt to.
567
568**** Ivy
569
570#+begin_src emacs-lisp
571(use-package ivy
572 :bind
573 (:map ivy-minibuffer-map
574 ([escape] . keyboard-escape-quit)
575 ("C-j" . ivy-next-line)
576 ("C-k" . ivy-previous-line)
577 ([S-up] . ivy-previous-history-element)
578 ([S-down] . ivy-next-history-element)
579 ("DEL" . ivy-backward-delete-char))
580 :config
581 (ivy-mode 1))
582#+end_src
583
584**** Swiper
585
586#+begin_src emacs-lisp
587(use-package swiper
588 :bind (([remap isearch-forward] . swiper)
589 ([remap isearch-backward] . swiper)))
590#+end_src
591
592**** Counsel
593
594#+begin_src emacs-lisp
595(use-package counsel
596 :defer 1.5
597 :bind (([remap execute-extended-command] . counsel-M-x)
598 ([remap find-file] . counsel-find-file)
599 ("s-r" . counsel-recentf)
600 :map minibuffer-local-map
601 ("C-r" . counsel-minibuffer-history))
602 :config
603 (counsel-mode 1)
604 (defalias 'locate #'counsel-locate))
605#+end_src
606
607* Borg's =layer/essentials=
608
609TODO: break this giant source block down into individual org sections.
610
611#+begin_src emacs-lisp
612(use-package dash
613 :config (dash-enable-font-lock))
614
615(use-package diff-hl
616 :config
617 (setq diff-hl-draw-borders nil)
618 (global-diff-hl-mode)
619 (add-hook 'magit-post-refresh-hook 'diff-hl-magit-post-refresh t))
620
621(use-package dired
622 :defer t
623 :config (setq dired-listing-switches "-alh"))
624
625(use-package eldoc
626 :when (version< "25" emacs-version)
627 :config (global-eldoc-mode))
628
629(use-package help
630 :defer t
631 :config (temp-buffer-resize-mode))
632
633(progn ; `isearch'
634 (setq isearch-allow-scroll t))
635
636(use-package lisp-mode
637 :config
638 (add-hook 'emacs-lisp-mode-hook 'outline-minor-mode)
639 (add-hook 'emacs-lisp-mode-hook 'reveal-mode)
640 (defun indent-spaces-mode ()
641 (setq indent-tabs-mode nil))
642 (add-hook 'lisp-interaction-mode-hook #'indent-spaces-mode))
643
644(use-package man
645 :defer t
646 :config (setq Man-width 80))
647
648(use-package paren
649 :config (show-paren-mode))
650
651(use-package prog-mode
652 :config (global-prettify-symbols-mode)
653 (defun indicate-buffer-boundaries-left ()
654 (setq indicate-buffer-boundaries 'left))
655 (add-hook 'prog-mode-hook #'indicate-buffer-boundaries-left))
656
657(use-package recentf
658 :demand t
659 :config (add-to-list 'recentf-exclude "^/\\(?:ssh\\|su\\|sudo\\)?:"))
660
661(use-package savehist
662 :config (savehist-mode))
663
664(use-package saveplace
665 :when (version< "25" emacs-version)
666 :config (save-place-mode))
667
668(use-package simple
669 :config (column-number-mode))
670
671(progn ; `text-mode'
672 (add-hook 'text-mode-hook #'indicate-buffer-boundaries-left))
673
674(use-package tramp
675 :defer t
676 :config
677 (add-to-list 'tramp-default-proxies-alist '(nil "\\`root\\'" "/ssh:%h:"))
678 (add-to-list 'tramp-default-proxies-alist '("localhost" nil nil))
679 (add-to-list 'tramp-default-proxies-alist
680 (list (regexp-quote (system-name)) nil nil)))
681
682(use-package undo-tree
683 :config
684 (global-undo-tree-mode)
685 (setq undo-tree-mode-lighter ""))
686#+end_src
687
688* Post initialization
689:PROPERTIES:
690:CUSTOM_ID: post-initialization
691:END:
692
693Display how long it took to load the init file.
694
695#+begin_src emacs-lisp
696(message "Loading %s...done (%.3fs)" user-init-file
697 (float-time (time-subtract (current-time)
698 ab--before-user-init-time)))
699#+end_src
700
701* Footer
702:PROPERTIES:
703:CUSTOM_ID: footer
704:END:
705
706#+begin_src emacs-lisp :comments none
707;;; init.el ends here
708#+end_src