Emacs Config

My not so Extremely Minimal Alt + Ctrl + Shift.

Moved to Modular Structure from Literate Org-Mode config

This post doesn’t strictly follow the most recent version(Updated: 2024-04-05).
That’s available on Github.

(Prefer Built-in packages over 3rd Party ones.)

JEMACS

Emacs really does stand for “Escape-Meta-Alt-Control-Shift”, and not “Editing Macros”, as you may have heard from other disreputable sources (like the Emacs author).

— The Gnus Newsreader Manual > 12.7.1 Keystrokes

BTW, I prefer all headings fall nicely under the main & top node, so the H1.

Table of Contents :TOC_5_org:

NOTES

Aren’t You Said Extremely Minimal?

Trying hard to keep this minimal, but keeps growing :/

Conventions

Followed “D.1 Emacs Lisp Coding Conventions” in Emacs Manual when using modular structured configuration.

Comments

Followed “D.7 Tips on Writing Comments” in Emacs Manual when using modular structured configuration.

Three semicolons are used for top-level sections, four for sub-sections, five for sub-sub-sections and so on.

Then, you can enable outline-mode, and use outline-show-only-headings.

Cross Reference

Follows “5 Cross-references” in GNU Texinfo Manual.

Preview ORG file

Preview this org file in browser by C-c, C-e, h, o, or see Org Preview.

Acknowledge

Heavily influenced by purcell/emasc.d, bbatsov/prelude and daviwil/emacs-from-scratch.

INSTALL

In any case, investigate your git repo and fix .gitignore to not push elpa, etc. unnecessary files.

