ada4eb5a017cb7fe1960e8dfa81e2dae14c736be
[pelican-mode.git] / pelican-mode.el
1 ;;; pelican-mode.el --- Minor mode for editing Pelican sites -*- lexical-binding: t -*-
2 ;;
3 ;; Copyright 2013-2017 Joe Wreschnig
4 ;;
5 ;; Author: Joe Wreschnig <joe.wreschnig@gmail.com>
6 ;; Package-Version: 20170808
7 ;; Package-Requires: ((emacs "25"))
8 ;; URL: https://git.korewanetadesu.com/pelican-mode.git
9 ;; Keywords: convenience, editing
10 ;;
11 ;; This program is free software; you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
15 ;;
16 ;; This program is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
20 ;;
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with this program. If not, see <http://www.gnu.org/licenses/>.
23
24 \f
25
26 ;;; Commentary:
27 ;;
28 ;; pelican-mode is an Emacs minor mode for editing articles and pages
29 ;; in Pelican sites. Pelican is a static site generator which can
30 ;; process a variety of text file formats. For more information, see
31 ;; URL https://blog.getpelican.com/.
32 ;;
33 ;; It’s intended to be used alongside a major mode for the Pelican
34 ;; document. Currently supported formats are Markdown,
35 ;; reStructuredText, AsciiDoc, and Org. It also assumes you’ve set up
36 ;; Pelican with “pelican-quickstart” or something like it. In
37 ;; particular it expects:
38 ;;
39 ;; * The existence of “pelicanconf.py” and “Makefile” in some
40 ;; ancestor directory.
41 ;; * The first component of the path (e.g. “content”) after that
42 ;; ancestor is irrelevant.
43 ;; * If the next component is “pages”, that indicates a page
44 ;; rather than an article.
45 ;;
46 ;; To enable by default on all text files in a Pelican site:
47 ;;
48 ;; (require 'pelican-mode)
49 ;; (pelican-global-mode)
50 ;;
51 ;; Or with ‘use-package’ and deferred loading:
52 ;;
53 ;; (use-package pelican-mode
54 ;; :after (:any org rst markdown-mode adoc-mode)
55 ;; :config
56 ;; (pelican-global-mode))
57 ;;
58 ;; Or, register ‘pelican-mode’ or ‘pelican-mode-enable-if-site’
59 ;; as hook functions for more direct control.
60
61 \f
62
63 ;;; Code:
64
65 (require 'seq)
66 (require 'subr-x)
67
68 ;; Customizations
69
70 (defgroup pelican nil
71 "Support for Pelican articles and pages.
72
73 For more information about Pelican see URL https://blog.getpelican.com/."
74 :group 'convenience)
75
76 (defcustom pelican-mode-keymap-prefix (kbd "C-c P")
77 "Pelican mode keymap prefix."
78 :group 'pelican
79 :type 'string)
80
81 (defcustom pelican-mode-default-page-fields
82 '(:slug slug)
83 "Fields to include when creating a new page.
84
85 See the documentation for ‘pelican-mode-set-field’ for more information
86 about metadata fields and special values."
87 :group 'pelican
88 :type '(plist))
89
90 (defcustom pelican-mode-default-article-fields
91 '(:date now :status "draft" :slug slug)
92 "Fields to include when creating a new article.
93
94 See the documentation for ‘pelican-mode-set-field’ for more information
95 about metadata fields and special values."
96 :group 'pelican
97 :type '(plist))
98
99 (defcustom pelican-mode-formats
100 '((adoc-mode . pelican-mode-set-field-adoc-mode)
101 (markdown-mode . pelican-mode-set-field-markdown-mode)
102 (org-mode . pelican-mode-set-field-org-mode)
103 (rst-mode . pelican-mode-set-field-rst-mode))
104 "Functions to handle setting metadata, based on major mode.
105
106 This association list maps modes to functions that take two
107 arguments, field and value strings."
108 :group 'pelican
109 :type '(alist :key-type function :value-type function))
110
111 \f
112
113 ;; Mode Definition
114
115 (defvar pelican-mode-command-map
116 (let ((map (make-sparse-keymap)))
117 (define-key map (kbd "d") #'pelican-mode-update-date)
118 (define-key map (kbd "f") #'pelican-mode-set-field)
119 (define-key map (kbd "h") #'pelican-make-html)
120 (define-key map (kbd "n") #'pelican-mode-insert-header)
121 (define-key map (kbd "p") #'pelican-mode-publish)
122 (define-key map (kbd "u") #'pelican-make-rsync-upload)
123 map)
124 "Keymap for Pelican commands after ‘pelican-mode-keymap-prefix’.")
125 (fset 'pelican-mode-command-map pelican-mode-command-map)
126
127 (defvar pelican-mode-map
128 (let ((map (make-sparse-keymap)))
129 (define-key map pelican-mode-keymap-prefix
130 'pelican-mode-command-map)
131 map)
132 "Keymap for Pelican mode.")
133
134 ;;;###autoload
135 (define-minor-mode pelican-mode
136 "Toggle Pelican mode.
137 With a prefix argument ARG, enable Pelican mode if ARG is
138 positive, and disable it otherwise. If called from Lisp, enable
139 the mode if ARG is omitted or nil.
140
141 Pelican is a static site generator which can process a variety of
142 text file formats. For more information, see URL
143 https://blog.getpelican.com/.
144
145 Rather than manually enabling this mode, you may wish to use
146 ‘pelican-global-mode’ or ‘pelican-mode-enable-if-site’.
147
148 When Pelican mode is enabled, additional commands are available
149 for editing articles or pages:
150
151 \\{pelican-mode-map}"
152 :group 'pelican
153 :keymap pelican-mode-map
154 :lighter " Pelican")
155
156 ;;;###autoload
157 (define-globalized-minor-mode pelican-global-mode pelican-mode
158 (lambda ()
159 (when (derived-mode-p #'text-mode)
160 (pelican-mode-enable-if-site)))
161 :group 'pelican
162 :require 'pelican-mode)
163
164 ;;;###autoload
165 (defun pelican-mode-enable-if-site ()
166 "Enable ‘pelican-mode’ if this buffer is part of a Pelican site.
167
168 Pelican sites are detected by looking for a file named
169 “pelicanconf.py” in an ancestor directory."
170 (when (pelican-mode-find-root)
171 (pelican-mode)))
172
173 \f
174
175 ;; User Commands
176
177 (defun pelican-mode-set-field (field value)
178 "Set FIELD to VALUE.
179
180 FIELD may be a string or a symbol; if it is a symbol, the
181 symbol name is used (removing a leading “:” if present).
182
183 When called from Lisp, VALUE may be any value; except for the
184 following special values, the unquoted printed representation of
185 it is used:
186
187 - ‘now’ means the current time.
188
189 - ‘slug’ means the file’s path relative to the document root sans
190 extension; see ‘pelican-mode-default-slug’.
191
192 - nil or an empty string removes the field.
193
194 The buffer must be in a format listed in ‘pelican-mode-formats’
195 for this function to work correctly."
196 (interactive "sField: \nsValue: ")
197 (setq value (pcase value
198 ('now (format-time-string "%Y-%m-%d %H:%M"))
199 ('slug (pelican-mode-default-slug))
200 ('"" nil)
201 (_ value)))
202 (when (symbolp field)
203 (setq field (string-remove-prefix ":" (symbol-name field))))
204 (let ((set-field
205 (assoc-default nil pelican-mode-formats #'derived-mode-p)))
206 (unless set-field
207 (error "Unsupported major mode %S" major-mode))
208 (save-excursion
209 (goto-char 0)
210 (funcall set-field field value))))
211
212 (defun pelican-mode-remove-field (field)
213 "Remove FIELD."
214 (interactive "sField: ")
215 (pelican-mode-set-field field nil))
216
217 (defun pelican-mode-set-title (title)
218 "Set the title to TITLE."
219 (interactive "sTitle: ")
220 (pelican-mode-set-field :title title))
221
222 (defun pelican-mode-update-date (&optional original)
223 "Update the document’s modification date.
224
225 If ORIGINAL is non-nil, the publication date is updated rather
226 than the modification date."
227 (interactive "P")
228 (pelican-mode-set-field (if original :date :modified) 'now))
229
230 (defun pelican-mode-publish ()
231 "Remove draft or hidden status from a Pelican article."
232 (interactive)
233 (pelican-mode-remove-field :status)
234 (pelican-mode-update-date :date))
235
236 (defun pelican-mode-insert-article-header (title tags)
237 "Insert a Pelican header for an article with a TITLE and TAGS."
238 (interactive "sArticle title: \nsTags: ")
239 (save-excursion
240 (goto-char 0)
241 (insert "\n")
242 (apply #'pelican-mode-set-fields
243 `(:title ,title
244 ,@pelican-mode-default-article-fields
245 :tags ,tags))))
246
247 (defun pelican-mode-insert-page-header (title &optional hidden)
248 "Insert a Pelican header for a page with a TITLE.
249
250 If HIDDEN is non-nil, the page is marked hidden; otherwise it
251 has no status."
252 (interactive "sPage title: \nP")
253 (save-excursion
254 (goto-char 0)
255 (insert "\n")
256 (apply #'pelican-mode-set-fields
257 (append
258 (list :title title :status (when hidden "hidden"))
259 pelican-mode-default-page-fields))))
260
261 (defun pelican-mode-insert-header ()
262 "Insert a Pelican header for a page or article."
263 (interactive)
264 (call-interactively
265 (if (pelican-mode-page-p)
266 #'pelican-mode-insert-page-header
267 #'pelican-mode-insert-article-header)))
268
269 (defun pelican-make (target)
270 "Execute TARGET in a Makefile at the root of the site."
271 (interactive "sMake Pelican target: ")
272 (if-let (default-directory (pelican-mode-find-root))
273 (compilation-start (format "make %s" target)
274 nil (lambda (_) "*pelican*"))
275 (user-error "No Pelican site root could be found")))
276
277 (defun pelican-make-html ()
278 "Generate HTML via a Makefile at the root of the site."
279 (interactive)
280 (pelican-make "html"))
281
282 (defun pelican-make-rsync-upload ()
283 "Upload with rsync via a Makefile at the root of the site."
284 (interactive)
285 (pelican-make "rsync_upload"))
286
287 \f
288
289 (defun pelican-mode-set-fields (&rest fields)
290 "Insert a Pelican header for an article with metadata FIELDS."
291 (mapc (apply-partially #'apply #'pelican-mode-set-field)
292 (seq-partition fields 2)))
293
294 (defun pelican-mode-set-field-rst-mode (field value)
295 "Set reStructuredText metadata FIELD to VALUE."
296 (setq field (downcase field))
297 (if (equal field "title")
298 (let ((header (format "%s\n%s\n\n"
299 value (make-string (string-width value) ?#))))
300 (if (looking-at ".*\n#+\n+")
301 (replace-match header)
302 (insert header)))
303 (let ((text (when value (format ":%s: %s\n" field value))))
304 (when (looking-at "^.*\n#")
305 (forward-line 3))
306 (if (re-search-forward (format "^:%s:.*\n" (regexp-quote field)) nil t)
307 (replace-match (or text ""))
308 (when text
309 (if (re-search-forward "^$" nil t)
310 (replace-match text)
311 (insert text)))))))
312
313 (defun pelican-mode-set-field-markdown-mode (field value)
314 "Set Markdown metadata FIELD to VALUE."
315 (setq field (capitalize field))
316 (let ((text (when value (format "%s: %s\n" field value))))
317 (if (re-search-forward (format "^%s:.*\n" (regexp-quote field)) nil t)
318 (replace-match text)
319 (when value
320 (if (re-search-forward "^$" nil t)
321 (replace-match text)
322 (insert text))))))
323
324 (defun pelican-mode-set-field-adoc-mode (field value)
325 "Set AsciiDoc metadata FIELD to VALUE."
326 (setq field (downcase field))
327 (if (equal field "title")
328 (let ((header (format "= %s\n\n" value)))
329 (if (looking-at "= .*\n\n+")
330 (replace-match header)
331 (insert header)))
332 (let ((text (when value (format ":%s: %s\n" field value))))
333 (when (looking-at "^=")
334 (forward-line 2))
335 (if (re-search-forward (format "^:%s:.*\n" (regexp-quote field)) nil t)
336 (replace-match (or text ""))
337 (when text
338 (if (re-search-forward "^$" nil t)
339 (replace-match text)
340 (insert text)))))))
341
342 (defun pelican-mode-set-field-org-mode (field value)
343 "Set Org global metadata FIELD to VALUE."
344 ;; None of org-mode’s functions I can find for setting properties
345 ;; operate on the global list, only a single property drawer.
346 (setq field (upcase field))
347 (setq field
348 (format (if (member field '("TITLE" "DATE" "CATEGORY" "AUTHOR"))
349 "#+%s:"
350 "#+PROPERTY: %s")
351 field))
352 (let ((text (when value (format "%s %s\n" field value))))
353 (if (re-search-forward (format "^%s .*\n" (regexp-quote field)) nil t)
354 (replace-match (or text ""))
355 (when text
356 (if (re-search-forward "^$" nil t)
357 (replace-match text)
358 (insert text))))))
359
360 (defun pelican-mode-page-p ()
361 "Return non-nil the current buffer is a Pelican page."
362 (string-match-p
363 "^[^/]+/pages/"
364 (file-relative-name
365 (abbreviate-file-name (or (buffer-file-name) (buffer-name)))
366 (pelican-mode-find-root))))
367
368 (defun pelican-mode-default-slug ()
369 "Generate a Pelican slug for the current buffer."
370 (file-name-sans-extension
371 (replace-regexp-in-string
372 "^[^/]+/\\(?:pages/\\)?" ""
373 (file-relative-name
374 (abbreviate-file-name (or (buffer-file-name) (buffer-name)))
375 (pelican-mode-find-root)))))
376
377 (defun pelican-mode-find-root ()
378 "Return the root of the buffer’s Pelican site, or nil."
379 (locate-dominating-file default-directory "pelicanconf.py"))
380
381 (provide 'pelican-mode)
382 ;;; pelican-mode.el ends here
383
384 \f
385
386 ;; Local Variables:
387 ;; sentence-end-double-space: t
388 ;; End: