-
Notifications
You must be signed in to change notification settings - Fork 16
/
tldr.el
371 lines (331 loc) · 14.2 KB
/
tldr.el
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
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
;;; tldr.el --- tldr client for Emacs -*- lexical-binding: t; -*-
;; Author: Ono Hiroko <azazabc123@gmail.com>
;; Keywords: tools, docs
;; Package-Requires: ((emacs "24.3"))
;; X-URL: https://github.com/kuanyui/tldr.el
;; Version: {{VERSION}}
;; WTFPL 2.0
;; Ono Hiroko (@kuanyui) (ɔ) Copyleft 2016-2017
;;
;; This program is free software. It comes without any warranty, to
;; the extent permitted by applicable law. You can redistribute it
;; and/or modify it under the terms of the Do What The Fuck You Want
;; To Public License, Version 2, as published by Sam Hocevar. See
;; http://www.wtfpl.net/ for more details.
;; Started at [2016-01-05 火 23:05]
;;; Commentary:
;; This is a tldr client for Emacs.
;; https://github.com/tldr-pages/tldr
;; Just M-x tldr
;;
;; Notice that the first time using it will automatically download the
;; latest tldr docs.
;;
;; You can use =M-x tldr-update-docs= to update docs.
;;; Code:
(require 'url)
(require 'cl-lib)
(defgroup tldr nil
"An Emacs client for the TLDR community man pages."
:prefix "tldr-"
:link '(url-link "http://github.com/kuanyui/tldr.el")
:group 'help)
(defcustom tldr-directory-path
(expand-file-name "tldr/" user-emacs-directory)
"The directory name of tldr."
:group 'tldr
:type 'string)
(defcustom tldr-enable-annotations t
"Add description of each command in the *Completions* buffer."
:group 'tldr
:type 'boolean)
(defcustom tldr-use-word-at-point
nil
"Use the word at point as the initial search term when
selecting a command."
:group 'tldr
:type 'boolean)
(defcustom tldr-saved-zip-path
(concat temporary-file-directory "tldr-source.zip")
"The temporary location for downloading the zipped TLDR
source."
:group 'tldr
:type 'string)
(defcustom tldr-source-zip-url
"https://github.com/tldr-pages/tldr/archive/refs/heads/main.zip"
"The location of the zipped TLDR source on GitHub."
:group 'tldr
:type 'string)
(defcustom tldr-enabled-categories
(cond ((member system-type '(gnu gnu/linux gnu/kfreebsd cygwin))
'("common" "linux"))
((member system-type '(darwin))
'("common" "osx"))
(t
'("common")))
"A list of the enabled TLDR categories."
:group 'tldr
:type '(repeat string)) ; [HELP] I don't know how to make checkbox for a string list
(defcustom tldr-locales
nil
"Priority list of locales to display tldr pages in."
:group 'tldr
:type '(repeat string))
(define-derived-mode tldr-mode help-mode "tldr"
"Lookup TLDR man pages from within in Emacs."
(set (make-local-variable 'buffer-read-only) t))
(define-key tldr-mode-map (kbd "SPC") 'tldr)
(define-key tldr-mode-map (kbd "]") 'help-go-forward)
(define-key tldr-mode-map (kbd "[") 'help-go-back)
(defface tldr-title
'((((class color) (background light))
(:foreground "#ff8700" :bold t :height 1.2))
(((class color) (background dark))
(:foreground "#ffa722" :bold t :height 1.2)))
""
:group 'tldr)
(defface tldr-introduction
'((((class color) (background light))
(:foreground "#525252" :italic t))
(((class color) (background dark))
(:foreground "#cdcdcd" :italic t)))
""
:group 'tldr)
(defface tldr-description
'((((class color) (background light))
(:foreground "#1f5bff"))
(((class color) (background dark))
(:foreground "#6faaff")))
""
:group 'tldr)
(defface tldr-code-block
'((((class color) (background light))
(:foreground "#008700" :background "#d7ff87"))
(((class color) (background dark))
(:foreground "#a1db00" :background "#5a5a5a")))
""
:group 'tldr)
(defface tldr-command-argument
'((((class color) (background light))
(:foreground "#555" :background "#d7ff87" :underline t))
(((class color) (background dark))
(:foreground "#eee" :background "#5a5a5a" :underline t)))
""
:group 'tldr)
(defface tldr-command-itself
'((((class color) (background light))
(:foreground "#d7ff87" :background "#008700" :bold t))
(((class color) (background dark))
(:foreground "#5a5a5a" :background "#afd700" :bold t)))
""
:group 'tldr)
(defvar tldr-length-of-longest-command-name nil
"Length of the longest command name.")
;;;###autoload
(defun tldr-update-docs ()
"Get or update the TLDR docs from source."
(interactive)
(if (tldr--check-unzip)
(progn
(if (file-exists-p tldr-directory-path)
(delete-directory tldr-directory-path 'recursive 'no-trash))
(if (file-exists-p tldr-saved-zip-path)
(delete-file tldr-saved-zip-path 'no-trash))
(url-copy-file tldr-source-zip-url tldr-saved-zip-path)
(shell-command-to-string (format "unzip -d %s %s" (file-truename user-emacs-directory) tldr-saved-zip-path))
(delete-file tldr-saved-zip-path)
(if (member system-type '(windows-nt ms-dos))
(shell-command-to-string (format "move \"%s\" \"%s\""
(concat (file-truename user-emacs-directory) "tldr-main")
(directory-file-name tldr-directory-path)))
(shell-command-to-string (format "mv '%s' '%s'" (concat (file-truename user-emacs-directory) "tldr-main") tldr-directory-path)))
(message "The TLDR docs are up to date!"))))
(defun tldr-get-commands-list ()
"For `completing-read'"
(mapcar (lambda (file.md) (substring file.md 0 -3))
(cl-remove-if (lambda (y) (member y '("." "..")))
(cl-mapcan (lambda (x)
(directory-files
(expand-file-name
(convert-standard-filename
(concat "pages/" x))
tldr-directory-path)))
tldr-enabled-categories))))
(defun tldr-get-locales ()
"Return a priority list of locales as specified by
`tldr-locales' and the LANG and LANGUAGE environment variables."
(cond
(tldr-locales tldr-locales)
((getenv "LANG") (list (getenv "LANG")))
((getenv "LANGUAGE") (split-string (getenv "LANGUAGE") ":"))))
(defun tldr-page-exists-p (command system &optional locale)
"Return the file path of the tldr page specified by COMMAND,
SYSTEM and LOCALE. Return nil if such a page is not found. If
optional argument LOCALE is unspecified, return the file path of
the default English language page."
(cl-some (lambda (locale-extension)
(let ((filename
(expand-file-name
(convert-standard-filename
(format "pages%s/%s/%s.md"
locale-extension system command))
tldr-directory-path)))
(and (file-exists-p filename)
filename)))
(if locale
(let ((language (when (string-match "^\\([^_]*\\)" locale)
(match-string 1 locale)))
(territory (when (string-match "^[^_]*_\\([^.]*\\)" locale)
(match-string 1 locale))))
(list (format ".%s_%s" language territory)
(format ".%s" language)))
(list ""))))
(defun tldr-get-file-path-from-command-name (command)
(cl-some (lambda (system)
(or (cl-some (apply-partially #'tldr-page-exists-p command system)
(tldr-get-locales))
(tldr-page-exists-p command system)))
tldr-enabled-categories))
(defun tldr-render-markdown (command)
(let* ((file-path (tldr-get-file-path-from-command-name command))
(lines (split-string
(with-temp-buffer
(insert-file-contents file-path)
(buffer-string)) "\n")))
(mapconcat (lambda (line)
(cond ((equal "" line)
"")
((string-prefix-p "# " line)
(propertize (substring line 2) 'face 'tldr-title))
((string-prefix-p "> " line)
(propertize (concat " " (substring line 2)) 'face 'tldr-introduction))
((string-prefix-p "- " line)
(concat "- "
(propertize (substring line 2) 'face 'tldr-description)))
((string-prefix-p "`" line)
;; Strip leading/trailing back-ticks and add code block face
(setq line (propertize (substring line 1 -1) 'face 'tldr-code-block))
;; Add command face
(setq line (replace-regexp-in-string
(concat "^" (regexp-quote command))
(propertize command 'face 'tldr-command-itself)
line 'fixedcase))
;; Strip {{}} and add command argument face
(while (string-match "{{\\(.+?\\)}}" line)
(let ((argument (propertize (match-string 1 line)
'face 'tldr-command-argument)))
(setq line (replace-match argument 'fixedcase 'literal line 0))))
(concat " " line))))
lines "\n")))
(defun tldr--check-unzip ()
(if (executable-find "unzip")
t
(progn (message "unzip not found. Please install and run `tldr-update-docs' again.") nil)))
(defun tldr-completion-annotation(command)
"Add description for command COMMAND in the *Completions* buffer."
(when-let ((file-path (and tldr-enable-annotations (tldr-get-file-path-from-command-name command))))
(with-temp-buffer
(insert-file-contents file-path)
(and (search-forward "> " (point-max) t 1)
(concat (make-string (- tldr-length-of-longest-command-name (length command)) ? )
" -- "
(buffer-substring-no-properties (point) (line-end-position)))))))
;;;###autoload
(defun tldr (&optional cmd)
"Lookup TLDR docs."
(interactive)
(if (not (file-exists-p tldr-directory-path))
(if (tldr--check-unzip)
(progn
(message "This is the first time you have run TLDR.
Please wait while the latest TLDR docs are downloaded...")
(sit-for 3)
(tldr-update-docs)
(tldr)))
(setq tldr-length-of-longest-command-name (apply #'max (mapcar #'length (tldr-get-commands-list))))
(let* ((completion-extra-properties '(:annotation-function tldr-completion-annotation))
(command (or cmd
(completing-read "TLDR: " (tldr-get-commands-list) nil t
(when tldr-use-word-at-point (current-word))))))
(if (string= "" command)
(message "No input, canceled.")
(progn
(with-temp-buffer-window "*tldr*" nil nil)
(if (not (equal (buffer-name) "*tldr*"))
(switch-to-buffer-other-window "*tldr*"))
(if (not (equal major-mode 'tldr-mode))
(tldr-mode))
(let ((help-xref-following t)) ;See `help-buffer' & `help-setup-xref'
(help-setup-xref (list #'tldr command) t))
;; fuck you docstring (╯°□°）╯︵ ┻━┻
;; `help-setup-xref'
;; (help-setup-xref ITEM INTERACTIVE-P)
;; ITEM is a (FUNCTION . ARGS) pair appropriate for recreating the help .....
;; NOT A PAIR AT ALL! This shit waste me one hour.
(let (buffer-read-only)
(insert (tldr-render-markdown command))
(insert "\n")
;; Make a back-reference in this buffer if appropriate.
(when help-xref-stack
(help-insert-xref-button help-back-label 'help-back
(current-buffer)))
;; Make a forward-reference in this buffer if appropriate.
(when help-xref-forward-stack
(when help-xref-stack
(insert "\t"))
(help-insert-xref-button help-forward-label 'help-forward
(current-buffer)))
(goto-char (point-min))))))))
(declare-function Man-default-man-entry "man")
(declare-function helm "helm")
(declare-function helm-build-sync-source "helm-source")
;;;###autoload
(defun helm-tldr ()
"Helm interface for `tldr'."
(interactive)
(unless (require 'helm nil t)
(user-error "Helm not available"))
(require 'man)
(let* ((default-cmd (Man-default-man-entry))
(cmd (completing-read
(format "tldr%s"
(if (string= default-cmd "")
": "
(format " (default %s): " default-cmd)))
(tldr-get-commands-list)
nil t nil nil default-cmd))
(markdown (tldr-render-markdown cmd)))
(helm :sources (helm-build-sync-source "tldr"
:header-name
(lambda (_)
(with-temp-buffer
(insert markdown)
(replace-regexp-in-string
"\n\n *" ": "
(buffer-substring-no-properties
(point-min)
(progn
(goto-char (point-min))
(forward-line 2)
(line-end-position))))))
:candidates
(lambda ()
(with-temp-buffer
(insert markdown)
(goto-char (point-min))
(let ((res) text code)
(while (re-search-forward "^- " nil 'no-error)
(setq text (buffer-substring (point) (line-end-position)))
(forward-line 2)
(back-to-indentation)
(setq code (buffer-substring (point) (line-end-position)))
(push (concat text "\n" code) res))
(nreverse res))))
:multiline t
:coerce (lambda (candidate) (substring candidate (1+ (string-match "\n" candidate))))
:action
'(("Insert command" . insert)
("Copy command to kill-ring" . kill-new)))
:buffer "*helm tldr*")))
(provide 'tldr)
;;; tldr.el ends here