cleancut/headtail

head and tail simultaneously

Hi! I'm Nathan Stocks 👨🏻‍💻 👾 🎮

⚙️ I love Rust! I am a Rust programming instructor, the author of Rusty Engine, an open source maintainer, an indie game developer, and a Senior Software Engineer at GitHub.

🚀 My Open Source Projects

• Rusty Engine - 2D game engine for learning Rust
• headtail - A command-line utility which combines the functionality of the classic head and tail utilities
• bevy_rapier2d_assets - A plugin for Bevy to make it easy to create & load files with physics assets information such as colliders
• Ultimate Rust Crash Course - Open source exercises for my course on Udemy
• Ultimate Rust 2 - Open source exercises for my other course on Udemy
• Invaders - "Space Invaders" clone...in the terminal
• Rusty Sword - Conquer monsters in your terminal with your rusty sword
• Green - a clean, colorful, fast Python test runner.

✨ Notable Projects I Contribute To

• Rust - The awesome systems programming language
• Bevy - A refreshingly simple data-driven game engine built in Rust

💖 Show Your Support

Support my open source work on GitHub Sponsors or my game projects on Patreon!

headtail's Issues

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?

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 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.

Upgrade to clap v4

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

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.

Add missing integration tests

Add integration tests covering:

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

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.

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.