blob: 548aa83acd82f351146d1d22df041561e773e000 (
plain) (
blame)
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
|
;;; pants.el --- A frontend for pants.
;; Copyright © 2016 Franck Cuny <franck.cuny@gmail.com>
;; Author: Franck Cuny <franck.cuny@gmail.com>
;; URL: https://github.com/franckcuny/pants.el
;;; Commentary:
;;
;; This library provides an interface to `pants', a fast, scalable build system.
;; See the README for more details.
;;; Code:
(require 'compile)
(require 'python)
(defcustom pants-completion-system 'ivy
"The completion system to be used by pants."
:group 'pants
:type '(radio
(const :tag "ivy" ivy)
(const :tag "ido" ido)
(const :tag "helm" helm)))
(defcustom pants-source-tree-root nil
"Path to the repository."
:group 'pants
:type 'string)
(defcustom pants-ini "pants.ini"
"Path to the pants.ini file to use. This variable must be set."
:group 'pants
:type 'string)
(defcustom pants-exec-name "pants"
"Path to the pants executable. This variable must be set."
:group 'pants
:type 'string)
(defcustom pants-extra-args ""
"Extra arguments to pass to the pants executable."
:group 'pants
:type 'string)
(defcustom pants-exec-args "--no-colors"
"Arguments to the pants executable. Default is '--no-colors'"
:group 'pants
:type 'string)
(defcustom pants-build-file "BUILD"
"Name of the build files. Default is 'BUILD'"
:group 'pants
:type 'string)
(defcustom pants-bury-compilation-buffer nil
"Set this variable to true to bury the compilation buffer if there's no error."
:group 'pants
:type 'boolean)
(defvar *pants-compilation-buffer* "*pants-compilation-buffer*")
(defun pants--find-directory-containing-build-file (file)
"Finds the directory containing the build file next to a give file."
(let ((root nil)
try)
(while (not (or root
(null file)
(string-match locate-dominating-stop-dir-regexp file)))
(setq try (if (stringp pants-build-file)
(file-exists-p (expand-file-name pants-build-file file))))
(cond (try (setq root file))
((equal file (setq file (file-name-directory
(directory-file-name file))))
(setq file nil))))
(and root (expand-file-name (file-name-as-directory root)))))
(defun pants--get-source-tree ()
"Returns the name of the directory for the source tree, with a trailing slash."
(file-name-as-directory pants-source-tree-root))
(defun pants--build-command ()
"Returns the complete command to run."
(format "%s%s %s --config-override=%s%s %s"
(pants--get-source-tree) pants-exec-name pants-extra-args (pants--get-source-tree) pants-ini pants-exec-args))
(defun pants--python-repl-action (target)
"Starts a Python REPL."
(let ((pants-repl-command (format "%s repl %s" (pants--build-command) target)))
(set (make-local-variable 'default-directory) pants-source-tree-root)
(set (make-local-variable 'python-shell-exec-path) '(pants-source-tree-root))
(set (make-local-variable 'python-shell-interpreter) pants-source-tree-root)
(set (make-local-variable 'python-shell-interpreter-args) pants-repl-command)
(python-shell-switch-to-shell)))
(defun pants--build-action (target)
"Executes the `binary' command"
(let ((compile-command (format "%s binary %s" (pants--build-command) target)))
(pants--compile compile-command)))
(defun pants--test-action (target)
"Executes the `test' command"
(let ((compile-command (format "%s test %s" (pants--build-command) target)))
(pants--compile compile-command)))
(defun pants--fmt-action (target)
"Executes the `fmt' command"
(let ((compile-command (format "%s fmt.isort %s" (pants--build-command) target)))
(pants--compile compile-command)))
(defun pants--compilation-setup ()
"Sets the local configuration for the compile buffer"
(set (make-local-variable 'compilation-scroll-output) t)
(set (make-local-variable 'compilation-disable-input) t)
(set (make-local-variable 'compilation-exit-message-function)
(lambda (status code msg)
(when (and
(eq status 'exit)
(zerop code)
(and pants-bury-compilation-buffer t)
(get-buffer *pants-compilation-buffer*))
(bury-buffer)
(delete-window (get-buffer-window (get-buffer *pants-compilation-buffer*))))
(cons msg code))))
(defun pants--compile (command)
"Executes the compilation"
(let ((compilation-buffer-name-function (lambda (arg) *pants-compilation-buffer*)))
(compilation-start command 'pants-mode)))
(defun pants--build-target-list (file action)
"Generates a list of existing targets"
(let ((build-command (format "%s list %s:" (pants--build-command) file))
targets target)
(set (make-local-variable 'default-directory) (pants--get-source-tree))
(with-temp-buffer
(insert
(shell-command-to-string build-command))
(goto-char (point-min))
(while (re-search-forward "^\\(.+\\)$" nil t)
(setq target (match-string 1))
(push target targets)))
(cond
((eq pants-completion-system 'ivy)
(if (fboundp 'ivy-read)
(ivy-read "Pants Targets" targets
:action (lambda (target) (funcall action target)))
(user-error "Please install ivy from https://github.com/abo-abo/swiper")))
((eq pants-completion-system 'helm)
(if (fboundp 'helm)
(helm :sources
`((name . "Pants Targets")
(candidates . ,targets)
(action . action))
:buffer "*helm pants targets*"
:prompt "pants: ")
(user-error "Please install helm from https://github.com/emacs-helm/helm")))
((eq pants-completion-system 'ido)
(ido-completing-read "Pants target: " targets)))))
(defun pants--get-build-file-for-current-buffer ()
"Finds the nearest build file for the current buffer"
(pants--find-directory-containing-build-file (file-name-directory (buffer-file-name))))
(define-compilation-mode pants-mode "pants"
(set (make-local-variable 'compilation-process-setup-function)
'pants--compilation-setup))
;;;###autoload
(defun pants-find-build-file ()
"Finds the build file and if it exists, open it."
(interactive)
(let ((build-file (pants--get-build-file-for-current-buffer)))
(if build-file
(find-file (concat build-file pants-build-file))
(user-error "Could not find %s" pants-build-file))))
;;;###autoload
(defun pants-run-binary ()
"Builds a binary from a target."
(interactive)
(let ((build-file (pants--get-build-file-for-current-buffer)))
(if build-file
(pants--build-target-list build-file 'pants--build-action)
(user-error "Could not find %s" pants-build-file))))
;;;###autoload
(defun pants-run-python-repl ()
"Runs a REPL from a target."
(interactive)
(let ((build-file (pants--get-build-file-for-current-buffer)))
(if build-file
(pants--build-target-list build-file 'pants--python-repl-action)
(user-error "Could not find %s" pants-build-file))))
;;;###autoload
(defun pants-run-test ()
"Runs the tests from a target."
(interactive)
(let ((build-file (pants--get-build-file-for-current-buffer)))
(if build-file
(pants--build-target-list build-file 'pants--test-action)
(user-error "Could not find %s" pants-build-file))))
;;;###autoload
(defun pants-run-fmt ()
"Runs fmt on a target file to sort the import files (Python only)."
(interactive)
(let ((build-file (pants--get-build-file-for-current-buffer)))
(if build-file
(pants--build-target-list build-file 'pants--fmt-action)
(user-error "Could not find %s" pants-build-file))))
(provide 'pants)
|
