feature/traverse: Add an option to rely purely on ignore files for traversing directories #339
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
drahnr
reviewed
Jan 19, 2025
Comment on lines
+492
to
513
| while let Some(path) = all_files.pop_front() { | ||
| let x = if let Ok(meta) = path.metadata() { | ||
| if meta.is_file() { | ||
| match path.file_name().and_then(|x| x.to_str()) { | ||
| Some(file_name) if file_name == "Cargo.toml" => Extraction::Manifest(path), | ||
| Some(file_name) if file_name.ends_with(".md") => Extraction::Markdown(path), | ||
| Some(file_name) if file_name.ends_with(".rs") => Extraction::Source(path), | ||
| _ => { | ||
| // This branch is commonly entered when ran on a non-cargo | ||
| // path. | ||
| // Potentially become mdbook aware | ||
| // <https://github.com/drahnr/cargo-spellcheck/issues/273> | ||
| log::debug!( | ||
| "Unknown file type encountered, skipping path: {}", | ||
| path.display() | ||
| ); | ||
| continue; | ||
| } | ||
| } | ||
| } else { | ||
| Extraction::Missing(path) | ||
| } |
There was a problem hiding this comment.
I think this part should become a function, it's (almost?) identical to the one in the else branch.
drahnr
reviewed
Jan 19, 2025
| let mut all_files = VecDeque::<PathBuf>::with_capacity(32); | ||
|
|
||
| while let Some(path) = flow.pop_front() { | ||
| let files = ignore::WalkBuilder::new(path) |
There was a problem hiding this comment.
Can we define a closure that gives us an iterator back rather than duplicating the if and else branch logic. It's been a mess before you came, but now I can see what I've done a few years back 😰
drahnr
requested changes
Jan 19, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this PR accomplish?
Changes proposed by this PR:
This pr adds an option flag to change the behaviour of the traversal module to collect all relevant files except those which match an entry in a .gitignore file. Our usecase for this is to be able to ignore certain temporary Markdown files which are pulled in when building our documentation.
📜 Checklist
./demosub directory