cleancut/headtail

head and tail simultaneously

headtail's Issues

Change follow to use a file watcher when possible

Operating systems often provide more efficient means of watching the events which happen with a file.

headtail currently uses a polling approach, which means the thread is waking and executing code even when it doesn't need to.

We should modify the behavior of following mode to use OS file watchers when possible.

Does this work on Windows?

It would be good if someone (not me 😆) would figure out if this utility works on Windows, and if not -- can we make it work without too much trouble?

Set up CodeQL

See the documentation for the CodeQL Action

BLOCKED until Rust is supported by CodeQL. See CodeQL's Supported languages & frameworks page.

Upgrade to clap v4

See this reddit post for links to relevant info and lots of example migrations.

Add option to output to a file

Though it is trivial to redirect stdout to a file, sometimes it is nice to be able to specify that file via a command-line argument and have the program do it itself.

Add missing integration tests

Add integration tests covering:

• -f/--follow
• -s/--sleep-interval

Add benchmarks

We should add some benchmarks so that when we make changes we can do a before/after comparison. See criterion.

These benchmarks should not be run in CI, since CI is too noisy of an environment to be useful for benchmarking (unless we somehow gain dedicated self-hosted runners for the purpose)

Add unit tests

We should add unit tests covering most of our logic, though we probably don't need any for the argument parsing giving it's a pretty straightforward usage of clap.

Ellipses (`...`) in between head and tail output

This is a very interesting and useful utility. I believe it would be particularly helpful if some demarcation such as ... or some other separating line (perhaps even colorizing it grey/dark grey) would be very helpful to rapidly differentiate the sections.

Additionally, having this in Homebrew (for macOS and Linux) so that cargo being present is not necessary.

Set up Dependabot

See Configuring Dependabot

Readme Improvements

For sure:

• Video or asciinema of headtail in action
• Quick story about how headtail came about (problem that prompted it -> our DoL session).

Maybe:

• Add section with -h output? (and automate updating it via release.toml)
• Dedicated development section?