handle-user-output
Guide for producing user-facing output in this Rust project. NEVER use println!, eprintln!, print!, eprint!, or direct stdout/stderr access. Always use UserOutput via the execution context or ProgressReporter in controllers. Covers the sink-based output architecture, stdout vs stderr channel strategy, ProgressReporter for multi-step operations, verbosity control, and themes. Use when writing any user-visible output, progress messages, errors, or results. Triggers on "println", "print output", "user output", "UserOutput", "ProgressReporter", "display result", "output message", or "progress message".
소스 정보
- 저장소
- torrust/torrust-tracker-deployer
- 최근 소스 활동
- 2026년 2월 25일 19:30
- 감지된 SKILL.md 언어
- 영어
- 스타
- 4
- 포크
- 2
설치 방법
기본적으로 소스를 먼저 확인하는 Prompt가 선택됩니다. 직접 명령으로 전환하거나 로컬 사본을 다운로드할 수도 있습니다.
소스 파일 검토
설치 여부를 결정하기 전에 SKILL.md와 SkillsMP에 표시된 보조 파일을 읽어 보세요.
SKILL.md 표시 중
SKILL.md
소스 지침 · 읽기 전용 미리보기- name
- handle-user-output
- description
- Guide for producing user-facing output in this Rust project. NEVER use println!, eprintln!, print!, eprint!, or direct stdout/stderr access. Always use UserOutput via the execution context or ProgressReporter in controllers. Covers the sink-based output architecture, stdout vs stderr channel strategy, ProgressReporter for multi-step operations, verbosity control, and themes. Use when writing any user-visible output, progress messages, errors, or results. Triggers on "println", "print output", "user output", "UserOutput", "ProgressReporter", "display result", "output message", or "progress message".
- metadata
- {"author":"torrust","version":"1.0"}
# Handling User Output
## Golden Rule
**NEVER write directly to stdout/stderr.**
```rust
// ❌ FORBIDDEN
println!("Processing...");
eprintln!("Error occurred");
std::io::stdout().write_all(b"data").unwrap();
```
```rust
// ✅ CORRECT — use UserOutput
let user_output = ctx.user_output();
user_output.lock().borrow_mut().progress("Processing...");
user_output.lock().borrow_mut().error("Error occurred");
user_output.lock().borrow_mut().result("data");
```
## In Controllers: Use ProgressReporter
Controllers use `ProgressReporter` (not `UserOutput` directly):
```rust
use crate::presentation::views::progress::ProgressReporter;
use crate::presentation::views::UserOutput;
pub struct ConfigureCommandController {
progress: ProgressReporter,
}
impl ConfigureCommandController {
pub fn new(user_output: Arc<ReentrantMutex<RefCell<UserOutput>>>) -> Self {
Self {
progress: ProgressReporter::new(user_output, 3), // 3 total steps
}
}
pub fn execute(&mut self) -> Result<(), Error> {
self.progress.start_step("Validating environment")?;
// ... do work ...
self.progress.complete_step(Some("Environment name validated: my-env"))?;
self.progress.start_step("Configuring infrastructure")?;
// ... do work ...
self.progress.complete_step(None)?;
Ok(())
}
}
```
## Channel Strategy (stdout vs stderr)
| Channel | Use for |
| ---------- | ----------------------------------------------- |
| **stdout** | Final results, structured data (JSON), pipeline |
| **stderr** | Progress, status updates, warnings, errors |
This enables piping: `deployer create env | jq .status`
## Why This Architecture?
- **Testability**: Output captured and asserted in tests
- **Verbosity control**: Centralized filtering
- **Theme support**: emoji/plain/ASCII themes
- **Channel routing**: Automatic stdout vs stderr
## Reference
Full guide: [`docs/contributing/output-handling.md`](../../docs/contributing/output-handling.md)
GitHub에서 보기