1
2
3
4
5
6
7
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
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
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
|
;;; prog-general --- General Programming Functionality and Settings -*- lexical-binding: t; -*-
;; author: Craig Jennings <c@cjennings.net>
;;; Commentary:
;; This module provides general programming functionality not related to a
;; specific programming language, such as code-folding, project management,
;; highlighting symbols, snippets, and whitespace management.
;;; Code:
;; ---------------------- General Prog Settings ----------------------
;; keybindings, minor-modes, and prog-mode settings
(defun cj/general-prog-settings ()
"Keybindings, minor modes, and settings for programming mode."
(interactive)
(display-line-numbers-mode) ;; show line numbers
(setq display-line-numbers-type 'relative) ;; display numbers relative to 'the point'
(setq-default display-line-numbers-width 3) ;; 3 characters reserved for line numbers
(turn-on-visual-line-mode) ;; word-wrapping
(auto-fill-mode) ;; auto wrap at the fill column set
(local-set-key (kbd "M-;") 'comment-dwim)) ;; comment/uncomment region as appropriate
(add-hook 'prog-mode-hook #'cj/general-prog-settings)
(add-hook 'html-mode-hook #'cj/general-prog-settings)
(add-hook 'yaml-mode-hook #'cj/general-prog-settings)
(add-hook 'toml-mode-hook #'cj/general-prog-settings)
;; --------------------------- Header Folding --------------------------
;; dependencies for bicycle
(use-package outline-minor-mode
:ensure nil ;; built-in part of org mode
:hook prog-mode)
(use-package hs-minor-mode
:ensure nil ;; built-in
:hook prog-mode)
;; BICYCLE
;; cycle visibility of outline sections and code blocks.
;; additionally it can make use of the hideshow package.
(use-package bicycle
:after outline
:defer 1
:bind (:map outline-minor-mode-map
("C-<tab>" . bicycle-cycle)
;; backtab is shift-tab
("<backtab>" . bicycle-cycle-global)))
;; --------------------------- Project Switch Actions --------------------------
;; when switching projects, display the todo file if it exists, or display
;; magit-status if it doesn't.
(defun cj/project-switch-actions ()
"Opens TODO or README file on projectile switch project.
If none exists, it opens magit-status."
(let* ((files (directory-files (projectile-project-root)))
(todo-file (seq-find (lambda (file)
(string-match-p "todo\\.\\(org\\|md\\|txt\\)\\'"
(downcase file))) files)))
(if todo-file
(find-file (concat (projectile-project-root) todo-file))
(magit-status))))
;; --------------------------------- Projectile --------------------------------
;; project support
;; only run discover projects when there's no bookmarks file
(defun cj/projectile-schedule-project-discovery ()
(let ((projectile-bookmark-file (concat user-emacs-directory "/projectile-bookmarks.eld")))
(unless (file-exists-p projectile-bookmark-file)
(run-at-time "3" nil 'projectile-discover-projects-in-search-path))))
(use-package projectile
:defer .5
:bind-keymap
("C-c p" . projectile-command-map)
:bind
(:map projectile-command-map
("r" . projectile-replace-regexp))
:custom
(projectile-auto-discover nil)
(projectile-project-search-path `(,code-dir ,projects-dir))
:config
;; scan for projects if none are defined
(cj/projectile-schedule-project-discovery)
;; don't reuse comp buffers between projects
(setq projectile-per-project-compilation-buffer t)
(projectile-mode)
(setq projectile-switch-project-action #'cj/project-switch-actions))
;; groups ibuffer by projects
(use-package ibuffer-projectile
:defer .5
:after projectile
:hook (ibuffer-mode . ibuffer-projectile-set-filter-groups))
;; list all errors project-wide
(use-package flycheck-projectile
:defer .5
:after projectile
:bind
(:map projectile-command-map
("X" . flycheck-projectile-list-errors)))
;; ---------------------------------- Ripgrep ----------------------------------
;; allows fast searching for text anywhere in the project with C-c p G (grep)
(use-package ripgrep
:defer .5
:after projectile
:bind
(:map projectile-command-map
("G" . projectile-ripgrep))
:config
;; when running ripgrep searches, end with the results window selected
(defun switch-to-ripgrep-results (&rest _)
"Switch to *ripgrep-search* buffer in other window."
(pop-to-buffer "*ripgrep-search*"))
(advice-add 'ripgrep-regexp :after #'switch-to-ripgrep-results))
;; ---------------------------------- Snippets ---------------------------------
;; reusable code and text
(use-package yasnippet
:defer 1
:bind
("C-c s n" . yas-new-snippet)
("C-c s e" . yas-visit-snippet-file)
:config
(setq yas-snippet-dirs '(snippets-dir))
(yas-global-mode 1))
(use-package ivy-yasnippet
:after yasnippet
:bind
("C-c s i" . ivy-yasnippet))
;; ----------------------- Export Org To Markdown On Save ----------------------
;; if the file has the proper header, saving an org file will also export to
;; markdown with a timestamp. The header is this:
;; # -*- org-auto-export-to-md: t; -*-
;; #+DATE:
;; and is available as the org-export-md snippet
(defvar org-auto-export-to-md nil)
(defun cj/export-org-to-md-on-save ()
"Export the current org file to Markdown format on save."
(when (and (eq major-mode 'org-mode)
org-auto-export-to-md)
(save-excursion
(goto-char (point-min))
(search-forward "#+DATE:")
(kill-line)
(insert (format-time-string " %Y-%m-%d %H:%M"))
(org-md-export-to-markdown))))
(add-hook 'after-save-hook 'cj/export-org-to-md-on-save)
;; --------------------- Display Color On Color Declaration --------------------
;; display the actual color as highlight to color hex code
(use-package rainbow-mode
:defer .5
:hook (prog-mode . rainbow-mode))
;; ---------------------------- Symbol Overlay Mode ----------------------------
;; Highlight symbols with keymap-enabled overlays
;; replaces highlight-symbol-mode
(use-package symbol-overlay
:defer .5
:bind-keymap
("C-c C-s" . symbol-overlay-map)
:hook
(prog-mode . symbol-overlay-mode))
;; ------------------------------ Highlight TODOs ------------------------------
;; Highlights todo keywords in code for easy spotting.
(use-package hl-todo
:defer 1
:hook
(prog-mode . hl-todo-mode)
:config
(setq hl-todo-keyword-faces
'(("FIXME" . "#FF0000")
("BUG" . "#FF0000")
("HACK" . "#FF0000")
("ISSUE" . "#DAA520")
("TASK" . "#DAA520")
("NOTE" . "#2C780E")
("WIP" . "#1E90FF"))))
;; --------------------------- Whitespace Management ---------------------------
;; trims trailing whitespace only from lines you've modified when saving buffer
(use-package ws-butler
:defer .5
:commands (ws-butler-mode)
:init
(add-hook 'prog-mode-hook #'ws-butler-mode)
(add-hook 'org-mode-hook #'ws-butler-mode)
(add-hook 'text-mode-hook #'ws-butler-mode)
:config
(setq ws-butler-convert-leading-tabs-or-spaces t))
;; ----------------- Auto-Close Successful Compilation Windows -----------------
;; close compilation windows when successful. from 'enberg' on #emacs
(add-hook 'compilation-finish-functions
(lambda (buf str)
(if (null (string-match ".*exited abnormally.*" str))
;;no errors, make the compilation window go away in a few seconds
(progn
(run-at-time
"1.5 sec" nil 'delete-windows-on
(get-buffer-create "*compilation*"))))))
(provide 'prog-general)
;;; prog-general.el ends here
|
