Use filepath functions for path manipulation in getGitRepositorySubdir #177
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
Before this commit, the root directory would be removed which leaves a trailing file separator character in the beginning. This would then be trimmed by using strings.TrimPrefix. The problem here is that it uses a hardcoded file separator character which won't work on Windows because Windows uses a backslash instead of a forward slash. Using filepath.Rel to get the directory relative to the root directory will not leave a separator character in the beginning. It's also important to use filepath.ToSlash which will translate every file separator character to the forward slash. This commit makes discovery work on Windows which it didn't before.
|
Just for clearness. On windows, the return value of this function for a subdirectory called "foobar\something' would be: instead of |
Rel returns . when the directory is the same as the base directory. We can easily translate that to the empty string which is what we're looking for.
JeffreyVdb
force-pushed
the
fix/windows-repository-subdir
branch
from
d80524f
to
73a2642
Compare
filepath.Dir will return the same result when you're calling it on the root directory of your filesystem. Checking when this happens is required so that you break out of your loop. This code used to loop endlessly when called outside of a git repo. This commit fixes that.
|
Hey, thanks for your contribution. Please allow for some time to test this as this is Windows specific. |
|
The last commit should also be applicable to Linux. It should endlessly loop on all platforms (before this fix). |
tomasmik
approved these changes
Sep 22, 2023
|
Tested and merged, thanks @JeffreyVdb |
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.
Before this commit, the root directory would be removed which leaves a trailing file separator character in the beginning. This would then be trimmed by using strings.TrimPrefix. The problem here is that it uses a hardcoded file separator character which won't work on Windows because Windows uses a backslash instead of a forward slash.
Using filepath.Rel to get the directory relative to the root directory will not leave a separator character in the beginning.
It's also important to use filepath.ToSlash which will translate every file separator character to the forward slash.
This commit makes discovery work on Windows which it didn't before.