$ show rust-lang/rustlings
Rustlings is an interactive CLI application designed to teach Rust through a series of small, hands-on exercises. It provides a terminal-based learning environment where users edit, compile, test, and run Rust code snippets, progressing through topics from basic variables to async programming. The system is built as a single binary that embeds all exercise files and solutions at compile time using a custom proc macro, eliminating external file dependencies. The CLI offers multiple modes: a watch mode that automatically re-checks exercises on file changes, a list mode for browsing and selecting exercises, and commands for running, hinting, resetting, and checking all exercises. State persistence tracks user progress in a local file. The architecture is modular, with clear separation between exercise execution logic, terminal UI, state management, and developer tooling. External dependencies include clap for argument parsing, crossterm for terminal control, notify for file watching, and serde for serialization. The project is actively maintained by the Rust community and serves as the official companion to 'The Rust Programming Language' book.
The LLM identified 4 files worth highlighting for reuse:
Defines the `RunnableExercise` trait and its implementations for compiling, testing, running, and linting Rust code. This is a clean, generic interface for executing arbitrary Rust exercises with different modes (compile, test, clippy, run). It could be extracted and reused in any Rust tooling that needs to run user-provided code with progress feedback.
Implements a generic scroll state machine for list navigation with configurable padding, offset, and item count. It handles scrolling up/down, page up/down, and maintains a visible window. This is a self-contained, reusable component for any terminal UI list widget.
Provides the `include_files!` procedural macro that embeds all exercise and solution files into the binary at compile time. This pattern eliminates runtime file system dependencies and ensures the tool is self-contained. The macro is generic and could be reused to bundle any set of files in a Rust application.
Implements a `NotifyEventHandler` that debounces file system events using a channel and a configurable delay. It batches rapid changes (e.g., from editor saves) into a single notification. This is a reusable pattern for any Rust application that needs responsive file watching without overwhelming the system.