Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add deadgrep-file-type-alist to allow user-defined easily toggle-able set of types #93

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Add deadgrep-file-type-alist to allow user-defined easily toggle-able set of types #93

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f1dbca2
Add deadgrep-file-type-alist for user defined file types
gvol Jan 14, 2021
e1ca2c5
Add tests for deadgrep-file-type-alist
gvol Jan 14, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 36 additions & 0 deletions deadgrep.el
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -149,6 +149,24 @@ display."
(defvar-local deadgrep--file-type 'all)
(put 'deadgrep--file-type 'permanent-local t)

(defcustom deadgrep-file-type-alist
nil
"Alist defining predetermined file types.
The key is a symbol which will be used as the name as the value
of `deadgrep--file-type' and as the name of a button in the
*deadgreap* buffer. The value is a list of arguments to pass to rg.

For example, to only search in test files you might add the
following key-value pair.

(tests . (\"--type-add=TEST:*_test.cpp\"
\"--type=TEST\"))

The types of `all', `type', and `glob' will always be available."
:type '(alist :key-type symbol
:value-type (repeat :tag "Arguments for rg" string))
:group 'deadgrep)

(defvar-local deadgrep--context nil
"When set, also show context of results.
This is stored as a cons cell of integers (lines-before . lines-after).")
Expand Down Expand Up @@ -629,6 +647,8 @@ with a text face property `deadgrep-match-face'."
(cons 'type (deadgrep--read-file-type deadgrep--initial-filename))))
((eq button-type 'glob)
(setq deadgrep--file-type (cons 'glob (deadgrep--read-file-glob))))
((alist-get button-type deadgrep-file-type-alist)
(setq deadgrep--file-type button-type))
(t
(error "Unknown button type: %S" button-type))))
(deadgrep-restart))
Expand Down Expand Up @@ -722,6 +742,15 @@ to obtain ripgrep results."
(push (format "--type=%s" (cdr deadgrep--file-type)) args))
((eq (car-safe deadgrep--file-type) 'glob)
(push (format "--glob=%s" (cdr deadgrep--file-type)) args))
((alist-get deadgrep--file-type deadgrep-file-type-alist)
(let ((a (alist-get deadgrep--file-type deadgrep-file-type-alist)))
(cond ((stringp a)
(push a args))
((listp a)
(dolist (aa a)
(push aa args)))
(t
(error "unknown argument type in deadgrep-file-type-alist: %s" a)))))
(t
(error "Unknown file-type: %S" deadgrep--file-type)))

Expand Down Expand Up @@ -832,6 +861,13 @@ search settings."
(if (eq (car-safe deadgrep--file-type) 'glob)
(format ":%s" (cdr deadgrep--file-type))
"")
(cl-loop for alist-item in deadgrep-file-type-alist
concat (concat " "
(if (eq deadgrep--file-type (car alist-item))
(symbol-name (car alist-item))
(deadgrep--button (symbol-name (car alist-item))
'deadgrep-file-type
'file-type (car alist-item)))))
"\n\n")
(put-text-property
start-pos (point)
Expand Down
13 changes: 13 additions & 0 deletions test/deadgrep-unit-test.el
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -476,6 +476,19 @@ edit mode."
(equal (deadgrep--arguments "foo" 'words 'ignore '(3 . 2))
'("--no-config" "--color=ansi" "--line-number" "--no-heading" "--no-column" "--with-filename" "--fixed-strings" "--word-regexp" "--ignore-case" "--glob=*.el" "--before-context=3" "--after-context=2" "--" "foo" ".")))))

(ert-deftest deadgrep--arguments-custom-file-types ()
(let ((deadgrep-file-type-alist '((tests . "--type=TEST")
(no-tests . "--type-not=TEST"))))
(let ((deadgrep--file-type 'tests))
(should
(equal (deadgrep--arguments "foo" 'string 'sensitive '(1 . 0))
'("--no-config" "--color=ansi" "--line-number" "--no-heading" "--no-column" "--with-filename" "--fixed-strings" "--case-sensitive" "--type=TEST" "--before-context=1" "--after-context=0" "--" "foo" "."))))
(let ((deadgrep--file-type 'no-tests))
(should
(equal (deadgrep--arguments "foo" 'string 'sensitive '(1 . 0))
'("--no-config" "--color=ansi" "--line-number" "--no-heading" "--no-column" "--with-filename" "--fixed-strings" "--case-sensitive" "--type-not=TEST" "--before-context=1" "--after-context=0" "--" "foo" ".")))))
)

(ert-deftest deadgrep--arguments-error-cases ()
(should-error
(deadgrep--arguments "foo" 'foo 'smart nil))
Expand Down
Loading