Skip to content

Instantly share code, notes, and snippets.

@pesterhazy
Last active March 21, 2024 18:25
Show Gist options
  • Save pesterhazy/fabd629fbb89a6cd3d3b92246ff29779 to your computer and use it in GitHub Desktop.
Save pesterhazy/fabd629fbb89a6cd3d3b92246ff29779 to your computer and use it in GitHub Desktop.
Using ripgrep in Emacs using helm-ag (Spacemacs)

Why

Ripgrep is a fast search tool like grep. It's mostly a drop-in replacement for ag, also know as the Silver Searcher.

helm-ag is a fantastic package for Emacs that allows you to display search results in a buffer. You can also jump to locations of matches. Despite the name, helm-ag works with ripgrep (rg) as well as with ag.

How

  1. Install ripgrep

  2. Make Spacemacs use helm-project-do-ag directly when pressing SPC / without preselecting the symbol under the cursor.

    Type SPC f e d to bring up ~/.spacemacs.

    (defun dotspacemacs/user-config ()
      ;; ....
      (evil-leader/set-key "/" 'spacemacs/helm-project-do-ag))
    
  3. Force ripgrep as search tool

    SPC SPC customize-set-variable

    Select variable helm-ag-base-command

    Set value to rg --vimgrep --no-heading --smart-case

Usage

SPC / should allow you to search in the current project.

You can prefix patterns with options

-G*.cljs -w time - search for the word "time" in all .cljs files

-tclojure time - search for "time" in all .{clj,cljs,cljc} files

uno\ due\ tre - search for the string "uno duo tre"

-C5 foo - search for "foo" but show 5 lines of context before and after the match

(?:^|[^\w-])time(?:[^\w-]|$) - search for lisp-word "time", i.e. search for the full word "time" while considering "-" to be a word characer

@apmiller108
Copy link

In order to use flags, appending = to the flag works for me. For example, to search for a term only in *.js files:

foo -g=*.js

or

foo --type=js

@fperies
Copy link

fperies commented Sep 20, 2023

@apmiller108 , thank you for your reply. This is good to know!

Also, regarding my previous question, the trick is that simple quotes were useless: foo -g!ut/ will exclude all paths with ut/ and does the job !
But your proposal works as well: -g=!ut/.

Thanks again!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment