/grep

A GREP utility written in go using worker pool pattern

Primary LanguageGo

Grep like CLI in go

Problem statement

Write a command line program that implements Unix command grep like functionality.

Video solution and approach

GREP.mp4
Code.Walkthrough.mov

Features required and status

  • Ability to search for a string in a file
$  ./grep anish test_files/testfile.txt

this is anish.
is this anish.
this is anish?
anish
  • Ability to search for a string from standard input
$ ./grep foo
bar
barbazfoo
Foobar
food
^D

barbazfoo
food
  • Ability to perform case-insensitive grep using -i flag
$ ./grep -i Test test_files

test_files/testfile2.txt: this is test 8
test_files/testfile2.txt: this is test 14
  • Ability to write output to a file instead of a standard out.
$ ./grep -o temp.txt anish test_files

should create an temp.txt file with the output from grep. for example,

$ cat out.txt
test_files/parent_dir1/child_dir1/child_dir1_file.txt: this is anish parent_dir1/child_dir1/child_dir1_file.txt
test_files/parent_dir1/child_dir1/child_dir1_file.txt: is this anish parent_dir1/child_dir1/child_dir1_file.txt
test_files/parent_dir1/child_dir1/child_dir1_file.txt: this is anish? parent_dir1/child_dir1/child_dir1_file.txt
test_files/parent_dir1/child_dir2/child_dir2_file.txt: this is anish parent_dir1/child_dir2/child_dir2_file.txt
test_files/parent_dir1/child_dir2/child_dir2_file.txt: is this anish parent_dir1/child_dir2/child_dir2_file.txt
test_files/parent_dir1/child_dir2/child_dir2_file.txt: this is anish? parent_dir1/child_dir2/child_dir2_file.txt
test_files/parent_dir2/parent_dir2_file1.txt: this is anish parent_dir2/parent_dir2_file1.txt
test_files/parent_dir2/parent_dir2_file1.txt: is this anish parent_dir2/parent_dir2_file1.txt
test_files/parent_dir2/parent_dir2_file1.txt: this is anish? parent_dir2/parent_dir2_file1.txt
test_files/testfile.txt: this is anish.
test_files/testfile.txt: is this anish.
test_files/testfile.txt: this is anish?
test_files/testfile.txt: anish
  • Ability to search for a string recursively in any of the files in a given directory. When searching in multiple files, the output should indicate the file name and all the output from one file should be grouped together in the final output. (in other words, output from two files shouldn't be interleaved in the final output being printed)
$ ./grep test test_files
test_files/testfile2.txt: this is test 8
test_files/testfile2.txt: this is test 14
  • Ability to print n lines before using -B flag
$ ./grep -B 2 test test_files

test_files/testfile2.txt: this is line 6
test_files/testfile2.txt: this is line 7
test_files/testfile2.txt: this is test 8
test_files/testfile2.txt: this is line 12
test_files/testfile2.txt: this is line 13
test_files/testfile2.txt: this is test 14
  • Ability to print n lines after using -A flag
$ ./grep -A 2 test test_files

test_files/testfile2.txt: this is test 8
test_files/testfile2.txt: this is line 9
test_files/testfile2.txt: this is line 10
test_files/testfile2.txt: this is test 14
test_files/testfile2.txt: this is line 15
test_files/testfile2.txt: this is line 16
  • Ability to print count of matches using -c flag
$ ./grep -c anish test_files/parent_dir1/child_dir1/child_dir1_file.txt

3

Future Todo's

  • Handle for condition when file limit opening is restricted by os. make is os independent.
  • Load test and benchmarking grep
  • Add other options from GREP
  • Handle interrupt signals