Refactor helper for file input across uutils
Open
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 24.1k
- Forks
- 2k
- Avg merge
- 1d 5h
- Merged PRs (30d)
- 365
Description
Across many of the bins there's the pattern that follows:
let buffer = BufReader::new(if filename == "-" {
stdin_buf = stdin();
&mut stdin_buf as &mut dyn Read
} else {
file_buf = File::open(Path::new(filename)).map_err_context(|| filename.to_string())?;
&mut file_buf as &mut dyn Read
});
Was hoping to make a helper in uucore and standardize this process of reading from either the stdin or the file path and use it everywhere across the project. Some of them have the map_err_context and some don't the goal would be to add it to all of them.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by inventorying the repeated stdin-or-file reading pattern across the bins and inspect the uucore entry points where a shared helper could live. Standardize those call sites so file-opening errors consistently include context, then verify that all identified bins use the common process.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- cli
- Issue type
- Refactor
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100