counsel-projectile/counsel-projectile.el
2017-12-18 21:32:53 +01:00

1097 lines
45 KiB
EmacsLisp
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

;;; counsel-projectile.el --- Ivy integration for Projectile
;; Copyright (C) 2016-2017 Eric Danan
;; Author: Eric Danan
;; URL: https://github.com/ericdanan/counsel-projectile
;; Keywords: project, convenience
;; Version: 0.2
;; Package-Requires: ((counsel "0.10.0") (projectile "0.14.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)
;;;; utility
(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 (one-character 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--defcustom-sub-action (action sub-action group)
"Create a custom variable named \"ACTION-sub-action\" in GROUP,
with default value SUB-ACTION, to be passed by ACTION to
`counsel-projectile-sub-action'.
This variable holds a list of sub-actions for ACTION (a key, a
function, and a name for each action)."
(eval
`(defcustom ,(intern (format "%s-sub-action" action))
',sub-action
,(format "Sub-action(s) for `%s'.
This variable holds a list of sub-actions, each or which consists
of:
- a key (one-character string) to call the action,
- an action function of one variable,
- a name (string) for the action.
When `%s' is called, a key is read from the minibuffer and the
corresponding sub-action is executed." action action)
:type '(repeat :tag "Sub-actions"
(list :tag "Sub-action"
(string :tag " key")
(function :tag "function")
(string :tag " name")))
:group ',group)))
(defun counsel-projectile-sub-action (cand sub-actions)
"Read a key from the minibuffer and apply the corresponding
action from SUB-ACTIONS to CAND.
SUB-ACTIONS is list of ivy actions: a key, an action function,
and a name for each action. Binding a key to a call to this
function in an ivy action list makes this key behave like a
prefix key and the keys in SUB-ACTIONS like sub-keys."
;; adapted from `ivy-read-action'
(let* ((hint (funcall ivy-read-action-format-function sub-actions))
(resize-mini-windows t)
(key (string (read-key hint)))
(action-fun (nth 1 (assoc key sub-actions))))
(cond ((member key '("" ""))
(when (eq ivy-exit 'done)
(ivy-resume)))
((null action-fun)
(message "%s is not bound" key)
(when (eq ivy-exit 'done)
(ivy-resume)))
(t
(message "")
(funcall action-fun cand)))))
;;;; counsel-projectile-find-file
(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")
("p" (lambda (_) (counsel-projectile-switch-project))
"switch project"))
'counsel-projectile)
(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-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)
"Jump to a file in the current project.
With a prefix ARG, invalidate the cache first."
(interactive "P")
(projectile-maybe-invalidate-cache arg)
(ivy-read (projectile-prepend-project-name "Find file: ")
(projectile-current-project-files)
:matcher #'counsel--find-file-matcher
:require-match t
:action counsel-projectile-find-file-action
:caller 'counsel-projectile-find-file))
(ivy-set-display-transformer
'counsel-projectile-find-file
'counsel-projectile-find-file-transformer)
;;;; counsel-projectile-find-dir
(counsel-projectile--defcustom-action
'counsel-projectile-find-dir
'(1
("o" counsel-projectile-find-dir-action-other-window
"current window")
("j" counsel-projectile-find-dir-action-other-window
"other window")
("m" counsel-projectile-find-file-action-find-file-manually
"find file manually")
("p" (lambda (_) (counsel-projectile-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))
;;;###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")
(projectile-maybe-invalidate-cache arg)
(ivy-read (projectile-prepend-project-name "Find dir: ")
(counsel-projectile--project-directories)
:require-match t
:action counsel-projectile-find-dir-action
:caller 'counsel-projectile-find-dir))
;;;; counsel-projectile-switch-to-buffer
(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)
(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")
("m" counsel-projectile-switch-to-buffer-action-find-file-manually
"find file manually")
("p" (lambda (_) (counsel-projectile-switch-project))
"switch project"))
'counsel-projectile)
(defun counsel-projectile--project-buffers ()
"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)))
;;;###autoload
(defun counsel-projectile-switch-to-buffer ()
"Jump to a buffer in the current project."
(interactive)
(ivy-read (projectile-prepend-project-name "Switch to buffer: ")
(counsel-projectile--project-buffers)
:matcher #'ivy--switch-buffer-matcher
:require-match t
:action counsel-projectile-switch-to-buffer-action
:caller 'counsel-projectile-switch-to-buffer))
(ivy-set-display-transformer
'counsel-projectile-switch-to-buffer
'ivy-switch-buffer-transformer)
;;;; 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)
(defvar counsel-projectile-grep-base-command "grep -rnE %s -- %%s ."
"Format string to use in `cousel-projectile-grep-function' to
construct the command.")
(defvar counsel-projectile-grep-command nil)
(defvar counsel-projectile-grep-options-history nil
"History for `counsel-projectile-grep' options.")
(defun counsel-projectile-grep-function (string)
"Grep for STRING in the current project."
(if (< (length string) 3)
(counsel-more-chars 3)
(let ((default-directory counsel--git-dir)
(regex (counsel-unquote-regex-parens
(setq ivy--old-re
(ivy--regex string)))))
(counsel--async-command (format counsel-projectile-grep-command
(shell-quote-argument regex)))
nil)))
(defun counsel-projectile-grep-transformer (str)
"Higlight file and line number in STR, first removing the
\"./\" prefix from the filename."
;; This makes the display consistent with `counsel-git-grep' and
;; `counsel-ag'-like commands.
(counsel-git-grep-transformer (string-remove-prefix "./" str)))
(defun counsel-projectile-grep-occur ()
"Generate a custom occur buffer for `counsel-projectile-grep'."
;; Copied from `counsel-grep-like-occur', except that we don't
;; prepend "./" to the candidates since grep already does so.
(unless (eq major-mode 'ivy-occur-grep-mode)
(ivy-occur-grep-mode)
(setq default-directory counsel--git-dir))
(setq ivy-text
(and (string-match "\"\\(.*\\)\"" (buffer-name))
(match-string 1 (buffer-name))))
(let* ((cmd (format counsel-projectile-grep-command
(shell-quote-argument
(counsel-unquote-regex-parens
(ivy--regex ivy-text)))))
(cands (split-string (shell-command-to-string cmd) "\n" t)))
;; Need precise number of header lines for `wgrep' to work.
(insert (format "-*- mode:grep; default-directory: %S -*-\n\n\n"
default-directory))
(insert (format "%d candidates:\n" (length cands)))
(ivy--occur-insert-lines cands)))
(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 `counsel-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 prefix argument."
(interactive)
(if (and (eq (projectile-project-vcs) 'git)
projectile-use-git-grep)
(let ((counsel-prompt-function
(lambda ()
(ivy-add-prompt-count
(format "%s: " (projectile-prepend-project-name (ivy-state-prompt ivy-last)))))))
(counsel-git-grep (or current-prefix-arg options-or-cmd)
counsel-projectile-grep-initial-input))
(counsel-require-program (car (split-string counsel-projectile-grep-base-command)))
(let* ((ignored-files (mapconcat (lambda (i)
(concat "--exclude="
(shell-quote-argument i)
" "))
(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))
(options
(if current-prefix-arg
(read-string (projectile-prepend-project-name "grep options: ")
ignored
'counsel-projectile-grep-options-history)
(concat ignored options-or-cmd))))
(setq counsel-projectile-grep-command
(format counsel-projectile-grep-base-command options))
(ivy-set-prompt 'counsel-projectile-grep counsel-prompt-function)
(setq counsel--git-dir (projectile-project-root))
(ivy-read (projectile-prepend-project-name "grep")
#'counsel-projectile-grep-function
:initial-input counsel-projectile-grep-initial-input
:dynamic-collection t
:keymap counsel-ag-map
:history 'counsel-git-grep-history
:action #'counsel-git-grep-action
:unwind (lambda ()
(counsel-delete-process)
(swiper--cleanup))
:caller 'counsel-projectile-grep))))
(counsel-set-async-exit-code 'counsel-projectile-grep 1 "No matches found")
(ivy-set-occur 'counsel-projectile-grep 'counsel-projectile-grep-occur)
(ivy-set-display-transformer 'counsel-projectile-grep 'counsel-projectile-grep-transformer)
;;;; 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)
(defvar counsel-projectile-ag-options-history nil
"History for `counsel-projectile-ag' options.")
;;;###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 prefix argument."
(interactive)
(let* ((ignored (mapconcat (lambda (i)
(concat "--ignore "
(shell-quote-argument i)
" "))
(append (projectile-ignored-files-rel)
(projectile-ignored-directories-rel))
""))
(options
(if current-prefix-arg
(read-string (projectile-prepend-project-name "ag options: ")
ignored
'counsel-projectile-ag-options-history)
(concat ignored options))))
(counsel-ag (eval counsel-projectile-ag-initial-input)
(projectile-project-root)
options
(projectile-prepend-project-name "ag"))))
;;;; 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)
(defvar counsel-projectile-rg-options-history nil
"History for `counsel-projectile-rg' options.")
;;;###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 prefix argument."
(interactive)
(let* ((ignored (mapconcat (lambda (i)
(concat "--glob "
(shell-quote-argument (concat "!" i))
" "))
(append (projectile-ignored-files-rel)
(projectile-ignored-directories-rel))
""))
(options
(if current-prefix-arg
(read-string (projectile-prepend-project-name "rg options: ")
ignored
'counsel-projectile-rg-options-history)
(concat ignored options))))
(counsel-rg (eval counsel-projectile-rg-initial-input)
(projectile-project-root)
options
(projectile-prepend-project-name "rg"))))
;;;; counsel-projectile-org-capture
(defcustom counsel-projectile-org-capture-templates
'(("t" "Task" entry (file+headline "${root}/notes.org" "Tasks")
"* TODO %?\n %u\n %a"))
"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 all strings of in an entry's target slot, all instances of
\"${root}\" and \"${name}\" are replaced with the current project
root and name, respectively.
The default value contains a single template, 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).
Another example of a valid target is:
\(file+olp \"~/notes.org\" \"${root}\" \"Tasks\"\)
This 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
(const :tag "Org entry" entry)
(const :tag "Plain list item" item)
(const :tag "Checkbox item" checkitem)
(const :tag "Plain text" plain)
(const :tag "Table line" table-line))
(choice :tag "Target location"
(list :tag "File"
(const :format "" file)
,file-variants)
(list :tag "ID"
(const :format "" id)
(string :tag " ID"))
(list :tag "File & Headline"
(const :format "" file+headline)
,file-variants
(string :tag " Headline"))
(list :tag "File & Outline path"
(const :format "" file+olp)
,file-variants
(repeat :tag "Outline path" :inline t
(string :tag "Headline")))
(list :tag "File & Regexp"
(const :format "" file+regexp)
,file-variants
(regexp :tag " Regexp"))
(list :tag "File [ & Outline path ] & Date tree"
(const :format "" file+olp+datetree)
,file-variants
(option (repeat :tag "Outline path" :inline t
(string :tag "Headline"))))
(list :tag "File & function"
(const :format "" file+function)
,file-variants
(sexp :tag " Function"))
(list :tag "Current clocking task"
(const :format "" clock))
(list :tag "Function"
(const :format "" function)
(sexp :tag " Function")))
(choice :tag "Template "
(string)
(list :tag "File"
(const :format "" file)
(file :tag "Template file"))
(list :tag "Function"
(const :format "" function)
(function :tag "Template function")))
(plist :inline t
;; Give the most common options as checkboxes
:options (((const :format "%v " :prepend) (const t))
((const :format "%v " :immediate-finish) (const t))
((const :format "%v " :jump-to-captured) (const t))
((const :format "%v " :empty-lines) (const 1))
((const :format "%v " :empty-lines-before) (const 1))
((const :format "%v " :empty-lines-after) (const 1))
((const :format "%v " :clock-in) (const t))
((const :format "%v " :clock-keep) (const t))
((const :format "%v " :clock-resume) (const t))
((const :format "%v " :time-prompt) (const t))
((const :format "%v " :tree-type) (const week))
((const :format "%v " :unnarrowed) (const t))
((const :format "%v " :table-line-pos) (string))
((const :format "%v " :kill-buffer) (const t))))))))
:group 'counsel-projectile)
(defcustom counsel-projectile-org-capture-templates-contexts nil
"Alist of capture templates and valid contexts for `counsel-projectile-org-capture'.
The format is the same as in `org-capture-templates-contexts'."
:type ;; copied from `org-capture-target-templates'
'(repeat (list :tag "Rule"
(string :tag " Capture key")
(string :tag "Replace by template")
(repeat :tag "Available when"
(choice
(cons :tag "Condition"
(choice
(const :tag "In file" in-file)
(const :tag "Not in file" not-in-file)
(const :tag "In buffer" in-buffer)
(const :tag "Not in buffer" not-in-buffer)
(const :tag "In mode" in-mode)
(const :tag "Not in mode" not-in-mode))
(regexp))
(function :tag "Custom function")))))
:group 'counsel-projectile)
;;;###autoload
(defun counsel-projectile-org-capture ()
"Org-capture into the current project.
The capture templates are read from the variables
`counsel-projectile-org-capture-templates' and
`counsel-projectile-org-capture-templates-contexts'."
(interactive)
(require 'org-capture)
(let* ((root (projectile-project-root))
(name (projectile-project-name))
(org-capture-templates
(cl-loop
for template in counsel-projectile-org-capture-templates
collect (cl-loop
for item in template
if (= (cl-position item template) 3) ;; template's target
collect (cl-loop
for x in item
if (stringp x)
collect (replace-regexp-in-string
"\\${[^}]+}"
(lambda (s)
(pcase s
("${root}" root)
("${name}" name)))
x)
else
collect x)
else
collect item)))
(org-capture-templates-contexts counsel-projectile-org-capture-templates-contexts)
(ivy--prompts-list ivy--prompts-list))
(ivy-set-prompt 'counsel-org-capture
(lambda ()
(ivy-add-prompt-count
(projectile-prepend-project-name (ivy-state-prompt ivy-last)))))
(counsel-org-capture)))
;;;; counsel-projectile-switch-project
(defcustom counsel-projectile-remove-current-project nil
"Non-nil if current project should be removed from the
candidates list of `counsel-projectile-switch-project'."
:type 'boolean
:group 'counsel-projectile)
(counsel-projectile--defcustom-action
'counsel-projectile-switch-project
'(1
("o" counsel-projectile-switch-project-action
"jump to a project buffer or file")
("f" counsel-projectile-switch-project-action-find-file
"jump to a project file")
("d" counsel-projectile-switch-project-action-find-dir
"jump to a project directory")
("b" counsel-projectile-switch-project-action-switch-to-buffer
"jump to a project buffer")
("m" counsel-projectile-switch-project-action-find-file-manually
"find file manually from project root")
("S" counsel-projectile-switch-project-action-save-all-buffers
"save all project buffers")
("k" counsel-projectile-switch-project-action-kill-buffers
"kill all project buffers")
("K" counsel-projectile-switch-project-action-remove-known-project
"remove project from known projects")
("c" counsel-projectile-switch-project-action-compile
"run project compilation command")
("C" counsel-projectile-switch-project-action-configure
"run project configure command")
("E" counsel-projectile-switch-project-action-edit-dir-locals
"edit project dir-locals")
("v" counsel-projectile-switch-project-action-vc
"open project in vc-dir / magit / monky")
("s" counsel-projectile-switch-project-action-prefix-search
"search project with ag / rg / grep...")
("x" counsel-projectile-switch-project-action-prefix-shell
"invoke shell / eshell / term from project root...")
("O" counsel-projectile-switch-project-action-org-capture
"org-capture into project"))
'counsel-projectile)
(counsel-projectile--defcustom-sub-action
'counsel-projectile-switch-project-action-prefix-search
'(("g" counsel-projectile-switch-project-action-grep
"Search project with grep")
("s" counsel-projectile-switch-project-action-ag
"Search project with ag")
("r" counsel-projectile-switch-project-action-rg
"Search project with rg"))
'counsel-projectile)
(counsel-projectile--defcustom-sub-action
'counsel-projectile-switch-project-action-prefix-shell
'(("s" counsel-projectile-switch-project-action-run-shell
"Invoke shell from project root")
("e" counsel-projectile-switch-project-action-run-eshell
"Invoke eshell from project root")
("t" counsel-projectile-switch-project-action-run-term
"Invoke term from project root"))
'counsel-projectile)
(defun counsel-projectile-switch-project-by-name (project)
"Switch to PROJECT.
Invokes the command referenced by
`projectile-switch-project-action' on switch.
This is a replacement for `projectile-switch-project-by-name'
with a different switching mechanism: the switch-project action
is called from a dedicated buffer rather than the initial buffer.
Also, PROJECT's dir-local variables are loaded before calling the
action."
(run-hooks 'projectile-before-switch-project-hook)
;; Kill and recreate the switch buffer to get rid of any local
;; variable
(ignore-errors (kill-buffer " *counsel-projectile*"))
(set-buffer (get-buffer-create " *counsel-projectile*"))
(setq default-directory project)
;; Load the project dir-local variables into the switch buffer, so
;; the action can make use of them
(hack-dir-local-variables-non-file-buffer)
(funcall projectile-switch-project-action)
;; If the action relies on `ivy-read' then, after one of its
;; `ivy-read' actions is executed, the current buffer will be set
;; back to the initial buffer. Hence we make sure tu evaluate
;; `projectile-after-switch-project-hook' from the switch buffer.
(with-current-buffer " *counsel-projectile*"
(run-hooks 'projectile-after-switch-project-hook)))
(defun counsel-projectile-switch-project-action (project)
"Jump to a file or buffer in PROJECT."
(let ((projectile-switch-project-action
(lambda ()
(counsel-projectile ivy-current-prefix-arg))))
(counsel-projectile-switch-project-by-name project)))
(defun counsel-projectile-switch-project-action-find-file (project)
"Jump to a file in PROJECT."
(let ((projectile-switch-project-action
(lambda ()
(counsel-projectile-find-file ivy-current-prefix-arg))))
(counsel-projectile-switch-project-by-name project)))
(defun counsel-projectile-switch-project-action-find-file-manually (project)
"Call `find-file' from PROJECT's root."
(let ((projectile-switch-project-action
(lambda ()
(counsel-find-file project))))
(counsel-projectile-switch-project-by-name project)))
(defun counsel-projectile-switch-project-action-find-dir (project)
"Jump to a directory in PROJECT."
(let ((projectile-switch-project-action
(lambda ()
(counsel-projectile-find-dir ivy-current-prefix-arg))))
(counsel-projectile-switch-project-by-name project)))
(defun counsel-projectile-switch-project-action-switch-to-buffer (project)
"Jump to a buffer in PROJECT."
(let ((projectile-switch-project-action 'counsel-projectile-switch-to-buffer))
(counsel-projectile-switch-project-by-name project)))
(defun counsel-projectile-switch-project-action-save-all-buffers (project)
"Save all buffers in PROJECT."
(let ((projectile-switch-project-action 'projectile-save-project-buffers))
(counsel-projectile-switch-project-by-name project)))
(defun counsel-projectile-switch-project-action-kill-buffers (project)
"Kill all buffers in PROJECT."
(let ((projectile-switch-project-action 'projectile-kill-buffers))
(counsel-projectile-switch-project-by-name project)))
(defun counsel-projectile-switch-project-action-remove-known-project (project)
"Remove PROJECT from the list of known projects."
(projectile-remove-known-project project)
(setq ivy--all-candidates
(delete project ivy--all-candidates))
(ivy--reset-state ivy-last))
(defun counsel-projectile-switch-project-action-compile (project)
"Run PROJECT compliation command."
(let ((projectile-switch-project-action
(lambda ()
(projectile-compile-project ivy-current-prefix-arg))))
(counsel-projectile-switch-project-by-name project)))
(defun counsel-projectile-switch-project-action-configure (project)
"Run PROJECT configure command."
(let ((projectile-switch-project-action
(lambda ()
(projectile-configure-project ivy-current-prefix-arg))))
(counsel-projectile-switch-project-by-name project)))
(defun counsel-projectile-switch-project-action-edit-dir-locals (project)
"Edit PROJECT's dir-locals."
(let ((projectile-switch-project-action 'projectile-edit-dir-locals))
(counsel-projectile-switch-project-by-name project)))
(defun counsel-projectile-switch-project-action-vc (project)
"Open PROJECT in vc-dir / magit / monky."
(let ((projectile-switch-project-action 'projectile-vc))
(counsel-projectile-switch-project-by-name project)))
(defun counsel-projectile-switch-project-action-run-shell (project)
"Invoke `shell' from PROJECT's root."
(let ((projectile-switch-project-action 'projectile-run-shell))
(counsel-projectile-switch-project-by-name project)))
(defun counsel-projectile-switch-project-action-run-eshell (project)
"Invoke `eshell' from PROJECT's root."
(let ((projectile-switch-project-action 'projectile-run-eshell))
(counsel-projectile-switch-project-by-name project)))
(defun counsel-projectile-switch-project-action-run-term (project)
"Invoke `term' from PROJECT's root."
(let ((projectile-switch-project-action
(lambda ()
(projectile-run-term nil))))
(counsel-projectile-switch-project-by-name project)))
(defun counsel-projectile-switch-project-action-prefix-shell (project)
"Select a sub-action from
`counsel-projectile-switch-project-action-prefix-shell-sub-action'
and apply it to PROJECT."
(counsel-projectile-sub-action
project
counsel-projectile-switch-project-action-prefix-shell-sub-action))
(defun counsel-projectile-switch-project-action-grep (project)
"Search PROJECT with `grep'."
(let ((projectile-switch-project-action 'counsel-projectile-ag))
(counsel-projectile-switch-project-by-name project)))
(defun counsel-projectile-switch-project-action-ag (project)
"Search PROJECT with `ag'."
(let ((projectile-switch-project-action 'counsel-projectile-ag))
(counsel-projectile-switch-project-by-name project)))
(defun counsel-projectile-switch-project-action-rg (project)
"Search PROJECT with `rg'."
(let ((projectile-switch-project-action 'counsel-projectile-rg))
(counsel-projectile-switch-project-by-name project)))
(defun counsel-projectile-switch-project-action-prefix-search (project)
"Select a sub-action from
`counsel-projectile-switch-project-action-prefix-search-sub-action'
and apply it to PROJECT."
(counsel-projectile-sub-action
project
counsel-projectile-switch-project-action-prefix-search-sub-action))
(defun counsel-projectile-switch-project-action-org-capture (project)
"Org-capture into PROJECT."
(let ((projectile-switch-project-action 'counsel-projectile-org-capture))
(counsel-projectile-switch-project-by-name project)))
;;;###autoload
(defun counsel-projectile-switch-project ()
"Switch project."
(interactive)
(ivy-read (projectile-prepend-project-name "Switch to project: ")
(if counsel-projectile-remove-current-project
(projectile-relevant-known-projects)
projectile-known-projects)
:preselect (and (projectile-project-p)
(abbreviate-file-name (projectile-project-root)))
:action counsel-projectile-switch-project-action
:require-match t
:caller 'counsel-projectile-switch-project))
;;;; counsel-projectile
(counsel-projectile--defcustom-action
'counsel-projectile
'(1
("o" counsel-projectile-action
"current window")
("j" counsel-projectile-action-other-window
"other window")
("x" counsel-projectile-action-file-extern
"open file externally")
("r" counsel-projectile-action-file-root
"open file as root")
("m" counsel-projectile-action-find-file-manually
"find file manually")
("p" (lambda (_) (counsel-projectile-switch-project))
"switch project"))
'counsel-projectile)
(defvar counsel-projectile--buffers nil
"Stores a list of project buffers.")
(defvar counsel-projectile--non-visited-files nil
"Stores a list of project files that are not currently
visited by a buffer.")
(defun counsel-projectile--project-buffers-and-files ()
"Return a list of buffers and files in the current project."
(append
(setq counsel-projectile--buffers
(counsel-projectile--project-buffers))
(setq counsel-projectile--non-visited-files
(let ((root (projectile-project-root))
(files (projectile-current-project-files))
file)
(dolist (buffer counsel-projectile--buffers files)
(when (setq file (buffer-file-name (get-buffer buffer)))
(setq files (delete (file-relative-name file root) files))))))))
(defun counsel-projectile--matcher (regexp candidates)
"Return REGEXP-matching CANDIDATES for `counsel-projectile'.
Relies on `ivy--switch-buffer-matcher' and
`counsel--find-file-matcher'."
(append (ivy--switch-buffer-matcher regexp counsel-projectile--buffers)
(counsel--find-file-matcher regexp counsel-projectile--non-visited-files)))
(defun counsel-projectile-action (name)
"Switch to buffer or find file named NAME."
(if (member name counsel-projectile--buffers)
(counsel-projectile-switch-to-buffer-action name)
(counsel-projectile-find-file-action name)))
(defun counsel-projectile-action-other-window (name)
"Switch to buffer or find file named NAME in another window."
(if (member name counsel-projectile--buffers)
(switch-to-buffer-other-window name)
(counsel-projectile-find-file-action-other-window name)))
(defun counsel-projectile-action-find-file-manually (name)
"Call `counsel-find-file' from default directory of buffer
directory of file named NAME."
(if (member name counsel-projectile--buffers)
(counsel-projectile-switch-to-buffer-action-find-file-manually name)
(counsel-projectile-find-file-action-find-file-manually name)))
(defun counsel-projectile-action-file-extern (name)
"Find file named NAME externally."
(if (member name counsel-projectile--buffers)
(message "This action does not apply to buffers.")
(counsel-projectile-find-file-action-extern name)))
(defun counsel-projectile-action-file-root (name)
"Find file named NAME as root."
(if (member name counsel-projectile--buffers)
(message "This action does not apply to buffers.")
(counsel-projectile-find-file-action-root name)))
(defun counsel-projectile-transformer (str)
"Fontifies modified, file-visiting buffers as well as non-visited files."
(if (member str counsel-projectile--buffers)
(ivy-switch-buffer-transformer str)
(propertize str 'face 'ivy-virtual)))
;;;###autoload
(defun counsel-projectile (&optional arg)
"Jump to a buffer or file in the current project.
With a prefix ARG, invalidate the cache first.
If not inside a project, call `counsel-projectile-switch-project'."
(interactive "P")
(if (not (projectile-project-p))
(counsel-projectile-switch-project)
(projectile-maybe-invalidate-cache arg)
(ivy-read (projectile-prepend-project-name "Load buffer or file: ")
(counsel-projectile--project-buffers-and-files)
:matcher #'counsel-projectile--matcher
:require-match t
:action counsel-projectile-action
:caller 'counsel-projectile)))
(ivy-set-display-transformer
'counsel-projectile
'counsel-projectile-transformer)
;;;; counsel-projectile-mode
(defvar counsel-projectile-command-map
(let ((map (make-sparse-keymap)))
(set-keymap-parent map projectile-command-map)
(define-key map (kbd "s r") 'counsel-projectile-rg)
(define-key map (kbd "C-c") 'counsel-projectile-org-capture)
(define-key map (kbd "SPC") 'counsel-projectile)
map)
"Keymap for Counesl-Projectile commands after `projectile-keymap-prefix'.")
(fset 'counsel-projectile-command-map counsel-projectile-command-map)
(defvar counsel-projectile-mode-map
(let ((map (make-sparse-keymap)))
(define-key map projectile-keymap-prefix 'counsel-projectile-command-map)
(define-key map [remap projectile-find-file] 'counsel-projectile-find-file)
(define-key map [remap projectile-find-dir] 'counsel-projectile-find-dir)
(define-key map [remap projectile-switch-to-buffer] 'counsel-projectile-switch-to-buffer)
(define-key map [remap projectile-grep] 'counsel-projectile-grep)
(define-key map [remap projectile-ag] 'counsel-projectile-ag)
(define-key map [remap projectile-switch-project] 'counsel-projectile-switch-project)
map)
"Keymap for Counsel-Projectile mode.")
;;;###autoload
(define-minor-mode counsel-projectile-mode
"Toggle Counsel-Projectile mode on or off.
With a prefix argument ARG, enable the mode if ARG is positive,
and disable it otherwise. If called from Lisp, enable the mode
if ARG is omitted or nil, and toggle it if ARG is `toggle'.
Counsel-Projectile mode triggers Projectile mode, remaps
Projectile commands that have counsel replacements, and adds key
bindings for Counsel-Projectile commands that have no Projectile
counterpart.
\\{counsel-projectile-mode-map}"
:group 'counsel-projectile
:require 'counsel-projectile
:keymap counsel-projectile-mode-map
:global t
(if counsel-projectile-mode
(projectile-mode)
(projectile-mode -1)))
;;;; provide
(provide 'counsel-projectile)
;;; counsel-projectile.el ends here