-
Notifications
You must be signed in to change notification settings - Fork 0
/
ivy-ag.el
627 lines (558 loc) · 23.5 KB
/
ivy-ag.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
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
;;; ivy-ag.el --- A front-end for ag (the silver searcher) with ivy interface -*- lexical-binding: t -*-
;; Copyright (C) 2022 Karim Aziiev <[email protected]>
;; Author: Karim Aziiev <[email protected]>
;; URL: https://github.com/KarimAziev/ivy-ag
;; Keywords: matching, tools
;; Version: 0.2.0
;; Package-Requires: ((emacs "27.1") (ivy "0.13.4") (counsel "0.13.4"))
;; This file is NOT part of GNU Emacs.
;; 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, 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:
;; A front-end for ag (the silver searcher) with ivy interface.
;; The package provides functionality like `counsel-ag' but allows to
;; traverse upwards search directory and some extra switches.
;; Commands
;; M-x `ivy-ag' (&optional dir init-input flags)
;; Execute ag command in DIRECTORY with INIT-INPUT and FLAGS.
;; Default value for DIRECTORY is current git project or default directory.
;; M-x `ivy-ag-default-dir'
;; Execute ag command in default directory.
;; Minibuffer commands
;; During executing `ivy-ag' and `ivy-ag-default-dir' such commands available in the minibuffer:
;; M-x `ivy-ag-open-in-other-window'
;; Jump to search result in other window.
;; M-x `ivy-ag-switch-prev-dir' (&optional _rest)
;; Search in previous directory defined in `ivy-ag-switchable-directories'.
;; M-x `ivy-ag-switch-next-dir' (&optional _rest)
;; Search in next directory defined in `ivy-ag-switchable-directories'.
;; M-x `ivy-ag-toggle-vcs-ignores'
;; Toggle vcs ignore.
;; M-x `ivy-ag-up'
;; Change current ag directory to parent directory and resume searching.
;; M-x `ivy-ag-cd'
;; Read directory name and start or resume ag search in it.
;; M-x `ivy-ag-change-file-type'
;; Read supported file types and perform search.
;; Customization
;; `ivy-ag-initial-input-chars'
;; Chars in the same format as for `skip-chars-forward'.
;; They are used to determine word at point for initial input.
;; `ivy-ag-switchable-directories'
;; List of directories, which can be switched in minibuffer.
;;; Code:
(eval-when-compile
(require 'subr-x))
(require 'cl-lib)
(require 'ivy)
(require 'counsel)
(defvar ivy-ag-configure-keywords
'(:parent :initial-input :height :occur
:update-fn :init-fn :unwind-fn
:index-fn :sort-fn :sort-matches-fn
:format-fn :display-fn :display-transformer-fn
:alt-done-fn :more-chars :grep-p :exit-codes))
(defvar ivy-ag-ivy-read-keywords
'(:predicate :require-match :initial-input
:history :preselect
:def :keymap :update-fn :sort
:unwind :re-builder :matcher
:dynamic-collection
:extra-props
:action :multi-action))
(defmacro ivy-ag-compose (&rest functions)
"Return right-to-left composition from FUNCTIONS."
(declare (debug t) (pure t) (side-effect-free t))
`(ivy-ag-pipe ,@(reverse functions)))
(defun ivy-ag-call-process (command &rest args)
"Execute COMMAND with ARGS synchronously.
Return stdout output if command existed with zero status, nil otherwise."
(let ((buff (generate-new-buffer command)))
(with-current-buffer buff
(let ((status (apply #'call-process command nil t nil
(flatten-list args))))
(let ((result (string-trim (buffer-string))))
(if (zerop status)
(prog1 result (kill-current-buffer))
(message result) nil))))))
(defun ivy-ag-plist-omit (plist keywords)
"Omit KEYWORDS with it's values from PLIST."
(if (seq-find (lambda (it) (memq it plist)) keywords)
(let ((result))
(while plist
(let* ((key (pop plist))
(val (pop plist)))
(unless (memq key keywords)
(push (list key val) result))))
(reverse result))
plist))
(defun ivy-ag-plist-pick (plist keywords)
"Pick KEYWORDS from PLIST."
(let ((result)
(keyword))
(while (setq keyword (pop keywords))
(when (memq keyword plist)
(let ((value (plist-get plist keyword)))
(setq result (nconc result
(list keyword
value))))))
result))
(defun ivy-ag-mark-candidates (candidates)
"Mark CANDIDATES from ivy collection."
(dolist (cand (ivy-state-collection
ivy-last))
(when (member cand
candidates)
(let ((marked-cand (concat
ivy-mark-prefix
cand)))
(setq ivy--old-cands
ivy--all-candidates)
(setcar
(member cand
ivy--all-candidates)
(setcar
(member cand
ivy--old-cands)
marked-cand))
(setq ivy-marked-candidates
(append
ivy-marked-candidates
(list
marked-cand)))))))
(defmacro ivy-ag-pipe (&rest functions)
"Return left-to-right composition from FUNCTIONS."
(declare (debug t) (pure t) (side-effect-free t))
`(lambda (&rest args)
,@(let ((init-fn (pop functions)))
(list
(seq-reduce
(lambda (acc fn)
(if (symbolp fn)
`(funcall #',fn ,acc)
`(funcall ,fn ,acc)))
functions
(if (symbolp init-fn)
`(apply #',init-fn args)
`(apply ,init-fn args)))))))
;;;###autoload
(defun ivy-ag-read-multi (prompt collection &rest ivy-args)
"Read COLLECTION with PROMPT and return list with selected candidates.
IVY-ARGS are combined args both from `ivy-read' and `ivy-configure',
excluding:
- :action
- :multi-action
- :caller
but accepting:
- :persistent-action
- :premarked
Persistent action will be called with current candidate without exiting
completion.
Premarked is candidates from COLLECTION which should be initially marked."
(interactive)
(dolist (alist-sym '(ivy--parents-alist
ivy-initial-inputs-alist
ivy-height-alist
ivy-update-fns-alist
ivy-unwind-fns-alist
ivy-init-fns-alist
ivy-index-functions-alist
ivy-sort-functions-alist
ivy-sort-matches-functions-alist
ivy-format-functions-alist
ivy-display-functions-alist
ivy--display-transformers-alist
ivy-alt-done-functions-alist
ivy-more-chars-alist))
(ivy--alist-set alist-sym 'ivy-ag-read-multi nil))
(when (and (boundp 'counsel--async-exit-code-plist)
(plist-get counsel--async-exit-code-plist
'ivy-ag-read-multi))
(setq counsel--async-exit-code-plist
(ivy-ag-plist-omit counsel--async-exit-code-plist
'(ivy-ag-read-multi))))
(let ((marked)
(persistent-action (plist-get ivy-args :persistent-action))
(premarked-candidates (plist-get ivy-args :premarked)))
(let ((args (append
(list prompt
collection
:caller 'ivy-ag-read-multi
:action (lambda (item)
(when (and persistent-action
(null ivy-exit))
(funcall persistent-action item))
item)
:multi-action (lambda (children)
(setq marked children)))
(ivy-ag-plist-pick
ivy-args
(seq-difference ivy-ag-ivy-read-keywords
'(:multi-action
:action)))))
(configure-args (ivy-ag-plist-pick
ivy-args
ivy-ag-configure-keywords))
(item))
(when configure-args
(push 'ivy-ag-read-multi configure-args)
(apply #'ivy-configure configure-args))
(setq item (if premarked-candidates
(minibuffer-with-setup-hook
(lambda ()
(when (active-minibuffer-window)
(ivy-ag-mark-candidates premarked-candidates)))
(apply #'ivy-read args))
(apply #'ivy-read args)))
(or marked
(when item (list item))))))
(cl-defstruct ivy-ag-state flags input directory buffer)
(defvar ivy-ag-last (make-ivy-ag-state))
(defvar ivy-ag-last-input nil)
(defgroup ivy-ag nil
"Search with ag and ivy."
:link '(url-link :tag "Repository"
"https://github.com/KarimAziev/ivy-ag")
:group 'ivy-ag)
(defcustom ivy-ag-switchable-directories (list user-emacs-directory)
"List of directories for switching.
They can be switched with commands `ivy-ag-switch-next-dir'
and `ivy-ag-switch-prev-dir'."
:type '(repeat directory)
:group 'ivy-ag)
(defcustom ivy-ag-initial-input-chars "-*_~$A-Za-z0-9:.#\\+"
"Chars in the same format as for `skip-chars-forward'.
They are used to determine word at point for initial input."
:type 'string
:group 'ivy-ag)
(defun ivy-ag-file-parent (path)
"Return the parent directory to PATH without slash."
(let ((parent (file-name-directory
(directory-file-name
(expand-file-name path default-directory)))))
(when (and (file-exists-p path)
(file-exists-p parent)
(not (equal
(file-truename (directory-file-name
(expand-file-name path)))
(file-truename (directory-file-name
(expand-file-name parent))))))
(if (file-name-absolute-p path)
(directory-file-name parent)
(file-relative-name parent)))))
;;;###autoload
(defun ivy-ag-cd ()
"Read directory name and start or resume ag search in it."
(interactive)
(if (active-minibuffer-window)
(let ((input ivy-text)
(new-dir))
(setq new-dir (read-directory-name "Search in:\s"))
(ivy-quit-and-run
(funcall-interactively #'ivy-ag new-dir input)))
(funcall-interactively #'ivy-ag (read-directory-name "Search in:\s"))))
(ivy-configure 'ivy-ag-cd
:display-transformer-fn 'abbreviate-file-name)
;;;###autoload
(defun ivy-ag-up ()
"Change current ag directory to parent directory and resume searching."
(interactive)
(when-let* ((current-dir (ivy-ag-state-directory ivy-ag-last))
(parent (ivy-ag-file-parent current-dir)))
(let ((input ivy-text))
(ivy-quit-and-run
(funcall #'ivy-ag (file-name-as-directory parent) input)))))
;;;###autoload
(defun ivy-ag-toggle-vcs-ignores ()
"Toggle vcs ignore."
(interactive)
(let ((flags (if (member "--skip-vcs-ignores"
(ivy-ag-state-flags
ivy-ag-last))
(setf (ivy-ag-state-flags ivy-ag-last)
(remove "--skip-vcs-ignores"
(ivy-ag-state-flags
ivy-ag-last)))
(append (ivy-ag-state-flags ivy-ag-last)
'("--skip-vcs-ignores"))))
(input ivy-text))
(if (eq 'ivy-ag (ivy-state-caller ivy-last))
(ivy-quit-and-run
(funcall-interactively #'ivy-ag
(ivy-ag-state-directory ivy-ag-last)
input flags))
(funcall-interactively #'ivy-ag (ivy-ag-state-directory ivy-ag-last)
input flags))))
(defvar ivy-ag-dirs-switchers nil)
(defvar ivy-ag-current-dir-index 0)
(defun ivy-ag-index-switcher (step current-index switch-list)
"Increase or decrease CURRENT-INDEX depending on STEP value and SWITCH-LIST."
(cond ((> step 0)
(if (>= (+ step current-index)
(length switch-list))
0
(+ step current-index)))
((< step 0)
(if (or (<= 0 (+ step current-index)))
(+ step current-index)
(1- (length switch-list))))))
(defun ivy-ag-switch-dir-index (step)
"Increase or decrease `ivy-ag-current-dir-index' on STEP and resume search."
(setq ivy-ag-dirs-switchers
(append
'(nil)
(mapcar #'expand-file-name
(mapcar #'expand-file-name
(seq-filter
#'file-exists-p
(delete nil ivy-ag-switchable-directories))))))
(setq ivy-ag-current-dir-index (ivy-ag-index-switcher
step
ivy-ag-current-dir-index
ivy-ag-dirs-switchers))
(let ((input ivy-text)
(next-dir (or (nth ivy-ag-current-dir-index
ivy-ag-dirs-switchers)
(locate-dominating-file
default-directory ".git")))
(flags (ivy-ag-state-flags ivy-ag-last)))
(if (minibuffer-window-active-p (selected-window))
(ivy-quit-and-run
(funcall-interactively #'ivy-ag next-dir input flags))
(funcall-interactively #'ivy-ag
(nth ivy-ag-current-dir-index
ivy-ag-dirs-switchers)
nil (ivy-ag-state-flags ivy-ag-last)))))
;;;###autoload
(defun ivy-ag-switch-next-dir (&optional _rest)
"Search in next directory defined in `ivy-ag-switchable-directories'."
(interactive)
(ivy-ag-switch-dir-index 1))
;;;###autoload
(defun ivy-ag-switch-prev-dir (&optional _rest)
"Search in previous directory defined in `ivy-ag-switchable-directories'."
(interactive)
(ivy-ag-switch-dir-index -1))
;;;###autoload
(defun ivy-ag-open-in-other-window ()
"Jump to search result in other window."
(interactive)
(ivy-exit-with-action #'ivy-ag-open-in-other-window-action))
(defun ivy-ag-open-in-other-window-action (x)
"Go to occurrence X in current Git repository."
(when (string-match "\\`\\(.*?\\):\\([0-9]+\\):\\(.*\\)\\'" x)
(let ((file-name (match-string-no-properties 1 x))
(line-number (match-string-no-properties 2 x)))
(find-file-other-window (expand-file-name
file-name
(ivy-state-directory ivy-last)))
(goto-char (point-min))
(forward-line (1- (string-to-number line-number)))
(when (re-search-forward (ivy--regex ivy-text t) (line-end-position) t)
(when (and (boundp 'swiper-goto-start-of-match))
(goto-char (match-beginning 0))))
(when (fboundp 'swiper--ensure-visible)
(swiper--ensure-visible))
(run-hooks 'counsel-grep-post-action-hook)
(unless (eq ivy-exit 'done)
(when (fboundp 'swiper--cleanup)
(swiper--cleanup))
(when (fboundp 'swiper--add-overlays)
(swiper--add-overlays (ivy--regex ivy-text)))))))
(defun ivy-ag-get-region ()
"Get current region or nil."
(when
(and (region-active-p)
(use-region-p))
(string-trim (buffer-substring-no-properties
(region-beginning) (region-end)))))
(defvar ivy-ag-map
(let ((map (make-sparse-keymap)))
(define-key map (kbd "C-<backspace>") #'ivy-ag-up)
(define-key map (kbd "C-l") #'ivy-ag-up)
(define-key map (kbd "C-j") #'ivy-call)
(define-key map (kbd "M-q") #'counsel-git-grep-query-replace)
(define-key map (kbd "C->") #'ivy-ag-switch-next-dir)
(define-key map (kbd "C-<") #'ivy-ag-switch-prev-dir)
(define-key map (kbd "C-c C-o") #'ivy-ag-open-in-other-window)
(define-key map (kbd "M-.") #'ivy-ag-toggle-vcs-ignores)
(define-key map (kbd "C-M-.") #'ivy-ag-change-file-type)
(define-key map (kbd "C-.") #'ivy-ag-cd)
map))
(defun ivy-ag-grep-action (x)
"Go to occurrence X in current Git repository."
(when (string-match "\\`\\(.*?\\):\\([0-9]+\\):\\(.*\\)\\'" x)
(let ((file-name (match-string-no-properties 1 x))
(line-number (match-string-no-properties 2 x)))
(find-file (expand-file-name
file-name
(ivy-state-directory ivy-last)))
(pcase major-mode
('org-mode (when (fboundp 'org-show-all)
(org-show-all))))
(goto-char (point-min))
(forward-line (1- (string-to-number line-number)))
(when (re-search-forward (ivy--regex ivy-text t) (line-end-position) t)
(when swiper-goto-start-of-match
(goto-char (match-beginning 0))))
(swiper--ensure-visible)
(run-hooks 'counsel-grep-post-action-hook)
(unless (eq ivy-exit 'done)
(swiper--cleanup)
(swiper--add-overlays (ivy--regex ivy-text))))))
(defun ivy-ag-read-file-type ()
"Read multiple file types in the minibuffer, with completion."
(let ((types (mapcar #'car (ivy-ag-get-file-types))))
(ivy-ag-read-multi "File type: " types
:preselect
(ivy-ag-get-default-file-type))))
(defun ivy-ag-get-file-types ()
"Return supported ag file types."
(let ((file-types (seq-drop-while
(ivy-ag-compose
'not (apply-partially #'string-prefix-p "--"))
(split-string
(ivy-ag-call-process "ag" "--list-file-types") nil t))))
(setq file-types (seq-reduce
(lambda (acc curr)
(setq acc
(push
(if (string-prefix-p "--" curr)
curr
(let* ((val (pop acc))
(cell
(if (not (consp val))
(list val curr)
(setcdr val (nconc (cdr val)
(list curr)))
val)))
cell))
acc)))
file-types '()))))
(defun ivy-ag-get-default-file-type ()
"Get default file type for current buffer filename."
(when-let* ((ext (when buffer-file-name
(file-name-extension buffer-file-name)))
(file-types (ivy-ag-get-file-types)))
(setq ext (concat "." ext))
(car (seq-find (ivy-ag-compose (apply-partially #'member ext)
'cdr)
file-types))))
;;;###autoload
(defun ivy-ag-change-file-type ()
"Read supported file types and perform search."
(interactive)
(if (active-minibuffer-window)
(let ((input ivy-text)
(dir (ivy-ag-state-directory ivy-ag-last)))
(progn
(put 'quit 'error-message "")
(run-at-time nil nil
(lambda (directory text-input)
(put 'quit 'error-message "Quit")
(with-demoted-errors "Error: %S"
(let ((file-type (ivy-ag-read-file-type)))
(funcall-interactively #'ivy-ag
directory
text-input file-type))))
dir input)
(abort-recursive-edit)))
(funcall-interactively #'ivy-ag nil nil (append
(ivy-ag-state-flags ivy-ag-last)
(ivy-ag-read-file-type)))))
(defvar ivy-ag-history nil
"History for `ivy-ag'.")
;;;###autoload
(defun ivy-ag (&optional directory init-input flags)
"Execute ag command in DIRECTORY with INIT-INPUT and FLAGS.
Default value for DIRECTORY is the current git project or default directory."
(interactive)
(unless directory
(setq directory (and (setq directory (or (locate-dominating-file
default-directory ".git")
default-directory))
(expand-file-name directory))))
(let ((input (or (seq-find (lambda (it)
(and (stringp it)
(not (string-blank-p it))))
`(,init-input
,ivy-ag-last-input
,(or (ivy-ag-get-region)
(when-let ((symb (symbol-at-point)))
(format "%s" (symbol-name symb)))))))))
(setq flags
(delete-dups
(if (and
(null flags)
(equal directory (ivy-ag-state-directory ivy-ag-last))
(ivy-ag-state-flags ivy-ag-last))
(ivy-ag-state-flags ivy-ag-last)
(or flags '("--smart-case")))))
(unless (or (member "--path-to-ignore" flags)
(file-exists-p "~/.ignore"))
(setq flags (append '("--path-to-ignore" "~/.ignore") flags)))
(setf (ivy-ag-state-flags ivy-ag-last)
flags)
(setf (ivy-ag-state-directory ivy-ag-last) directory)
(minibuffer-with-setup-hook
(lambda ()
(when input
(insert input)
(when (active-minibuffer-window)
(let ((re-chars "[$*+.?^]")
(max (- (point)
(length input))))
(save-excursion
(while (re-search-backward re-chars max t 1)
(unless (or (looking-back "[\\]" 0)
(nth 3 (syntax-ppss (point))))
(insert "\\"))))))))
(unwind-protect
(progn (setq counsel-ag-command counsel-ag-base-command)
(setq counsel--regex-look-around
counsel--grep-tool-look-around)
(counsel-require-program counsel-ag-command)
(setq counsel-ag-command
(counsel--format-ag-command
(string-join flags "\s") "%s"))
(let ((default-directory directory))
(ivy-read
(format "%s %s:\s" directory counsel-ag-command)
#'counsel-ag-function
:initial-input ""
:dynamic-collection t
:keymap ivy-ag-map
:history 'ivy-ag-history
:action #'ivy-ag-grep-action
:require-match t
:caller 'ivy-ag)))
(progn
(counsel-delete-process)
(while swiper--overlays
(when swiper--overlays
(delete-overlay (pop swiper--overlays)))))))))
(ivy-add-actions 'ivy-ag
'(("j" ivy-ag-open-in-other-window-action "other window")))
(ivy-configure 'ivy-ag
:occur #'counsel-ag-occur
:unwind-fn #'counsel--grep-unwind
:display-transformer-fn #'counsel-git-grep-transformer
:grep-p t
:exit-codes '(1 "No matches found"))
;;;###autoload
(defun ivy-ag-default-dir ()
"Perfoms search in default directory."
(interactive)
(funcall-interactively #'ivy-ag default-directory nil))
(provide 'ivy-ag)
;;; ivy-ag.el ends here