sharkdp/fd

Design and refactoring / general code quality

Open

#382 opened on Jan 4, 2019

View on GitHub
 (15 comments) (1 reaction) (0 assignees)Rust (1,059 forks)batch import
good first issuehelp wanted

Repository metrics

Stars
 (42,984 stars)
PR merge metrics
 (Avg merge 15d 23h) (16 merged PRs in 30d)

Description

This is intended as a tracking issue for general code quality and design discussions. @sharkdp feel free to close this when you think quality has reached an overall satisfactory level.

To start, I'll quote a recent comment by @sharkdp from a discussion on a PR thread:

There are many things I have in mind that would hopefully help to improve the code quality:

  • Group related functions into impl blocks of appropriate structs such that we don't have to pass around so many parameters.
  • Think about a unified interface for filters (file type, file size, modification data, file extension, ..). Maybe a trait-based interface where the filters would be stored in a Vec<Box<dyn Filter>>.
  • Extract some of the functionality like the OsStr-based path handling into separate libraries / crates.

Contributor guide

Research direction
Review the current code structure, identify functions with many parameters, and explore implementing a unified filter trait and grouping related functions into impl blocks.
Tech stack
rust
Domain
cli
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
4
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Over 1 week
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
RustExperience with codebase design
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
20