BurntSushi/ripgrep

[globset] support more options on GlobBuilder?

Open

#2229 opened on Jun 9, 2022

View on GitHub
 (3 comments) (0 reactions) (0 assignees)Rust (63,768 stars) (2,559 forks)batch import
enhancementhelp wantedquestion

Description

Describe your feature request

Refer to GlobBuilder, it supports case_insensitive, literal_separator and backslash_escape.

I wonder if it can support more options includes:

/// Whether or not paths that contain components that start with a `.`
/// will require that `.` appears literally in the pattern; `*`, `?`, `**`,
/// or `[...]` will not match. This is useful because such files are
/// conventionally considered hidden on Unix systems and it might be
/// desirable to skip them when listing files.
require_literal_leading_dot: bool

/// if given pattern contains `**`, this flag check if `**` matches hidden directory.
/// For example: if true, `**` will match `.abcdef/ghi`.
recursive_match_hidden_dir: bool

Which mainly works for hidden directory or hidden file

Contributor guide

Tech stack
rust
Domain
developer experiencetooling
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Rust programmingglob pattern syntax
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
Start by examining the existing GlobBuilder implementation in the globset crate (likely in 'crates/globset/src/glob.rs' or similar). Understand how the current options like case insensitive are implemented. Then implement the two new fields: require literal leading dot and recursive match hidden dir, following the same pattern. Ensure to update the builder methods and the matching logic in the glob implementation.