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 (42,984 stars) (1,059 forks)batch import
good first issuehelp wanted

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

Tech stack
rust
Domain
clideveloper experience
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.
unclear
Prerequisites
Rust
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
15
Research direction
This is a meta issue for general code quality improvements in the fd repository. It references a PR discussion (#309) and suggests grouping related functions into struct impl blocks, creating a trait based filter interface, and extracting OsStr path handling into separate crates. No concrete task is defined, so a newcomer should first identify a specific code quality issue, perhaps by browsing the codebase for areas lacking modularity or documentation, and propose a focused refactoring. The maintainer (@sharkdp) has noted that this issue can be closed when quality is satisfactory, so further input from the community may be needed to define actionable subtasks.