arsham/blush

Grep with colours

blush's Issues

Rewrite WriteTo and Read functions of Blush

At the moment, WriteTo() function uses bufio.Scanner() with a custom buffer and a large token size in order to read from readers line by line, which is not ideal. On the other hand, Read() uses a bytes.Buffer instance and reads everything on first call. Both of these methods require refactoring.

WriteTo (1)

This method should request the next available line or more if required (2), and call Find() methods of all finders, keeping the results in a buffer. Then it should write up to length of given io.Writer, while keeping the rest of the buffer for the next try, until it processes everything.

Read

This method shares most of WriteTo()'s logic.

Notes

• (1) io.Copy() uses WriteTo if available, then Read() method.
• (2) Next available line(s) should be enough to fill the provided Writer or byte slice.
• There is a single reader in Blush struct, which is either os.Stdin or reader.MultiReader and when its Read() method is called, it automatically closes previously processed reader and opens the next one. Therefore there is no action required here.
• Reads can be split in the middle of colouring. This means the terminal's codes for colouring could span between read calls. Therefore it should unformat if there's been an interruption in between, otherwise it could mess up the terminal's colours.
• In case of reader.MultiReader usage, if any filed isn't ended with a new line and readers rotate, it should account for a new line in between operations.

Not really an issue...

Just a suggestion but you might want to switch to a simpler prompt for your screenshots. The one you're using is cool and everything but a little distracting when we really just want to see how the results are getting colored.

doesn't compile on Debian9 with go1.7.4 / go minimum version

I have Debian 9 Stretch and go get doesn't work

$ go version
go version go1.7.4 linux/amd64

$ go get github.com/arsham/blush
# github.com/arsham/blush/cmd
opt/go/src/github.com/arsham/blush/cmd/args.go:78: undefined: sort.SliceStable
opt/go/src/github.com/arsham/blush/cmd/args.go:118: undefined: sort.SliceStable
opt/go/src/github.com/arsham/blush/cmd/args.go:122: undefined: sort.SliceStable

SliceStable seems to be introduced with 1.8, https://golang.org/doc/go1.8 ? So maybe the readme needs an update?

Help flag

No help flag available from the CLI. Can't expect people to continually reference the github docs.
Any reason not to do this? If not I'll look at it and put in a PR this weekend.

Could you explain how to install/run?

Could you explain how to install/run?
I've already installed golang... what then, I'm on ubuntu, but i suppose it's quite similar for everyones go installation.

Demo images

Use these images in the readme file:

Ignore binary files