Dependency

  • git
  • hunspell and dictionary files (for ‘flyspell’)
  • Nerd patched font (for ’nerd-icons')
    • I’m using manually patched ‘BerkeleyMono Nerd Fonts’
  • fd, ag, rg in System, AND ALSO on Emacs (for ‘projectile’)

By cloning the repo itself as .emacs.d

$git clone [email protected]:ptrtoj/Jemacs.git ~/.emacs.d

$cd YOUR/GIT/REPO_DIR
$git clone [email protected]:ptrtoj/Jemacs.git
$ln -sv YOUR/GIT/REPO_DIR ~/.emacs.d

early-init.el Part

Quote from ‘50.4.6 The Early Init File’ (from Emacs Manual)

This file is loaded before the package system and GUI is initialized, so in it you can customize variables that affect the package initialization process, such as ‘package-enable-at-startup’, ‘package-load-list’, and ‘package-user-dir’.

package-enable-at-startup

Purcell sets ‘package-enable-at-startup’ to ’nil’ (see purcell/emacs.d/early-init.el).

However, Protesilaos disagrees (see https://github.com/protesilaos/dotfiles/blob/master/emacs/.emacs.d/early-init.el, Line 77)( Couldn’t feel noticable difference, yet

(setq package-enable-at-startup nil)

LSP_USE_PLISTS

Removed (setenv "LSP_USE_PLISTS" "true"). Rather added to system ’env’ var, because of ’exec-path-from-shell’

init.el Part

Implementation of JEMACS.

Use-Package

Initiate

(require 'use-package)
(use-package package
  :bind
  ("C-c u p" . package-refresh-contents)
  :config
  (add-to-list 'package-archives '("melpa" . "https://melpa.org/packages/"))
  (package-initialize)
  (unless package-archive-contents
	(package-refresh-contents)))

Auto Update

Automatically update packages. But can be updated manually by C-c, u, g.

(use-package auto-package-update
  :ensure t
  :bind
  ("C-c u g" . auto-package-update-now)
  :config
  (setq auto-package-update-prompt-before-update t)
  (setq auto-package-update-delete-old-versions t))

Emacs Defaults

(use-package emacs
  :custom
  (user-full-name "WooHyung Jeon")
  (user-mail-address "[email protected]")
  ;;(visible-bell t)

  ;; Obsoleted by using 'dashboard'
  ;;(inhibit-startup-screen t)
  ;;(inhibit-startup-message t)
  ;;(inhibit-startup-echo-area-message t)
  ;;(initial-major-mode 'fundamental-mode)

  ;; old way to change to 'y-or-n-p'
  ;;(defalias 'yes-or-no-p 'y-or-n-p)

  ;; new and correct way to set 'y-or-n-p'
  (setopt use-short-answers t)

  ;; Look two consecutive headings below
  (gc-cons-threshold (* 4 1024 1024))
  (read-process-output-max (* 1024 1024)))

gc-cons-threshold is too low

is claimed by lsp-mode in this page’s performance section.

About Garbage Colleciton see E.3 Garbage Collection in Elisp Reference Manual.

read-process-output-max is also too low

is again claimed by lsp-mode in the same page.

Fix MacOS Path Issue

(use-package exec-path-from-shell
  :ensure t
  :config
  (dolist (var '("LSP_USE_PLISTS"))
	(add-to-list 'exec-path-from-shell-variables var))
  (when (memq window-system '(mac ns x))
	(exec-path-from-shell-initialize)))

Personal Functions

Load personal functions from libj directory. (see: Emacs Manual)

(add-to-list 'load-path "~/.emacs.d/libj")
(load "utils")

Editing

Revert Automatically

See Emacs Manual.

(use-package autorevert
  :diminish (auto-revert-mode)
  :custom
  (global-auto-revert-non-file-buffers t))

Key Bindings

Personal key bindings, which aren’t written directly into the ‘use-package’ part. New bindings are left, and replacement or 3rd party package bindings are moved to each package’s ‘use-package’ file.

Considering General.el.

(use-package bind-keys
  :bind
  ;; Personal Additions
  ("C-c k" . describe-personal-keybindings)) ; Show personal keybindings

Disable custom.el

Re-route ‘custom’ settings to ‘custom-file’ Prevent the custom section written in this file.

(setq custom-file (concat user-emacs-directory "custom.el"))
(when (file-exists-p custom-file)
  (load custom-file))

Abbreviation

Complete and expand abbreviation

(use-package dabbrev
  :diminish (abbrev-mode)
  :bind
  (("M-/"   . dabbrev-completion)
   ("C-M-/" . dabbrev-expand))
  :config
  (add-to-list 'dabbrev-ignored-buffer-modes 'doc-view-mode)
  (add-to-list 'dabbrev-ignored-buffer-modes 'pdf-view-mode))

Delete Selection as I Type

(use-package delsel
  :config
  (delete-selection-mode 1))

Eldoc

A buffer-local minor mode that helps with looking up documentation of symbols (functions, methods, classes, variables, etc.) in your program

(Seems it automatically turns on ’elisp’ files, but ‘C’ file complains, if LSP such as ’eglot’ isn’t enabled)

(use-package eldoc
  :diminish
  :hook
  ;; (emacs-lisp-mode . turn-on-eldoc-mode))
  (prog-mode . turn-on-eldoc-mode))

Pair Parenthesis Automatically

(use-package elec-pair
  :hook
  (prog-mode . electric-pair-mode)
  (org-mode . electric-pair-mode))

Files

Do not make *~ backup files

(use-package files
  :custom
  (make-backup-files nil))

Spell Check

Dependency:

  • ‘hunspell’

  • ‘Spelling Files’ such as `*.aff` & `*.dic`

    (use-package flyspell :diminish :custom (ispell-local-dictionary “en_US”) :hook (text-mode . flyspell-mode) (prog-mode . flyspell-prog-mode))

    ;; Telling ispell-mode to use hunspell. Already handled by ‘ispell.el’. ;;(setq ispell-program-name “/opt/homebrew/bin/hunspell”)

Show URL as clickable links.

Using, org-mode instead of link in el file.

(use-package goto-addr
  :config
  (global-goto-address-mode))

Helpful

(use-package helpful
  :ensure ;TODO:
  :bind
  ([remap describe-function] . helpful-callable)
  ([remap describe-variable] . helpful-variable)
  ([remap describe-key] . helpful-key)
  ([remap describe-command] . helpful-command)
  ("C-h j" . helpful-at-point))

Recent Files

(use-package recentf
  :bind
  ("C-x C-r" . recentf-open-files)
  :config
  (recentf-mode 1))

Save Command History

(use-package savehist
  :config
  (savehist-mode 1))

Save Last Cursor Position

(use-package saveplace
  :config
  (save-place-mode 1))

Treat some-long-named-var as one word

(use-package subword
  :diminish (superword-mode)
  :config
  (global-superword-mode 1))

Show Keys

(use-package which-key
  :ensure t
  :diminish
  :config
  (which-key-mode 1))

Clean White Spaces

(use-package whitespace
  :hook
  (before-save . whitespace-cleanup))

Move Windows Easily

(use-package windmove
  :bind
  ("C-c w j" . windmove-down)
  ("C-c w k" . windmove-up)
  ("C-c w h" . windmove-left)
  ("C-c w l" . windmove-right))

UI

Column Indicator

Show 80-char width

(use-package display-fill-column-indicator
  :config
  ;;(set-face-background 'fill-column-indicator "#ffff00")	; Yellow BG
  (global-display-fill-column-indicator-mode 1))

Hide Minor Mode

(use-package diminish
  :ensure t)

Show Line Numbers

(use-package display-line-numbers
  :custom
  (display-line-numbers-type 'relative)
  (display-line-numbers-width-start t)		; prevent width expand near the three digit
  :config
  (global-display-line-numbers-mode 1)
  (dolist (mode '(term-mode-hook		; don't show in terminals
				  shell-mode-hook
				  eshell-mode-hook
				  treemacs-mode-hook))		; also in filetree
	(add-hook mode (lambda () (display-line-numbers-mode -1)))))

Frame

(use-package frame
  :custom
  (initial-frame-alist (quote ((fullscreen . maximized)))))

Highlight Cursor Line

(use-package hl-line
  :config
  ;; if !using-colortheme,
  ;; then background = lightgray
  (set-face-background hl-line-face "lightgray")
  (global-hl-line-mode 1))

Highlight Indent Level

(use-package indent-guide
  :ensure t
  :diminish
  :custom
  (indent-guide-char " ")
  ;;(indent-guide-delay 0.5)
  :config
  (set-face-background 'indent-guide-face "gray90")
  :hook
  (prog-mode . indent-guide-mode))

Show Parenthesis Level

(use-package rainbow-delimiters
  :ensure t
  :hook
  (prog-mode . rainbow-delimiters-mode))

Remove Scroll Bar

(use-package scroll-bar
  :init
  (scroll-bar-mode 1))

Simple

(use-package simple
  :config
  (column-number-mode 1))

Theme

‘Emacs’, the only true & correct editor defaults to light-theme, but if it’s boring, use below

;;;; Built-in 'modus' themes
;; (use-package custom
;;   :config
;;   (load-theme 'modus-operandi t))
  ;;(load-theme 'modus-vivendi t)

;;;; Nord
;; (use-package nord-theme
;;   :ensure t
;;   :config
;;   (load-theme 'nord t))

;;;; Catppuccin
(use-package catppuccin-theme
  :ensure t
  :config
  (load-theme 'catppuccin t)
  (setq catppuccin-flavor 'latte)
  (catppuccin-reload))

Fonts

Should come after ’theme’, see ‘Commentary - [FIXED] ISSUE: 2024-04-09’

[FIXED] ISSUE: 2024-04-09 ‘Theme’ resets ‘font-lock-keyword-face’ and ‘font-lock-comment-face’. So these should be placed under the ’theme.el’.

(use-package faces
  :config
  (set-face-attribute 'font-lock-keyword-face nil :weight 'bold)
  (set-face-attribute 'font-lock-comment-face nil :slant 'italic)
  (add-to-list 'default-frame-alist '(font . "BerkeleyMono Nerd Font")))

Remove Tool Bar

(use-package tool-bar
  :config
  (tool-bar-mode -1))

OBSOLETE Remove Menu Bar

On MacOS, menu-bar doesn’t bother me

(use-package menu-bar
  :config
  (menu-bar-mode -1))

OBSOLETE Remove Tooltips

Tooltips are actually quite helpful

(use-package tooltip
  :config
  (tooltip-mode -1))

Dashboard

Page Break Lines

(use-package page-break-lines
  :ensure t)

Nerd Icons

(use-package nerd-icons
  :ensure t
  :custom
  (nerd-icons-font-family "BerkeleyMono Nerd Font"))

Dashboard

ISSUE: 2024-04-06 Can’t find ‘octicon’, maybe caused by/with ‘all-the-icons’ → even same with ’nerd-icons’

Dependency:

  • page-break-lines

  • nerd-icons

    (use-package dashboard :ensure t :config (setq dashboard-center-content t) (setq dashboard-vertically-center-content t) (setq dashboard-items ‘((recents . 20))) (setq dashboard-item-shortcuts ‘((recents . “r”))) (setq dashboard-display-icons-p t) (setq dashboard-icon-type ’nerd-icons) ;;(setq dashboard-set-heading-icons t) (setq dashboard-set-file-icons t) (dashboard-setup-startup-hook))

File Tree

Treemacs

(use-package treemacs
  :ensure t
  :defer t
  :bind
  ("C-c t" . treemacs)
  :config
  (progn (setq treemacs-width 30))
  (treemacs-resize-icons 16))

Treemacs with Projectile

(use-package treemacs-projectile
  :ensure t
  :after (treemacs projectile))

Treemacs with Magit

(use-package treemacs-magit
  :ensure t
  :after (treemacs magit))

Treemacs with LSP

(use-package lsp-treemacs
  :ensure t
  :commands
  lsp-treemacs-errors-list)

Modeline

Doom Modeline

(use-package doom-modeline
  :ensure t
  :config
  (setq doom-modeline-icon t)
  (setq doom-modeline-minor-modes t)
  (setq doom-modeline-enable-word-count t)
  (setq doom-modeline-total-line-number t)
  (setq find-file-visit-truename t)		; To show 'symlinked' file path  correctly
  :init
  (doom-modeline-mode 1))

Show Time on Modeline

(use-package time
  :init
  (display-time-mode t))

Git

Magit

Webpage

(use-package magit
  :ensure t
  :custom
  (magit-display-buffer-function #'magit-display-buffer-same-window-except-diff-v1))

Minibuffer Set - SMOCE

“Selectrum… is replaced” with ‘vertico’(see: https://github.com/radian-software/selectrum).

Vertico

Github

(use-package vertico
  :ensure t
  :init
  (vertico-mode))

Marginalia

Github

(use-package marginalia
  :after vertico
  :ensure t
  :config
  (marginalia-mode))

Orderless

Github

(use-package orderless
  :ensure t
  :init
  (setq completion-styles '(orderless basic)
		completion-category-defaults nil
		completion-category-overrides '((file (styles partial-completion)))))

Embark

Github

(use-package embark
  :ensure t)

Embark Consult

(use-package embark-consult
  :after embark
  :ensure t)

Consult

Github

(use-package consult
  :after  embark-consult
  :ensure t)

OBSOLETE Helm

Using SMOCE instead of helm

(use-package helm
  :ensure t
  :diminish
  :bind
  ("M-x" . 'helm-M-x)
  ("C-x C-f" . 'helm-find-files)
  :config
  (setq helm-display-header-line nil)
  (set-face-attribute 'helm-source-header nil :height 0.1)
  (setq helm-split-window-inside-p t)
  (helm-mode 1))

OBSOLETE Helm-LSP

(use-package helm-lsp
  :ensure t
  :commands
  helm-lsp-workspace-symbol)

Completion at Point

Company

(use-package company
  :ensure t
  :diminish
  :custom
  (company-minimum-prefix-length 1)
  (company-idle-delay 0.0)
  :init
  (global-company-mode)
  :config
  (setq company-backends (mapcar #'jeon/company-add-yas-backend company-backends)))	; add yasnippet to all backends

OBSOLETE Corfu

Github

Using Company instead of Corfu

Depedency

  • emacs

  • dabbrev

  • savehist

    (use-package corfu :ensure t :custom (corfu-auto t) (corfu-quit-no-match ‘separator) :bind (:map corfu-map (“RET” . nil)) :init (global-corfu-mode))

    ;; ‘corfu’ manual also recommends below (use-package emacs :init (setq tab-always-indent ‘complete) (setq text-mode-ispell-word-completion nil) (setq read-extended-command-predicate #‘command-completion-default-include-p))

    ;;; Extensions: ;; corfu-history (corfu-history-mode 1) (add-to-list ‘savehist-additional-variables ‘corfu-history)

    ;; corfu-indexed (corfu-indexed-mode 1)

    ;; corfu-popupinfo (corfu-popupinfo-mode 1)

    (use-package nerd-icons-corfu :ensure t) (add-to-list ‘corfu-margin-formatters #’nerd-icons-corfu-formatter)

Org Mode

(use-package org
  :custom
  (org-ellipsis " ▾"))
  ;;:config
  ;;(add-to-list 'org-structure-template-alist '("el" . "src emacs-lisp")))

Org Preview

Github: jakebox/org-preview-html

(use-package org-preview-html
  :ensure t)

  1. ISSUE-240410#preview: unable to resolve link

    See: 1.18.3.1

Org Bullets

(use-package org-bullets
  :ensure t
  :custom
  (org-bullets-bullet-list '("◉" "○" "●" "○" "●" "○" "●"))
  :hook
  (org-mode . org-bullets-mode))

Org ToC

Github: snosov1/toc-org

(use-package toc-org
  :ensure t
  :hook
  (org-mode . toc-org-mode))

Make a heading for table of contents, and add tag :TOC: by C-c~~C-q.

  1. FIX: ISSUE-240410#preview

    Add noexport tag with :TOC:, so it becomes :TOC:noexport: (see: Github’s Exclude headings part, ISSUE-BUG:35)

Org visual fill column

(use-package visual-fill-column
  :ensure t
  :hook (org-mode . jeon/org-fill-column))

Project Manager

ag

(use-package ag
  :ensure t
  :custom
  (ag-highlight-search t))

rg

(use-package rg
  :ensure t
  :config
  (rg-enable-default-bindings))

Projectile

(use-package projectile
  :ensure t
  :bind-keymap
  ("C-c p" . projectile-command-map)
  ;;:custom
  ;;(projectile-project-search-path '("~/Dev" "~/Git"))
  :config
  (projectile-mode 1))

Snippet

Yasnippet

(use-package yasnippet
  :ensure t
  :diminish (yas-minor-mode)
  :config
  (yas-reload-all)
  :hook
  (prog-mode . yas-minor-mode))

Snippets

(use-package yasnippet-snippets
  :ensure t)

LSP

LSP-Mode

(use-package lsp-mode
  :ensure t
  :bind
  ("C-c l" . lsp-keymap-prefix)
  :custom
  (lsp-warn-no-matched-clients nil)		; prevent 'el' file warnings
  (lsp-idle-delay 0.500)
  (lsp-completion-provider :none)
  :hook
  (lsp-mode . lsp-enable-which-key-integration)
  (prog-mode . lsp-deferred))

LSP-UI

(use-package lsp-ui
  :ensure t
  :bind
  (:map lsp-ui-mode-map
		([xref-find-definitions] . lsp-ui-peek-find-definitions )
		([xref-find-references] . lsp-ui-peek-find-references))
  :custom
  (lsp-ui-sideline-show-hover 't)
  (lsp-ui-sideline-show-code-actions 't)
  (lsp-ui-doc-position 'at-point)
  (lsp-ui-doc-show-with-cursor 't)
  :commands
  lsp-ui-mode)

OBSOLETE eglot

Using lsp-mode instead of eglot

(use-package eglot
  :hook
  (prog-mode . eglot-ensure))

Debug

Dap-mode

(use-package dap-mode
  :ensure t)

Language Specifics

Ada

Ada Doc

(use-package ada-mode
  :ensure t)

;;; ISSUE: 2024-04-06 <Need to check 'gpr-mode', 'gpr-query' - Are these necessary?>
;; Needs 'gpr-mode' to resolve 'Ada parser exec 'ada_mode_wisi_lr1_parse' not found' issue.
;; No, it wasn't fixed, yet.
;; (See: https://forum.ada-lang.io/t/gnu-emacs-ada-mode-8-0-4-released/310 )
;; > gpr-query and gpr-mode are split out into separate GNU ELPA packages.
;; However, seems ok to just install 'gpr-mode'

;; (use-package gpr-mode
;;   :ensure t)

;; (use-package gpr-query
;;   :ensure t)

C

(use-package cc-vars
  :custom
  ;;(c-basic-offset 4)
  (c-default-style "k&r"))

Markdown

Project Website

(use-package markdown-mode
  :ensure t)