Skip over broken files when scanning the source #1883
Conversation
This file contains hidden or 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
This fixes the bug jsdoc#1623 and other similar issues. When scanning source code, the previous behaviour was to trip up on any issue that `statSync` may raise. This can particularly happen for circular and broken symlinks. The fix addresses this by creating a mock version of `fs` that does not even return such broken files from `readdirSync`. The alternative fix would be to raise this on the `klaw-sync` package, but that might be a breaking change for the packages that depend on it.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
This fixes the bug #1623 and other similar issues.
When scanning source code, the previous behaviour was to trip up on any issue that
statSyncmay raise. This can particularly happen for circular and broken symlinks.The fix addresses this by creating a mock version of
fsthat does not even return such broken files fromreaddirSync.The alternative fix would be to raise this on the
klaw-syncpackage, but that might be a breaking change for the packages that depend on it.