From f5644d0642bc6c479753c3059d76755ceebe60e4 Mon Sep 17 00:00:00 2001 From: Armaan Bhojwani Date: Thu, 20 May 2021 20:40:04 -0400 Subject: [PATCH] Revamp commentary --- config.org | 169 ++++++++++++++++++++--------------------------------- 1 file changed, 63 insertions(+), 106 deletions(-) diff --git a/config.org b/config.org index 32d90f5..ccb1e6b 100644 --- a/config.org +++ b/config.org @@ -6,18 +6,18 @@ * Welcome Welcome to my system configuration! This file contains my Emacs configuration, but also my config files for many of the other programs on my system! ** Compatability -I am currently using GCCEmacs 28 from the feature/native-comp branch, so some settings may not be available for older versions of Emacs. This is a purely personal configuration, so while I can garuntee that it works on my setup, I can't for anything else. +I am currently using Emacs 28 with native compilation, so some settings and packages may not be available for older versions of Emacs. This is a purely personal configuration, so while I can guarantee that it works on my setup, it might not work for you. ** Choices -I chose to create a powerful, yet not overly heavy Emacs configuration. Things like LSP mode are important to my workflow and help me be productive, so despite its weight, it is kept. Things like a fancy modeline or icons on the other hand, do not increase my productivity, and create visual clutter, and thus have been excluded. +I chose to create a powerful, yet not overly heavy Emacs configuration. Things like a fancy modeline, icons, or LSP mode do not increase my productivity, and create visual clutter, and thus have been excluded. -Another important choice has been to integrate Emacs into a large part of my computing environment (see [[*EmacsOS]]). I use Email, IRC, et cetera, all through Emacs which simplifies my workflow. +Another important choice has been to integrate Emacs into a large part of my computing environment (see [[*Emacs OS]]). I use email, IRC, RSS, et cetera, all through Emacs which simplifies my workflow and creates an amazingly integrated environment. -Lastly, I use Evil mode. I think modal keybindings are simple and more ergonomic than standard Emacs style, and Vim keybindings are what I'm comfortable with and are pervasive throughout computing. +Lastly, I use Evil mode. Modal keybindings are simpler and more ergonomic than standard Emacs style, and Vim keybindings are what I'm comfortable with and are pervasive throughout computing. ** TODOs *** TODO Turn keybinding and hook declarations into use-package declarations where possible *** TODO Include offlineimap config ** License -Released under the [[https://opensource.org/licenses/MIT][MIT license]] by Armaan Bhojwani, 2021. Note that many snippets are taken from online, and other sources, who are credited for their work at the snippet. +Released under the [[https://opensource.org/licenses/MIT][MIT license]] by Armaan Bhojwani, 2021. Note that many snippets are taken from online, and other sources, who are credited for their work near their contributions. * Package management ** Bootstrap straight.el straight.el is really nice for managing package, and it integrates nicely with use-package. It uses the bootstrapping system defined here for installation. @@ -35,16 +35,14 @@ straight.el is really nice for managing package, and it integrates nicely with u (eval-print-last-sexp))) (load bootstrap-file nil 'nomessage)) #+end_src -** Replace use-package with straight +** Replace package.el with straight #+begin_src emacs-lisp (straight-use-package 'use-package) (setq straight-use-package-by-default t) #+end_src * Visual options ** Theme -Very nice high contrast theme. - -Its fine to set this here because I run Emacs in daemon mode, but if I were not, then putting it in early-init.el would be a better choice to eliminate the window being white before the theme is loaded. +Use the Modus Operandi theme by Protesilaos Stavrou. Its the best theme for Emacs by far, because how clear and readable it is. It is highly customizable, but I just set a few options here. #+begin_src emacs-lisp (setq modus-themes-slanted-constructs t modus-themes-bold-constructs t @@ -55,7 +53,7 @@ Its fine to set this here because I run Emacs in daemon mode, but if I were not, #+end_src ** Typography *** Font -Great programming font with ligatures. +JetBrains Mono is a great programming font with ligatures. The "NF" means that it has been patched with the [[https://www.nerdfonts.com/][Nerd Fonts]]. #+begin_src emacs-lisp (add-to-list 'default-frame-alist '(font . "JetBrainsMonoNF-12")) #+end_src @@ -81,7 +79,7 @@ Great programming font with ligatures. (global-ligature-mode t)) #+end_src ** Line numbers -Display relative line numbers except in some modes +Display relative line numbers except in certain modes. #+begin_src emacs-lisp (global-display-line-numbers-mode) (setq display-line-numbers-type 'relative) @@ -121,26 +119,27 @@ Show a ruler at a certain number of chars depending on mode. (global-display-fill-column-indicator-mode) #+end_src ** Keybinding hints -Whenever starting a key chord, show possible future steps. +When starting a key chord, show possible future steps after 0.3 seconds. #+begin_src emacs-lisp (use-package which-key :config (which-key-mode) :custom (which-key-idle-delay 0.3)) #+end_src -** Highlight TODOs in comments +** Highlight todo items in comments #+begin_src emacs-lisp (use-package hl-todo :straight (hl-todo :type git :host github :repo "tarsius/hl-todo") :config (global-hl-todo-mode 1)) #+end_src -** Don't lose cursor +** Blink cursor #+begin_src emacs-lisp (blink-cursor-mode) #+end_src ** Visual line mode -Soft wrap words and do operations by visual lines. +Soft wrap words and do operations by visual lines except in programming modes. #+begin_src emacs-lisp - (add-hook 'text-mode-hook 'visual-line-mode 1) + (visual-line-mode 1) + (add-hook 'prog-mode-hook 'visual-line-mode 0) #+end_src ** Display number of matches in search #+begin_src emacs-lisp @@ -148,7 +147,7 @@ Soft wrap words and do operations by visual lines. :config (global-anzu-mode)) #+end_src ** Visual bell -Inverts modeline instead of audible bell or the standard visual bell. +Invert modeline color instead of audible bell or the standard visual bell. #+begin_src emacs-lisp (setq visible-bell nil ring-bell-function @@ -169,6 +168,7 @@ Inverts modeline instead of audible bell or the standard visual bell. (global-set-key (kbd "") 'keyboard-escape-quit)) #+end_src ** Evil collection +Evil bindings for tons of packages. #+begin_src emacs-lisp (use-package evil-collection :after evil @@ -181,17 +181,9 @@ tpope prevails! (use-package evil-surround :config (global-evil-surround-mode)) #+end_src -** Leader key -#+begin_src emacs-lisp - (use-package evil-leader - :straight (evil-leader :type git :host github :repo "cofi/evil-leader") - :config - (evil-leader/set-leader "") - (global-evil-leader-mode)) -#+end_src ** Nerd commenter +Makes commenting super easy #+begin_src emacs-lisp - ;; Nerd commenter (use-package evil-nerd-commenter :bind (:map evil-normal-state-map ("gc" . evilnc-comment-or-uncomment-lines)) @@ -203,7 +195,7 @@ Fix the oopsies! (evil-set-undo-system 'undo-redo) #+end_src ** Number incrementing -Add back C-a/C-x +Add back C-a/C-x bindings. #+begin_src emacs-lisp (use-package evil-numbers :straight (evil-numbers :type git :host github :repo "juliapath/evil-numbers") @@ -212,25 +204,18 @@ Add back C-a/C-x ("C-M-x" . evil-numbers/dec-at-pt))) #+end_src ** Evil org -*** Init #+begin_src emacs-lisp (use-package evil-org :after org :hook (org-mode . evil-org-mode) :config (evil-org-set-key-theme '(textobjects insert navigation shift todo))) + (use-package evil-org-agenda :straight (:type built-in) :after evil-org :config (evil-org-agenda-set-keys)) #+end_src -*** Leader maps -#+begin_src emacs-lisp - (evil-leader/set-key-for-mode 'org-mode - "T" 'org-show-todo-tree - "a" 'org-agenda - "c" 'org-archive-subtree) -#+end_src * Org mode ** General #+begin_src emacs-lisp @@ -251,6 +236,7 @@ Add back C-a/C-x :bind ("C-c a" . org-agenda)) #+end_src ** Tempo +Define templates for lots of common structure elements. Mostly just used within this file. #+begin_src emacs-lisp (use-package org-tempo :after org @@ -274,7 +260,7 @@ Add back C-a/C-x #+end_src * Autocompletion ** Ivy -Simple, but not too simple autocompletion. +A well balanced completion framework. #+begin_src emacs-lisp (use-package ivy :bind (("C-s" . swiper) @@ -316,7 +302,7 @@ Better search utility. #+end_src * Emacs OS ** RSS -Use elfeed for RSS. I have another file with all the feeds in it. +Use elfeed for reading RSS. I have another file with all the feeds in it that I'd rather keep private. #+begin_src emacs-lisp (use-package elfeed :bind (("C-c e" . elfeed)) @@ -407,7 +393,7 @@ Discourage Gnus from displaying HTML emails (add-to-list 'mm-discouraged-alternatives "text/richtext")) #+end_src ** Default browser -Set EWW as default browser except for videos. +Set EWW as default browser except for videos which should open in MPV. #+begin_src emacs-lisp (defun browse-url-mpv (url &optional new-window) "Open URL in MPV." @@ -445,7 +431,7 @@ Some EWW enhancements. (global-set-key (kbd "C-c w") 'eww) #+end_src ** IRC -Circe is a really nice IRC client, that claims to be above RCIRC and below ERC in terms of features. ERC felt a bit messy and finicky to me, and Circe has all the features that I need. This setup gets the password for my bouncer (Pounce) instances via my =~/.authinfo.gpg= file. +Circe is a really nice IRC client that claims to be above RCIRC and below ERC in terms of features. ERC felt a bit messy and finicky to me, and Circe has all the features that I need. This setup gets the password for my bouncer (Pounce) instances via my =~/.authinfo.gpg= file. #+begin_src emacs-lisp (defun fetch-password (&rest params) (require 'auth-source) @@ -499,6 +485,7 @@ Circe is a really nice IRC client, that claims to be above RCIRC and below ERC i :bind (:map circe-mode-map ("C-c C-r" . circe-reconnect-all))) #+end_src ** Calendar +Still experimenting with this setup. Not sure if I will keep it, but it works well for seeing my calendar events. I use =vdirsyncer= to sync my calendar events which I'm really not happy with. #+begin_src emacs-lisp (defun sync-calendar () "Sync calendars with vdirsyncer" @@ -533,22 +520,26 @@ Circe is a really nice IRC client, that claims to be above RCIRC and below ERC i (global-set-key (kbd "C-c c") 'acheam-calendar) #+end_src * Emacs IDE -** Code cleanup +** Python formatting #+begin_src emacs-lisp (use-package blacken :hook (python-mode . blacken-mode) - :config (setq blacken-line-length 79)) + :custom (blacken-line-length 79)) - ;; Purge whitespace +#+end_src +** Strip trailing whitespace +#+begin_src emacs-lisp (use-package ws-butler :config (ws-butler-global-mode)) #+end_src ** Flycheck +Automatic linting. I need to look into configuring this more. #+begin_src emacs-lisp (use-package flycheck :config (global-flycheck-mode)) #+end_src ** Project management +I never use this, but apparently its very powerful. Another item on my todo list. #+begin_src emacs-lisp (use-package projectile :config (projectile-mode) @@ -565,6 +556,7 @@ Circe is a really nice IRC client, that claims to be above RCIRC and below ERC i :config (counsel-projectile-mode)) #+end_src ** Dired +The best file manager! #+begin_src emacs-lisp (use-package dired :straight (:type built-in) @@ -590,18 +582,11 @@ Circe is a really nice IRC client, that claims to be above RCIRC and below ERC i #+end_src ** Git *** Magit -# TODO: Write a command that commits hunk, skipping staging step. +**** TODO Write a command that commits hunk, skipping staging step. +A very good Git interface. #+begin_src emacs-lisp (use-package magit) #+end_src -*** Colored diff in line number area -#+begin_src emacs-lisp - (use-package diff-hl - :straight (diff-hl :type git :host github :repo "dgutov/diff-hl") - :hook ((magit-pre-refresh-hook . diff-hl-magit-pre-refresh) - (magit-post-refresh-hook . diff-hl-magit-post-refresh)) - :config (global-diff-hl-mode)) -#+end_src *** Email #+begin_src emacs-lisp (use-package piem) @@ -609,28 +594,9 @@ Circe is a really nice IRC client, that claims to be above RCIRC and below ERC i :straight (git-email :repo "https://git.sr.ht/~yoctocell/git-email") :config (git-email-piem-mode)) #+end_src -** Java -*** Evaluate current buffer -Stolen from https://stackoverflow.com/questions/19953924/how-do-you-run-java-codes-in-emacs -#+begin_src emacs-lisp - (defun java-eval-buffer () - "run current program (that requires no input)" - (interactive) - (let* ((source (file-name-nondirectory buffer-file-name)) - (out (file-name-sans-extension source)) - (class (concat out ".class"))) - (save-buffer) - (shell-command (format "rm -f %s && javac %s" class source)) - (if (file-exists-p class) - (shell-command (format "java %s" out) "*scratch*") - (progn - (set (make-local-variable 'compile-command) - (format "javac %s" source)) - (command-execute 'compile))))) -#+end_src * General text editing ** Indentation -Indent after every change. +Automatically indent after every change. I'm not sure how much I like this. It slows down the editor and code sometimes ends up in a half-indented state meaning I have to manually reformat using "==" anyways. #+begin_src emacs-lisp (use-package aggressive-indent :config (global-aggressive-indent-mode)) @@ -643,19 +609,12 @@ Spell check in text mode, and in prog-mode comments. (dolist (hook '(change-log-mode-hook log-edit-mode-hook)) (add-hook hook (lambda () (flyspell-mode -1)))) (add-hook 'prog-mode (lambda () (flyspell-prog mode))) + (setq ispell-silently-savep t) #+end_src -** Expand tabs to spaces +** Sane tab width #+begin_src emacs-lisp (setq-default tab-width 2) #+end_src -** Copy kill ring to clipboard -#+begin_src emacs-lisp - (setq x-select-enable-clipboard t) - (defun copy-kill-ring-to-xorg () - "Copy the current kill ring to the xorg clipboard." - (interactive) - (x-select-text (current-kill 0))) -#+end_src ** Save place Opens file where you left it. #+begin_src emacs-lisp @@ -665,11 +624,10 @@ Opens file where you left it. Distraction free writing a la junegunn/goyo. #+begin_src emacs-lisp (use-package olivetti - :config - (evil-leader/set-key "o" 'olivetti-mode)) + :bind ("C-c o" . olivetti-mode)) #+end_src ** Abbreviations -Abbreviate things! +Abbreviate things! I just use this for things like my email address and copyright notice. #+begin_src emacs-lisp (setq abbrev-file-name "~/.emacs.d/abbrevs.el") (setq save-abbrevs 'silent) @@ -679,14 +637,10 @@ Abbreviate things! #+begin_src emacs-lisp (setq tramp-default-method "ssh") #+end_src -** Don't ask about following symlinks in vc +** Follow version controlled symlinks #+begin_src emacs-lisp (setq vc-follow-symlinks t) #+end_src -** Don't ask to save custom dictionary -#+begin_src emacs-lisp - (setq ispell-silently-savep t) -#+end_src ** Open file as root #+begin_src emacs-lisp (defun doas-edit (&optional arg) @@ -717,14 +671,15 @@ Makes "C-x k" binding faster. (substitute-key-definition 'kill-buffer 'kill-buffer-and-window global-map) #+end_src * Other settings -** OpenSCAD +** OpenSCAD syntax #+begin_src emacs-lisp (use-package scad-mode) #+end_src -** Control backup files +** Control backup and lock files Stop backup files from spewing everywhere. #+begin_src emacs-lisp - (setq backup-directory-alist `(("." . "~/.emacs.d/backups"))) + (setq backup-directory-alist `(("." . "~/.emacs.d/backups")) + create-lockfiles nil) #+end_src ** Make yes/no easier #+begin_src emacs-lisp @@ -765,17 +720,11 @@ No more clogging up init.el. #+begin_src emacs-lisp (use-package 0x0 :straight (0x0 :type git :repo "https://git.sr.ht/~zge/nullpointer-emacs") - :custom (0x0-default-service 'envs) - :config (evil-leader/set-key - "00" '0x0-upload - "0f" '0x0-upload-file - "0s" '0x0-upload-string - "0c" '0x0-upload-kill-ring - "0p" '0x0-upload-popup)) + :custom (0x0-default-service 'envs)) #+end_src ** Automatically clean buffers +Automatically close unused buffers (except those of Circe) at midnight. #+begin_src emacs-lisp - ;; Don't kill Circe buffers (add-to-list 'clean-buffer-list-kill-never-regexps (lambda (buffer-name) (with-current-buffer buffer-name (derived-mode-p 'lui-mode)))) @@ -783,6 +732,7 @@ No more clogging up init.el. #+end_src * Tangles ** Spectrwm +Spectrwm is a really awesome window manager! Would highly recommend. *** General settings #+begin_src conf :tangle ~/.spectrwm.conf workspace_limit = 5 @@ -791,11 +741,13 @@ No more clogging up init.el. autorun = ws[1]:/home/armaa/Code/scripts/autostart #+end_src *** Bar +Disable the bar by default (it can still be brought back up with MOD+b). The font just needs to be set to something that you have installed, otherwise spectrwm won't launch. #+begin_src conf :tangle ~/.spectrwm.conf bar_enabled = 0 - bar_font = xos4 Fira Code:pixelsize=14:antialias=true # any installed font + bar_font = xos4 JetBrains Mono:pixelsize=14:antialias=true # any installed font #+end_src *** Keybindings +I'm not a huge fan of how spectrwm handles keybindings, probably my biggest gripe with it. **** WM actions #+begin_src conf :tangle ~/.spectrwm.conf program[term] = st -e tmux @@ -856,13 +808,15 @@ No more clogging up init.el. bind[firefox] = MOD+Control+0 bind[emacs] = MOD+Control+Return #+end_src -**** Quirks +*** Quirks +Float some specific programs by default. #+begin_src conf :tangle ~/.spectrwm.conf quirk[Castle Menu] = FLOAT quirk[momen] = FLOAT #+end_src ** Ash *** Options +Use the vi editing mode. I still haven't found a good way to show visual feedback of the current mode. Ideally the cursor would change to a beam when in insert mode, and a box when in normal mode. #+begin_src conf :tangle ~/.config/ash/ashrc set -o vi #+end_src @@ -1077,7 +1031,7 @@ Make MPV play a little bit smoother. hwdec=auto-copy #+end_src ** Inputrc -For any GNU Readline programs +This file is used for any GNU Readline programs. I use Emacs editing mode mostly because of one annoyance which is that to clear the screen using ^L, you have to be in normal mode which is a pain. If there is a way to rebind this, I'd love to know!. #+begin_src conf :tangle ~/.inputrc set editing-mode emacs #+end_src @@ -1108,7 +1062,7 @@ For any GNU Readline programs smtpserverport = 465 confirm = auto #+end_src -*** Submodules +*** Submodule #+begin_src conf :tangle ~/.gitconfig [submodule] recurse = true @@ -1128,14 +1082,14 @@ For any GNU Readline programs loc = diff --stat 4b825dc642cb6eb9a060e54bf8d69288fbee4904 # Empty hash pushnc = push -o skip-ci #+end_src -*** Commits +*** Commit #+begin_src conf :tangle ~/.gitconfig [commit] gpgsign = true verbose = true #+end_src ** Dunst -Lightweight notification daemon. +Lightweight notification daemon. Eventually I'd like to replace this with something dbus-less. *** General #+begin_src conf :tangle ~/.config/dunst/dunstrc [global] @@ -1192,6 +1146,7 @@ Lightweight notification daemon. timeout = 0 #+end_src ** Zathura +The best document reader! *** Options #+begin_src conf :tangle ~/.config/zathura/zathurarc map recolor @@ -1215,6 +1170,7 @@ Lightweight notification daemon. set recolor "true" #+end_src ** Firefox +Just some basic Firefox CSS. Will probably have to rewrite for the Proton redesign. *** Swap tab and URL bars #+begin_src css :tangle ~/.mozilla/firefox/armaan-release/chrome/userChrome.css #nav-bar { @@ -1265,7 +1221,7 @@ userContent.css: } #+end_src ** Xresources -Modus operandi theme. +Modus operandi theme. No program I use checks for anything beyond foreground and background, but hey, it can't hurt to have all the colors in there. #+begin_src conf :tangle ~/.Xresources ! special ,*.foreground: #ffffff @@ -1305,6 +1261,7 @@ Modus operandi theme. ,*.color15: #dddddd #+end_src ** Tmux +I use tmux in order to keep my st build light. Still learning how it works. #+begin_src conf :tangle ~/.tmux.conf set -g status off set -g mouse on -- 2.39.2