-
Notifications
You must be signed in to change notification settings - Fork 39
/
counsel-projectile.el
1708 lines (1505 loc) · 72.8 KB
/
counsel-projectile.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
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
;;; counsel-projectile.el --- Ivy integration for Projectile -*- lexical-binding: t -*-
;; Copyright (C) 2016-2021 Eric Danan
;; Author: Eric Danan
;; URL: https://github.com/ericdanan/counsel-projectile
;; Keywords: project, convenience
;; Version: 0.3.2
;; Package-Requires: ((counsel "0.13.4") (projectile "2.5.0"))
;; This file is NOT part of GNU Emacs.
;;; License:
;; 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 GNU Emacs; see the file COPYING. If not, write to the
;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
;; Boston, MA 02110-1301, USA.
;;; Commentary:
;;
;; Projectile has native support for using ivy as its completion
;; system. Counsel-projectile provides further ivy integration into
;; projectile by taking advantage of ivy's support for selecting from
;; a list of actions and applying an action without leaving the
;; completion session. Concretely, counsel-projectile defines
;; replacements for existing projectile commands as well as new
;; commands that have no projectile counterparts. A minor mode is also
;; provided that adds key bindings for all these commands on top of
;; the projectile key bindings.
;;
;;; Code:
;;* require
(require 'counsel)
(require 'projectile)
;;* global
(defgroup counsel-projectile nil
"Ivy integration for Projectile."
:group 'ivy
:group 'projectile)
(defun counsel-projectile--defcustom-action (command action group)
"Create a custom variable named \"COMMAND-action\" in GROUP,
with default value ACTION, to be used as `:action' parameter for
COMMAND's `ivy-read' call.
This variable holds either a single action function, or an action
list whose first element is the index of the default action in
the list and the remaining elements are the actions (a key, a
function, and a name for each action)."
(eval
`(defcustom ,(intern (format "%s-action" command))
',action
,(format "Action(s) for `%s'.
This variable holds either a single action function (function of
one variable, the selected candidate) or an action list
consisting of:
- the index of the default action in the list (1 for the first
action, etc),
- the available actions, each of which consists of:
- a key (string) to call the action,
- an action function of one variable,
- a name (string) for the action.
In both cases, extra actions can be added with `ivy-set-actions'.
An action is triggered for the selected candidate with `M-o
<key>' or `C-M-o <key>'. The default action can also be
triggered with `M-RET' or `C-M-RET'. If this variable holds a
single action function, this action becomes the default action
and is assigned the key \"o\". For an action list, it is also
usual to assign the key \"o\" to the default action." command)
:type '(choice
(function :tag "Single action function")
(cons :tag "Action list"
(integer :tag "Index of default action" :value 1)
(repeat :tag "Actions"
(list :tag "Action"
(string :tag " key")
(function :tag "function")
(string :tag " name")))))
:group ',group)))
(defun counsel-projectile--action-index (action-item action-list)
"Return the index in ACTION-LIST of the action whose key,
function, name, or index in the list (1 for the first action,
etc) is ACTION-ITEM. If there is no such action, throw an error.
ACTION-LIST is an action list whose first element is the index of
the default action in the list and the remaining elements are the
actions (a key, a function, and a name for each action)."
(let (index)
(if (integerp action-item)
(when (< 0 action-item (length action-list))
(setq index action-item))
(setq index (cl-position-if
(cond
((functionp action-item)
(lambda (action)
(equal action-item
(cadr action))))
((stringp action-item)
(lambda (action)
(member action-item
(list (car action) (cl-caddr action))))))
(cdr action-list)))
(when index
(setq index (1+ index))))
(or index
(error "Action not found: %s" action-item))))
(defun counsel-projectile-modify-action (action-var modifications)
"Make MODIFICATIONS to ACTION-VAR.
ACTION-VAR is a variable holding an action list whose first
element is the index of the default action in the list and the
remaining elements are the actions (a key, a function, and a name
for each action).
MODIFICATIONS is a list of modifications to be applied
sequentially to ACTION-LIST. Each modification has one of the
following formats:
(remove ACTION-ITEM)
Remove the action whose key, function, name, or index in
the list (1 for the first action, etc) is ACTION-ITEM
from the list.
(add ACTION TARGET-ITEM)
Add ACTION (a list containing a key, a function, and a
name) to the list, just before the action whose key,
function, name, or index in the list (1 for the first
action, etc) is TARGET-ITEM. If TARGET-ITEM is omitted,
add the action at the end of the list.
(move ACTION-ITEM TARGET-ITEM)
Move the action whose key, function, name, or index in
the list (1 for the first action, etc) is ACTION-ITEM
just before the action whose key, function, name, or
index in the list (1 for the first action, etc) is
TARGET-ITEM. If TARGET-ITEM is omitted, move the action
to the end of the list.
(setkey ACTION-ITEM KEY)
Set the key of the action whose key, function, name, or
index in the list (1 for the first action, etc) is
ACTION-ITEM to KEY.
(setfun ACTION-ITEM FUNCTION)
Set the function of the action whose key, function, name,
or index in the list (1 for the first action, etc) is
ACTION-ITEM to FUNCTION.
(setname ACTION-ITEM NAME)
Set the name of the action whose key, function, name, or
index in the list (1 for the first action, etc) is
ACTION-ITEM to NAME.
(default ACTION-ITEM)
Set the index of the default action in the list to that
of the action whose key, function, name, or index in the
list (1 for the first action, etc) is ACTION-ITEM.
If anything goes wrong, throw an error and do not modify ACTION-VAR."
(let ((action-list (symbol-value action-var))
mod)
;; Make sure ACTION-VAR actually holds a list and not a single
;; action function
(unless (listp action-list)
(error "%s's value is not a list" action-var))
(while (setq mod (pop modifications))
(pcase mod
(`(remove ,action-item)
(setq action-list
(remove (nth (counsel-projectile--action-index action-item action-list)
action-list)
action-list)))
(`(add ,action ,target-item)
(let ((index (counsel-projectile--action-index target-item action-list)))
;; copied from `helm-append-at-nth'
(setq action-list (cl-loop for a in action-list
for count from 1
collect a
when (= count index)
collect action))))
(`(add ,action)
(setq action-list (append action-list (list action))))
(`(move ,action-item ,target-item)
(push `(add ,(nth (counsel-projectile--action-index action-item action-list)
action-list)
,target-item)
modifications)
(push `(remove ,action-item)
modifications))
(`(move ,action-item)
(push `(add ,(nth (counsel-projectile--action-index action-item action-list)
action-list))
modifications)
(push `(remove ,action-item)
modifications))
(`(setkey ,action-item ,key)
(let ((index (counsel-projectile--action-index action-item action-list)))
(setq action-list (cl-loop for a in action-list
for count from 0
if (= count index)
collect (cons key (cdr a))
else
collect a))))
(`(setfun ,action-item ,fun)
(let ((index (counsel-projectile--action-index action-item action-list)))
(setq action-list (cl-loop for a in action-list
for count from 0
if (= count index)
collect (list (car a) fun (cl-caddr a))
else
collect a))))
(`(setname ,action-item ,name)
(let ((index (counsel-projectile--action-index action-item action-list)))
(setq action-list (cl-loop for a in action-list
for count from 0
if (= count index)
collect (list (car a) (cadr a) name)
else
collect a))))
(`(default ,action-item)
(setq action-list
(cons (counsel-projectile--action-index action-item action-list)
(cdr action-list))))))
(set action-var action-list)))
;;* counsel-projectile-find-file
(defcustom counsel-projectile-sort-files nil
"Non-nil if files should be sorted in
`counsel-projectile-find-file' and `counsel-projectile'.
The sorting function can be modified by adding an entry for
`counsel-projectile-find-file' in `ivy-sort-functions-alist'."
:type 'boolean
:group 'counsel-projectile)
(defcustom counsel-projectile-find-file-matcher 'counsel--find-file-matcher
"Function returning candidates matching minibuffer input in
`counsel-projectile-find-file', also used to match files in
`counsel-projectile'.
Several choices are proposed:
- Ivy generic matcher (`ivy--re-filter'). This is the matcher
used by default in all ivy commands.
- Counsel matcher (`counsel--find-file-matcher'). This is the
matcher used in `counsel-find-file', allowing to ignore some
files based on `counsel-find-file-ignore-regexp'.
- Counsel-projectile basename
matcher (`counsel-projectile-basename-matcher'). This one only
displays files whose basename matches minibuffer input, or if
there is none all files whose name (relative to the project
root) matches. It also uses the counsel matcher to ignore some
files.
It is also possible to use a custom matcher. It must be a function taking two argument, the regexp and the candidates (see e.g. `counsel--find-file-matcher')."
:type '(choice
(const :tag "Ivy generic matcher" ivy--re-filter)
(const :tag "Counsel matcher" counsel--find-file-matcher)
(const :tag "Counsel-projectile basename matcher" counsel-projectile-find-file-matcher-basename)
(function :tag "Custom function"))
:group 'counsel-projectile)
(defcustom counsel-projectile-find-file-more-chars 0
"Number of characters to input before matching project files are shown.
Setting it to a strictly positive value can improve performance in large projects."
:type 'integer
:group 'counsel-projectile)
(counsel-projectile--defcustom-action
'counsel-projectile-find-file
'(1
("o" counsel-projectile-find-file-action
"current window")
("j" counsel-projectile-find-file-action-other-window
"other window")
("x" counsel-projectile-find-file-action-extern
"open externally")
("r" counsel-projectile-find-file-action-root
"open as root")
("m" counsel-projectile-find-file-action-find-file-manually
"find file manually")
("k" counsel-projectile-find-file-action-delete
"delete")
("p" counsel-projectile-find-file-action-switch-project
"switch project"))
'counsel-projectile)
(defun counsel-projectile--find-file-matcher (regexp candidates)
(let ((ivy-more-chars-alist
`((t . ,counsel-projectile-find-file-more-chars))))
(or (ivy-more-chars)
(funcall counsel-projectile-find-file-matcher regexp candidates))))
(defun counsel-projectile-find-file-matcher-basename (regexp candidates)
"Return the list of CANDIDATES whose basename matches REGEXP,
or if there is none the list of all CANDIDATES matching REGEXP.
Also uses `counsel--find-file-matcher' to ignore candidates based
on `counsel-find-file-ignore-regexp'."
(let ((cands (ivy--re-filter regexp candidates)))
(or (and (not (string= ivy-text ""))
;; We first filter `cands' to retain only matches in file
;; basename. This is almost copied from `ivy--re-filter'
;; because we can't quite use it directly.
(let ((re-list (if (stringp regexp)
(list (cons regexp t))
regexp))
(res cands))
(dolist (re re-list)
(setq res
(ignore-errors
(funcall
(if (cdr re)
#'cl-remove-if-not
#'cl-remove-if)
(let ((re-str (car re)))
(lambda (x)
(string-match re-str
(file-name-nondirectory x))))
res))))
;; We then apply `counsel--find-file-matcher' to `res'
;; so we can honor `ivy-use-ignore', but we don't need
;; to filter again.
(counsel--find-file-matcher nil res)))
;; We apply `counsel--find-file-matcher' to `cands' so we can
;; honor `ivy-use-ignore', but we don't need to filter
;; again.
(counsel--find-file-matcher nil cands))))
(defun counsel-projectile-find-file-action (file)
"Find FILE and run `projectile-find-file-hook'."
(find-file (projectile-expand-root file))
(run-hooks 'projectile-find-file-hook))
(defun counsel-projectile-find-file-action-other-window (file)
"Find FILE in another window and run
`projectile-find-file-hook'."
(find-file-other-window (projectile-expand-root file))
(run-hooks 'projectile-find-file-hook))
(defun counsel-projectile-find-file-action-find-file-manually (file)
"Call `counsel-find-file' from FILE's directory."
(let* ((f (projectile-expand-root file))
(default-directory (file-name-directory f)))
(counsel-find-file)))
(defun counsel-projectile-find-file-action-extern (file)
"Find FILE externally and run `projectile-find-file-hook'."
(counsel-find-file-extern (projectile-expand-root file))
(run-hooks 'projectile-find-file-hook))
(defun counsel-projectile-find-file-action-root (file)
"Find FILE as root and run `projectile-find-file-hook'."
(counsel-find-file-as-root (projectile-expand-root file))
(run-hooks 'projectile-find-file-hook))
(defun counsel-projectile-find-file-action-delete (file)
"Delete FILE."
(counsel-find-file-delete (projectile-expand-root file)))
(defun counsel-projectile-find-file-action-switch-project (&optional _)
"Switch project action for `counsel-projectile-find-file'."
(counsel-projectile-switch-project 'counsel-projectile-switch-project-action-find-file))
(defun counsel-projectile-find-file-transformer (str)
"Transform non-visited file names with `ivy-virtual' face."
(if (not (get-file-buffer (projectile-expand-root str)))
(propertize str 'face 'ivy-virtual)
str))
;;;###autoload
(defun counsel-projectile-find-file (&optional arg dwim)
"Jump to a file in the current project.
With a prefix ARG, invalidate the cache first. If DWIM is
non-nil, use completion based on context."
(interactive "P")
(if (and (eq projectile-require-project-root 'prompt)
(not (projectile-project-p)))
(counsel-projectile-find-file-action-switch-project)
(projectile-maybe-invalidate-cache arg)
(let* ((project-files (projectile-current-project-files))
(files (and dwim (projectile-select-files project-files))))
(ivy-read (projectile-prepend-project-name "Find file: ")
(or files project-files)
:matcher #'counsel-projectile--find-file-matcher
:require-match t
:sort counsel-projectile-sort-files
:action counsel-projectile-find-file-action
:caller 'counsel-projectile-find-file))))
(ivy-configure 'counsel-projectile-find-file
:display-transformer-fn #'counsel-projectile-find-file-transformer)
;;;###autoload
(defun counsel-projectile-find-file-dwim (&optional arg)
"Jump to a file in the current project using completion based on context.
With a prefix ARG, invalidate the cache first."
(interactive "P")
(counsel-projectile-find-file arg t))
;;* counsel-projectile-find-dir
(defcustom counsel-projectile-sort-directories nil
"Non-nil if directories should be sorted in
`counsel-projectile-find-dir'.
The sorting function can be modified by adding an entry for
`counsel-projectile-find-dir' in `ivy-sort-functions-alist'."
:type 'boolean
:group 'counsel-projectile)
(counsel-projectile--defcustom-action
'counsel-projectile-find-dir
'(1
("o" counsel-projectile-find-dir-action
"current window")
("j" counsel-projectile-find-dir-action-other-window
"other window")
("x" counsel-projectile-find-dir-action-extern
"open externally")
("r" counsel-projectile-find-dir-action-root
"open as root")
("m" counsel-projectile-find-file-action-find-file-manually
"find file manually")
("p" counsel-projectile-find-dir-action-switch-project
"switch project"))
'counsel-projectile)
(defun counsel-projectile--project-directories ()
"Return a list of current project's directories."
(if projectile-find-dir-includes-top-level
(append '("./") (projectile-current-project-dirs))
(projectile-current-project-dirs)))
(defun counsel-projectile-find-dir-action (dir)
"Visit DIR with dired and run `projectile-find-dir-hook'."
(dired (projectile-expand-root dir))
(run-hooks 'projectile-find-dir-hook))
(defun counsel-projectile-find-dir-action-other-window (dir)
"Visit DIR with dired in another window and run
`projectile-find-dir-hook'."
(dired-other-window (projectile-expand-root dir))
(run-hooks 'projectile-find-dir-hook))
(defun counsel-projectile-find-dir-action-extern (dir)
"Visit DIR externally and run `projectile-find-dir-hook'."
(counsel-find-file-extern (projectile-expand-root dir))
(run-hooks 'projectile-find-dir-hook))
(defun counsel-projectile-find-dir-action-root (dir)
"Visit DIR as root and run `projectile-find-dir-hook'."
(counsel-find-file-as-root (projectile-expand-root dir))
(run-hooks 'projectile-find-dir-hook))
(defun counsel-projectile-find-dir-action-switch-project (&optional _)
"Switch project action for `counsel-projectile-find-dir'."
(counsel-projectile-switch-project 'counsel-projectile-switch-project-action-find-dir))
(defun counsel-projectile-find-dir-transformer (str)
"Transform candidates with `ivy-subdir' face."
(propertize str 'face 'ivy-subdir))
;;;###autoload
(defun counsel-projectile-find-dir (&optional arg)
"Jump to a directory in the current project.
With a prefix ARG, invalidate the cache first."
(interactive "P")
(if (and (eq projectile-require-project-root 'prompt)
(not (projectile-project-p)))
(counsel-projectile-find-dir-action-switch-project)
(projectile-maybe-invalidate-cache arg)
(ivy-read (projectile-prepend-project-name "Find dir: ")
(counsel-projectile--project-directories)
:require-match t
:sort counsel-projectile-sort-directories
:action counsel-projectile-find-dir-action
:caller 'counsel-projectile-find-dir)))
(ivy-configure 'counsel-projectile-find-dir
:display-transformer-fn #'counsel-projectile-find-dir-transformer)
;;* counsel-projectile-switch-to-buffer
(defcustom counsel-projectile-sort-buffers nil
"Non-nil if buffers should be sorted in
`counsel-projectile-switch-to-buffer' and `counsel-projectile'.
The sorting function can be modified by adding an entry for
`counsel-projectile-switch-to-buffer' in
`ivy-sort-functions-alist'."
:type 'boolean
:group 'counsel-projectile)
(defcustom counsel-projectile-remove-current-buffer nil
"Non-nil if current buffer should be removed from the
candidates list of `counsel-projectile-switch-to-buffer' and
`counsel-projectile'."
:type 'boolean
:group 'counsel-projectile)
(defcustom counsel-projectile-preview-buffers nil
"When non-nil, `counsel-projectile-switch-to-buffer' and `counsel-projectile'
display a preview of the selected buffer in the current window.
This makes these commands behave similarly to `counsel-switch-buffer'. If
`counsel-switch-buffer-preview-virtual-buffers' is also non-nil,
`counsel-projectile' also displays a preview of the selected
non-visited file."
:type 'boolean
:group 'counsel-projectile)
(counsel-projectile--defcustom-action
'counsel-projectile-switch-to-buffer
'(1
("o" counsel-projectile-switch-to-buffer-action
"current window")
("j" switch-to-buffer-other-window
"other window")
("k" ivy--kill-buffer-action
"kill")
("m" counsel-projectile-switch-to-buffer-action-find-file-manually
"find file manually")
("p" counsel-projectile-switch-to-buffer-action-switch-project
"switch project"))
'counsel-projectile)
(defvar counsel-projectile-switch-to-buffer-map
(let ((map (make-sparse-keymap)))
(define-key map (kbd "C-c C-k") (lambda ()
(interactive)
(ivy--kill-buffer-action (ivy-state-current ivy-last))))
map)
"Keymap for `counsel-projectile-switch-to-buffer'.")
(defun counsel-projectile--project-buffers (&rest _)
;; The ignored arguments are so that the function can be used as
;; collection function in `counsel-projectile-switch-to-buffer'.
"Return a list of buffers in the current project.
Like `projectile-project-buffer-names', but propertize buffer
names as in `ivy--buffer-list', and remove current buffer if
`counsel-projectile-remove-currennt-buffer' is non-nil."
(let ((buffer-names (projectile-project-buffer-names)))
(when counsel-projectile-remove-current-buffer
(setq buffer-names (delete (buffer-name (current-buffer)) buffer-names)))
(ivy--buffer-list "" nil
(lambda (x)
(member (car x) buffer-names)))))
(defun counsel-projectile-switch-to-buffer-action (buffer)
"Switch to BUFFER."
(switch-to-buffer buffer nil 'force-same-window))
(defun counsel-projectile-switch-to-buffer-action-find-file-manually (buffer)
"Call `counsel-find-file' from BUFFER's default directory."
(let* ((b (get-buffer buffer))
(default-directory
(or (and b (buffer-local-value 'default-directory b))
(projectile-project-root))))
(counsel-find-file)))
(defun counsel-projectile-switch-to-buffer-action-switch-project (&optional _)
"Switch project action for `counsel-projectile-switch-to-buffer'."
(counsel-projectile-switch-project 'counsel-projectile-switch-project-action-switch-to-buffer))
(defun counsel-projectile-switch-to-buffer-transformer (str)
"Transform candidate STR when switching project buffers.
This simply applies the same transformer as in `ivy-switch-buffer', which is `ivy-switch-buffer-transformer' by default but could have been modified e.g. by the ivy-rich package."
(funcall (ivy-alist-setting ivy--display-transformers-alist 'ivy-switch-buffer)
str))
(defun counsel-projectile--switch-to-buffer-update-fn ()
"Update function for `counsel-projectile--switch-to-buffer'."
;; Adapted from counsel--switch-buffer-update-fn.
(unless counsel--switch-buffer-previous-buffers
(setq counsel--switch-buffer-previous-buffers (buffer-list)))
(when counsel-projectile-preview-buffers
(when (member (ivy-state-current ivy-last) ivy-marked-candidates)
(setf (ivy-state-current ivy-last)
(substring (ivy-state-current ivy-last) (length ivy-mark-prefix))))
;; Unlike in `counsel-switch-buffer' we could have an empty string
;; as candidate if no project buffer is open.
(cond
((and (not (string= (ivy-state-current ivy-last) ""))
(get-buffer (ivy-state-current ivy-last)))
(let ((ivy-marked-candidates nil))
(ivy-call)))
;; Following case if for use in `counsel-projectile'.
((and (not (string= (ivy-state-current ivy-last) ""))
counsel-switch-buffer-preview-virtual-buffers
(file-exists-p (projectile-expand-root (ivy-state-current ivy-last))))
(let ((buf (ignore-errors
;; may not open due to `large-file-warning-threshold' etc.
(find-file-noselect (projectile-expand-root (ivy-state-current ivy-last))))))
(if buf
(progn
(push buf counsel--switch-buffer-temporary-buffers)
(ivy-call))
;; clean up the minibuffer so that there's no delay before
;; the Ivy candidates are displayed once again
(message ""))))
(t
(with-ivy-window
(switch-to-buffer (or (plist-get (ivy-state-extra-props ivy-last) :from-buffer)
(ivy-state-buffer ivy-last))))))))
;;;###autoload
(defun counsel-projectile-switch-to-buffer (&optional from-buffer)
"Jump to a buffer in the current project.
If `counsel-projectile-preview-buffers' is non-nil, display a
preview of the selected ivy completion candidate buffer as in
`counsel-switch-buffer', falling back to the current buffer or
optionally FROM-BUFFER."
(interactive)
(if (and (eq projectile-require-project-root 'prompt)
(not (projectile-project-p)))
(counsel-projectile-switch-to-buffer-action-switch-project)
(ivy-read (projectile-prepend-project-name "Switch to buffer: ")
;; We use a collection function so that it is called each
;; time the `ivy-state' is reset. This is needed for the
;; "kill buffer" action.
#'counsel-projectile--project-buffers
:matcher #'ivy--switch-buffer-matcher
:require-match t
:sort counsel-projectile-sort-buffers
:action counsel-projectile-switch-to-buffer-action
:keymap counsel-projectile-switch-to-buffer-map
:extra-props (list :from-buffer from-buffer)
:caller 'counsel-projectile-switch-to-buffer)))
(ivy-configure 'counsel-projectile-switch-to-buffer
:display-transformer-fn #'counsel-projectile-switch-to-buffer-transformer
:update-fn #'counsel-projectile--switch-to-buffer-update-fn
:unwind-fn #'counsel--switch-buffer-unwind)
;;* counsel-projectile-grep
(defcustom counsel-projectile-grep-initial-input nil
"Initial minibuffer input for `counsel-projectile-grep'. If
non-nil, it should be a Lisp expression whose evaluation yields
the initial input string.
Note that you can always insert the value
of `(ivy-thing-at-point)' by hitting \"M-n\" in the minibuffer."
:type '(choice
(const :tag "None" nil)
(const :tag "Symbol at point (generic)" (thing-at-point 'symbol t))
(const :tag "Symbol or selection at point (projectile)" (projectile-symbol-or-selection-at-point))
(const :tag "Thing at point (ivy)" (ivy-thing-at-point))
(sexp :tag "Custom expression"))
:group 'counsel-projectile)
(counsel-projectile--defcustom-action
'counsel-projectile-grep
'(1
("o" counsel-git-grep-action
"default")
("p" counsel-projectile-grep-action-switch-project
"switch project"))
'counsel-projectile)
(defcustom counsel-projectile-git-grep-extra-actions
'(("p" counsel-projectile-git-grep-action-switch-project
"switch project"))
"List of extra actions to add to
`counsel-projectile-git-grep' (in addition to the actions of
`counsel-git-grep')."
:type '(repeat :tag "Actions"
(list :tag "Action"
(string :tag " key")
(function :tag "function")
(string :tag " name")))
:group 'counsel-projectile)
(defvar counsel-projectile-grep-base-command "grep -rnEI %s"
"Format string to use in `cousel-projectile-grep' to
construct the command.")
(defun counsel-projectile-grep-action-switch-project (&optional _)
"Switch project action for `counsel-projectile-grep'."
(counsel-projectile-switch-project 'counsel-projectile-switch-project-action-grep))
(defun counsel-projectile-git-grep-action-switch-project (&optional _)
"Switch project action for `counsel-projectile-git-grep'."
(counsel-projectile-switch-project 'counsel-projectile-switch-project-action-git-grep))
;;;###autoload
(defun counsel-projectile-grep (&optional options-or-cmd)
"Search the current project with grep.
If inside a git project and `projectile-use-git-grep' is non-nil,
use git grep. Otherwise use grep recursively.
OPTIONS-OR-CMD, if non-nil, is a string containing either
additional options to be passed to grep, or an alternative git
grep command. It is read from the minibuffer if the function is
called with a `\\[universal-argument]' prefix argument."
(interactive)
(if (and (eq projectile-require-project-root 'prompt)
(not (projectile-project-p)))
(counsel-projectile-grep-action-switch-project)
(if (and (eq (projectile-project-vcs) 'git)
projectile-use-git-grep)
(counsel-projectile-git-grep options-or-cmd)
(let* ((ignored-files
(mapconcat (lambda (i)
(concat "--exclude=" (shell-quote-argument i)))
(append
(projectile--globally-ignored-file-suffixes-glob)
(projectile-ignored-files-rel))
" "))
(ignored-dirs
(mapconcat (lambda (i)
(concat "--exclude-dir=" (shell-quote-argument i)))
(projectile-ignored-directories-rel)
" "))
(ignored (concat ignored-files " " ignored-dirs))
(counsel-ag-base-command
(let ((counsel-ag-command counsel-projectile-grep-base-command))
(counsel--format-ag-command ignored "%s"))))
;; `counsel-ag' requires a single `\\[universal-argument]'
;; prefix argument to prompt for initial directory and a double
;; `\\[universal-argument]' prefix argument to prompt for extra
;; options. But since the initial directory is always the
;; project root here, prompt for ortpions with a single
;; `\\[universal-argument]' prefix argument prefix argument as
;; well.
(when (= (prefix-numeric-value current-prefix-arg) 4)
(setq current-prefix-arg '(16)))
(counsel-ag (eval counsel-projectile-grep-initial-input)
(projectile-project-root)
options-or-cmd
(projectile-prepend-project-name
(concat (car (if (listp counsel-ag-base-command)
counsel-ag-base-command
(split-string counsel-ag-base-command)))
": "))
:caller 'counsel-projectile-grep)))))
(ivy-configure 'counsel-projectile-grep
: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 counsel-projectile-git-grep (&optional cmd)
"Search the current project with git grep.
CMD, if non-nil, is a string containing an alternative git grep
command. It is read from the minibuffer if the function is called
with a `\\[universal-argument]' prefix argument."
(interactive)
(if (and (eq projectile-require-project-root 'prompt)
(not (projectile-project-p)))
(counsel-projectile-git-grep-action-switch-project)
(let ((ivy--actions-list (copy-sequence ivy--actions-list)))
(ivy-add-actions
'counsel-git-grep
counsel-projectile-git-grep-extra-actions)
(counsel-git-grep (eval counsel-projectile-grep-initial-input)
(projectile-project-root)
(or current-prefix-arg cmd)))))
;;* counsel-projectile-ag
(defcustom counsel-projectile-ag-initial-input nil
"Initial minibuffer input for `counsel-projectile-ag'. If
non-nil, it should be a Lisp expression whose evaluation yields
the initial input string.
Note that you can always insert the value
of `(ivy-thing-at-point)' by hitting \"M-n\" in the minibuffer."
:type '(choice
(const :tag "None" nil)
(const :tag "Symbol at point (generic)" (thing-at-point 'symbol t))
(const :tag "Symbol or selection at point (projectile)" (projectile-symbol-or-selection-at-point))
(const :tag "Thing at point (ivy)" (ivy-thing-at-point))
(sexp :tag "Custom expression"))
:group 'counsel-projectile)
(defcustom counsel-projectile-ag-extra-actions
'(("p" counsel-projectile-ag-action-switch-project
"switch project"))
"List of extra actions to add to
`counsel-projectile-ag' (in addition to the actions of
`counsel-ag')."
:type '(repeat :tag "Actions"
(list :tag "Action"
(string :tag " key")
(function :tag "function")
(string :tag " name")))
:group 'counsel-projectile)
(defun counsel-projectile-ag-action-switch-project (&optional _)
"Switch project action for `counsel-projectile-ag'."
(counsel-projectile-switch-project 'counsel-projectile-switch-project-action-ag))
;;;###autoload
(defun counsel-projectile-ag (&optional options)
"Search the current project with ag.
OPTIONS, if non-nil, is a string containing additional options to
be passed to ag. It is read from the minibuffer if the function
is called with a `\\[universal-argument]' prefix argument."
(interactive)
(if (and (eq projectile-require-project-root 'prompt)
(not (projectile-project-p)))
(counsel-projectile-ag-action-switch-project)
(let* ((ivy--actions-list (copy-sequence ivy--actions-list))
(ignored
(mapconcat (lambda (i)
(concat "--ignore " (shell-quote-argument i)))
(append
(projectile--globally-ignored-file-suffixes-glob)
(projectile-ignored-files-rel)
(projectile-ignored-directories-rel))
" "))
(counsel-ag-base-command
(let ((counsel-ag-command counsel-ag-base-command))
(counsel--format-ag-command ignored "%s"))))
(ivy-add-actions
'counsel-ag
counsel-projectile-ag-extra-actions)
;; `counsel-ag' requires a single `\\[universal-argument]'
;; prefix argument to prompt for initial directory and a double
;; `\\[universal-argument]' prefix argument to prompt for extra
;; options. But since the initial directory is always the
;; project root here, prompt for ortpions with a single
;; `\\[universal-argument]' prefix argument prefix argument as
;; well.
(when (= (prefix-numeric-value current-prefix-arg) 4)
(setq current-prefix-arg '(16)))
(counsel-ag (eval counsel-projectile-ag-initial-input)
(projectile-project-root)
options
(projectile-prepend-project-name
(concat (car (if (listp counsel-ag-base-command)
counsel-ag-base-command
(split-string counsel-ag-base-command)))
": "))))))
;;* counsel-projectile-rg
(defcustom counsel-projectile-rg-initial-input nil
"Initial minibuffer input for `counsel-projectile-rg'. If
non-nil, it should be a Lisp expression whose evaluation yields
the initial input string.
Note that you can always insert the value
of `(ivy-thing-at-point)' by hitting \"M-n\" in the minibuffer."
:type '(choice
(const :tag "None" nil)
(const :tag "Symbol at point (generic)" (thing-at-point 'symbol t))
(const :tag "Symbol or selection at point (projectile)" (projectile-symbol-or-selection-at-point))
(const :tag "Thing at point (ivy)" (ivy-thing-at-point))
(sexp :tag "Custom expression"))
:group 'counsel-projectile)
(defcustom counsel-projectile-rg-extra-actions
'(("p" counsel-projectile-rg-action-switch-project
"switch project"))
"List of extra actions to add to
`counsel-projectile-rg' (in addition to the actions of
`counsel-rg')."
:type '(repeat :tag "Actions"
(list :tag "Action"
(string :tag " key")
(function :tag "function")
(string :tag " name")))
:group 'counsel-projectile)
(defun counsel-projectile-rg-action-switch-project (&optional _)
"Switch project action for `counsel-projectile-rg'."
(counsel-projectile-switch-project 'counsel-projectile-switch-project-action-rg))
;;;###autoload
(defun counsel-projectile-rg (&optional options)
"Search the current project with rg.
OPTIONS, if non-nil, is a string containing additional options to
be passed to rg. It is read from the minibuffer if the function
is called with a `\\[universal-argument]' prefix argument."
(interactive)
(if (and (eq projectile-require-project-root 'prompt)
(not (projectile-project-p)))
(counsel-projectile-rg-action-switch-project)
(let* ((ivy--actions-list (copy-sequence ivy--actions-list))
(ignored
(mapconcat (lambda (i)
(concat "--glob !" (shell-quote-argument i)))
(append
(projectile--globally-ignored-file-suffixes-glob)
(projectile-ignored-files-rel)
(projectile-ignored-directories-rel))
" "))
(counsel-rg-base-command
(let ((counsel-ag-command counsel-rg-base-command))
(counsel--format-ag-command ignored "%s"))))
(ivy-add-actions
'counsel-rg
counsel-projectile-rg-extra-actions)
;; `counsel-rg' requires a single `\\[universal-argument]'
;; prefix argument to prompt for initial directory and a double
;; `\\[universal-argument]' prefix argument to prompt for extra
;; options. But since the initial directory is always the
;; project root here, prompt for ortpions with a single
;; `\\[universal-argument]' prefix argument prefix argument as
;; well.
(when (= (prefix-numeric-value current-prefix-arg) 4)
(setq current-prefix-arg '(16)))
(counsel-rg (eval counsel-projectile-rg-initial-input)
(projectile-project-root)
options
(projectile-prepend-project-name
(concat (car (if (listp counsel-rg-base-command)
counsel-rg-base-command
(split-string counsel-rg-base-command)))
": "))))))
;;* counsel-projectile-org-capture
(defvar org-capture-templates)
(defvar org-capture-templates-contexts)
(defcustom counsel-projectile-org-capture-templates
'(("t" "[${name}] Task" entry (file+headline "${root}/notes.org" "Tasks")
"* TODO %?\n %u\n %a"))
"Project-specific templates for the creation of new entries
with `counsel-projectile-org-capture'.
The format is the same as in `org-capture-templates', except that
in a template's name or target, the placeholders \"${root}\" and
\"${name}\" can be used to stand for the current project root and
name, respectively.
The default value contains a single template, whose name is
\"[${name}] Task\" and whose target is:
\(file+headline \"${root}/notes.org}\" \"Tasks\"\)
This points to headline \"Tasks\" in file \"notes.org\" in the
project root directory (one file per project).
Two other examples of valid targets are:
\(file+headline \"${root}/${name}.org}\" \"Tasks\"\)
\(file+olp \"~/notes.org\" \"${root}\" \"Tasks\"\)
The first one is similar to the default value's target, except
that the file is named after the project name (this can be handy
if you use org-mode's agenda since the project name is then
displayed as category). The second one points to outline path
\"<project-root>/Tasks\" in file \"~/notes.org\" (same file for
all projects)."
:type ;; copied from `org-capture-templates'
(let ((file-variants '(choice :tag "Filename "
(file :tag "Literal")
(function :tag "Function")
(variable :tag "Variable")
(sexp :tag "Form"))))
`(repeat
(choice :value ("" "" entry (file "~/org/notes.org") "")
(list :tag "Multikey description"
(string :tag "Keys ")
(string :tag "Description"))
(list :tag "Template entry"
(string :tag "Keys ")
(string :tag "Description ")
(choice :tag "Capture Type " :value entry