Method: Git::Base#grep

Defined in:

lib/git/base.rb

#grep(string, path_limiter = nil, opts = {}) ⇒ Hash<String, Array>

Run a grep for 'string' on the HEAD of the git repository

Examples:

Limit grep's scope by calling grep() from a specific object:

git.object("v2.3").grep('TODO')

Using grep results:

git.grep("TODO").each do |sha, arr|
  puts "in blob #{sha}:"
  arr.each do |line_no, match_string|
    puts "\t line #{line_no}: '#{match_string}'"
  end
end

Parameters:

• string (String) —

  the string to search for

• path_limiter (String, Array) (defaults to: nil) —

  a path or array of paths to limit the search to or nil for no limit

• opts (Hash) (defaults to: {}) —

  options to pass to the underlying git grep command

Options Hash (opts):

• :ignore_case (Boolean) — default: false —

  ignore case when matching

• :invert_match (Boolean) — default: false —

  select non-matching lines

• :extended_regexp (Boolean) — default: false —

  use extended regular expressions

• :object (String) — default: HEAD —

  the object to search from

Returns:

• (Hash<String, Array>) —

  a hash of arrays

  {
     'tree-ish1' => [[line_no1, match_string1], ...],
     'tree-ish2' => [[line_no1, match_string1], ...],
     ...
  }
  

# File 'lib/git/base.rb', line 335

def grep(string, path_limiter = nil, opts = {})
  self.object('HEAD').grep(string, path_limiter, opts)
end