Prevent unnecessary outer directory searches #1082
Merged
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
Without the added checks, every directory in a source path would be scanned even when the project files have already been found. This can cause avoidable permission errors and thus typedoc to break on out-of-the-box builds for the simplest of projects. * Stops the search when readme.md and package.json are found. * Stops the search when `--readme = none` and package.json is found.
While this commit was taken from the pro-src/master branch, I've made some changes as appropriate: - Dropped the specs changes as it seemed unrelated to the test failures - Fixed bug in `reachedTopDirectory` where it appeared to be accidentally inversed - Fixed merge issues
aciccarello
approved these changes
Jul 29, 2019
| } | ||
|
|
||
| let dirName = Path.resolve(Path.dirname(fileName)); | ||
| while (!packageAndReadmeFound() && !reachedTopDirectory(dirName) && !visitedDirBefore(dirName)) { |
There was a problem hiding this comment.
This reads very clearly to me 👍
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.
Fixes #645 and supersedes PR #772
Figured I'd have a crack at getting this fix in. I ran into this particular bug trying to run typedoc on a project on my phone (shout out to Termux while I'm here, amazing Android terminal).
I've cherry-picked two relevant commits from the branch for #772, with a few adjustments:
reachedTopDirectoryfunction where it seemed that the check was accidentally inversed.If there's any further issues with this PR, I'm happy to follow up and to try and fix them.