Grepfruit

Grepfruit is a Ruby gem for searching files within a directory for a specified regular expression pattern, with options to exclude certain files or directories from the search and colorized output for better readability.

Grepfruit was originally created to be used in CI/CD pipelines to search for TODO comments in Ruby on Rails applications and provide more user-friendly output than the standard grep command, but it is flexible enough to be used for other similar purposes as well.

Add this line to your application's Gemfile:

gem 'grepfruit'

And then execute:

bundle install

Or install it yourself as:

gem install grepfruit

You can use Grepfruit from the command line to search for a regex pattern within files in a specified directory.

grepfruit [options] PATH

If no matches are found, Grepfruit returns exit status 0; otherwise, it returns exit status 1.

• -r, --regex REGEX: Regex pattern to search for (required).
• -e, --exclude x,y,z: Comma-separated list of files, directories, or lines to exclude from the search.
• -t, --truncate N: Truncate the output of the search results to N characters.
• --search-hidden: Search hidden files and directories.

Search for the pattern /TODO/ in the current directory, excluding log, tmp, vendor, node_modules, and assets directories:

grepfruit -r 'TODO' -e 'log,tmp,vendor,node_modules,assets'

Search for the pattern /FIXME|TODO/ in dev/grepfruit directory, excluding bin, tmp/log, and Gemfile.lock files and directories:

grepfruit -r 'FIXME|TODO' -e 'bin,tmp/log,Gemfile.lock' dev/grepfruit

Search for the pattern /FIXME|TODO/ in the current directory, excluding line 18 of README.md:

grepfruit -r 'FIXME|TODO' -e 'README.md:18'

Search for the pattern /FIXME|TODO/ in the current directory, truncating the output of the search results to 50 characters:

grepfruit -r 'FIXME|TODO' -t 50

Search for the pattern /FIXME|TODO/ in the current directory, including hidden files and directories:

grepfruit -r 'FIXME|TODO' --search-hidden

Facing a problem or want to suggest an enhancement?

• Open a Discussion: If you have a question, experience difficulties using the gem, or have a suggestion for improvements, feel free to use the Discussions section.

Encountered a bug?

• Create an Issue: If you've identified a bug, please create an issue. Be sure to provide detailed information about the problem, including the steps to reproduce it.
• Contribute a Solution: Found a fix for the issue? Feel free to create a pull request with your changes.

Before creating an issue or a pull request, please read the contributing guidelines.

The gem is available as open source under the terms of the MIT License.

Everyone interacting in the Grepfruit project is expected to follow the code of conduct.