fix: Avoid scanning and building entries for silenced directories #542
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.
Description 📖
This pull request patches the
Record#build
method to avoid recursively scanning and creating entries for directories that are being ignored in theListener
configuration.Background 📜
Building entries that will be ignored by the listener degrades the initialization performance, and can greatly increase memory consumption.
This is especially noticeable on projects with large
.git
ornode_modules
directories.The Fix 🔨
Use the
Silencer
configuration to avoid scanning ignored directories.Benchmarks 📈
The performance difference is significant on startup time.
Using the
listen
gem in a small Jekyll site:Before (silenced dirs are scanned)
After (silenced dirs are ignored)
Additional Benefits ✨
Directories that are ignored would no longer output symlink warnings since they are no longer being scanned.