/
shim.el
264 lines (223 loc) · 8.95 KB
/
shim.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
;;; shim.el --- Emacs integration for Xenv -*- lexical-binding: t; -*-
;; Copyright (C) 2018-2019 Gong Qijian <gongqijian@gmail.com>
;; Author: Gong Qijian <gongqijian@gmail.com>
;; Created: 2018/12/25
;; Version: 0.1.0
;; Package-Requires: ((emacs "24.4"))
;; URL: https://github.com/twlz0ne/shim.el
;; Keywords: environment, tools
;; This program is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
;; This program is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
;; GNU General Public License for more details.
;; You should have received a copy of the GNU General Public License
;; along with this program. If not, see <http://www.gnu.org/licenses/>.
;;; Commentary:
;; Emacs integration for Xenv.
;; See more at README.md
;;; Change Log:
;;
;; 0.1.1 2020/02/11
;;
;; Fix the global version detection error
;; Add ‘shim-add-{dir,file}-local-version’
;;
;; 0.1.0 2018/12/25
;;
;; Initial version.
;;
;;; Code:
(require 'cl-lib)
(define-error 'shim-error "Shim error" 'error)
(cl-defstruct shim--shim ()
language
major-modes
executable
global-version-file
(built-in-version "system" :read-only t))
(defvar shim--shims '()
"Alist id -> shim--shim.
It contains all of the shim--shim instances that are currently regitered.")
(defun shim--guess-language ()
"Guess language of current buffer."
(catch 'found
(mapc (lambda (pair)
(when (memq major-mode (shim--shim-major-modes (cdr pair)))
(throw 'found (car pair))))
shim--shims)
(signal 'shim-error (list (format "Not support for `%s'" major-mode)))))
(defun shim--version-from-file (&optional ver-file)
"Return version from VER-FILE."
(let ((ver-file (expand-file-name (or ver-file (shim-version-file)))))
(if (and ver-file (file-exists-p ver-file))
(replace-regexp-in-string
"\\(?:\n\\)\\'" "" (shell-command-to-string
(format "head -n 1 \"%s\"" ver-file)))
(car (shim-versions)))))
(defun shim--version-from-env (&optional language)
"Return version of LANGUAGE from env."
(let* ((language (or language (shim--guess-language)))
(entity (cdr (assq language shim--shims)))
(basename (file-name-base (shim--shim-executable entity))))
(getenv (upcase (concat basename "_version")))))
(defun shim-version (&optional language)
"Show currently active version of LANGUAGE."
(or (shim--version-from-env language)
(shim--version-from-file
(let ((shim (cdr (assoc language shim--shims))))
(when shim
(shim--shim-global-version-file shim))))))
(defun shim-versions (&optional language)
"List installed versions of LANGUAGE."
(let* ((language (or language (shim--guess-language)))
(command (format "%s versions --bare" (shim--shim-executable (cdr (assq language shim--shims)))))
(errcode)
(output (with-output-to-string
(with-current-buffer standard-output
(setq errcode (call-process-shell-command command nil standard-output))))))
(if (zerop errcode)
(cons "system" (split-string output))
(signal 'shim-error (list output)))))
(defun shim-read-version (&optional language)
"Read virtual environment from user input for LANGUAGE."
(completing-read
"Version: "
(shim-versions (or language (shim--guess-language)))))
(defun shim-version-file (&optional language dir)
"Lookup `.<LANGUAGE>-version' from DIR or current folder."
(let* ((language (or language (shim--guess-language)))
(ver-file (downcase (format ".%s-version" language)))
(file-dir (locate-dominating-file (or dir default-directory) ver-file)))
(if file-dir
(concat file-dir ver-file)
(shim--shim-global-version-file (cdr (assq language shim--shims))))))
(defun shim-local-variable (&optional language)
"Return file local shim variable for LANGUAGE."
(let* ((language (or language (shim--guess-language)))
(symbol (intern (downcase (format "shim-%s-version" language)))))
symbol))
;;;###autoload
(defun shim-add-file-local-version ()
"Add file-local ‘shim-{language}-version’ with its value to the Local Variables list."
(interactive)
(add-file-local-variable (shim-local-variable (shim--guess-language))
(shim-read-version)))
;;;###autoload
(defun shim-add-dir-local-version ()
"Add directory-local ‘shim-{language}-version’ with its value and major-mode of current buffer to .dir-locals.el."
(interactive)
(add-dir-local-variable major-mode
(shim-local-variable (shim--guess-language))
(shim-read-version)))
;;;###autoload
(defun shim-unset (&optional language)
"Unset version of LANGUAGE."
(interactive)
(kill-local-variable 'process-environment)
(let* ((language (or language (shim--guess-language)))
(entity (cdr (assq language shim--shims)))
(basename (file-name-base (shim--shim-executable entity))))
(setenv (upcase (concat basename "_version")))
(force-mode-line-update)))
;;;###autoload
(defun shim-set (version &optional language)
"Set VERSION of LANGUAGE."
(interactive (list (shim-read-version)))
(setq-local process-environment (cl-copy-list process-environment))
(let* ((language (or language (shim--guess-language)))
(entity (cdr (assq language shim--shims)))
(basename (file-name-base (shim--shim-executable entity))))
(setenv (upcase (concat basename "_version")) version)
(force-mode-line-update)))
;;;###autoload
(defun shim-auto-set (&optional language)
"Auto set VERSION of LANGUAGE."
(interactive)
(let* ((language (or language (shim--guess-language)))
(version (or (symbol-value (shim-local-variable language))
(shim--version-from-file (shim-version-file language)))))
(shim-set version language)))
(defmacro shim-register-mode (language mode)
"Registers major MODE to LANGUAGE.
\(fn 'example-lang 'example-mode)"
(gv-letplace (getter setter) `(shim--shim-major-modes (cdr (assq ,language shim--shims)))
`(unless (memq ,mode ,getter)
(funcall ,setter (push ,mode ,getter)))))
(defun shim-init (shim)
"Registers shim--shim instance SHIM."
(let* ((language (shim--shim-language shim))
(abs-path (or (executable-find (shim--shim-executable shim))
(signal 'shim-error
(list (format "%s: command not found" (shim--shim-executable shim))))))
(exe-name (file-name-base abs-path)))
(eval
`(defvar ,(intern (format "shim-%s-version" language)) nil))
(add-to-list 'exec-path (expand-file-name (format "~/.%s/shims" exe-name)))
(add-to-list 'shim--shims (cons language shim))
(setf (shim--shim-global-version-file shim)
(expand-file-name (format "~/.%s/version" exe-name)))))
(defcustom shim-mode-line
'(:eval
(let ((language (shim--guess-language)))
(when (shim-version language)
(format " %s:%s"
(capitalize
(file-name-base
(shim--shim-executable (cdr (assq language shim--shims)))))
(shim-version language)))))
"How ‘shim’ will indicate the current language version in the mode line."
:group 'shim
:type 'sexp
:risky t
:package-version '(shim . "0.1.0"))
(defvar shim-mode-map
(let ((map (make-sparse-keymap)))
(define-key map (kbd "C-c C-s") 'shim-set)
(define-key map (kbd "C-c C-u") 'shim-unset)
map))
(define-minor-mode shim-mode
"Toggle shim-mode on or off.
Key bindings:
\\{shim-mode-map}"
:global nil
:lighter shim-mode-line
:keymap shim-mode-map
(if shim-mode
(shim-auto-set)
(shim-unset)))
(cl-defun shim-init-go (&key (major-modes '(go-mode)) (executable "goenv"))
(shim-init
(make-shim--shim
:language 'go
:major-modes major-modes
:executable executable)))
(cl-defun shim-init-java (&key (major-modes '(java-mode)) (executable "jenv"))
(shim-init
(make-shim--shim
:language 'java
:major-modes major-modes
:executable executable)))
(cl-defun shim-init-node (&key (major-modes '(js-mode)) (executable "nodenv"))
(shim-init
(make-shim--shim
:language 'node
:major-modes major-modes
:executable executable)))
(cl-defun shim-init-python (&key (major-modes '(python-mode)) (executable "pyenv"))
(shim-init
(make-shim--shim
:language 'python
:major-modes major-modes
:executable executable)))
(cl-defun shim-init-ruby (&key (major-modes '(ruby-mode)) (executable "rbenv"))
(shim-init
(make-shim--shim
:language 'ruby
:major-modes major-modes
:executable executable)))
(provide 'shim)
;;; shim.el ends here