-
Notifications
You must be signed in to change notification settings - Fork 1.4k
Add TryGetAbsolutePath to TaskEnvironment public API #13021
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Closed
Closed
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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 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 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 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 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 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -33,12 +33,37 @@ public AbsolutePath ProjectDirectory | |
|
|
||
| /// <summary> | ||
| /// Converts a relative or absolute path string to an absolute path. | ||
| /// This function resolves paths relative to ProjectDirectory. | ||
| /// This function resolves paths relative to <see cref="ProjectDirectory"/>. | ||
| /// </summary> | ||
| /// <param name="path">The path to convert.</param> | ||
| /// <returns>An absolute path representation.</returns> | ||
| /// <exception cref="System.ArgumentException"> | ||
| /// Thrown when <paramref name="path"/> contains one or more invalid path characters as | ||
| /// returned by <see cref="System.IO.Path.GetInvalidPathChars"/>. | ||
| /// </exception> | ||
| public AbsolutePath GetAbsolutePath(string path) => _driver.GetAbsolutePath(path); | ||
|
|
||
| /// <summary> | ||
| /// Converts a relative or absolute path string to an absolute path. | ||
| /// This function resolves paths relative to <see cref="ProjectDirectory"/>. | ||
| /// </summary> | ||
| /// <param name="path">The path to convert to absolute.</param> | ||
| /// <param name="absolutePath">The resulting absolute path if the conversion succeeded; default otherwise.</param> | ||
| /// <returns>True if the conversion succeeded; false otherwise.</returns> | ||
| public bool TryGetAbsolutePath(string path, out AbsolutePath absolutePath) | ||
| { | ||
| try | ||
| { | ||
| absolutePath = GetAbsolutePath(path); | ||
| return true; | ||
| } | ||
| catch | ||
| { | ||
| absolutePath = default; | ||
| return false; | ||
| } | ||
| } | ||
|
Comment on lines
+53
to
+65
|
||
|
|
||
| /// <summary> | ||
| /// Gets the value of an environment variable. | ||
| /// </summary> | ||
|
|
@@ -77,4 +102,4 @@ public AbsolutePath ProjectDirectory | |
| /// </summary> | ||
| internal void Dispose() => _driver.Dispose(); | ||
| } | ||
| } | ||
| } | ||
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The catch-all exception handler with an empty catch block is not following best practices for Try* pattern methods. The method should only catch specific expected exceptions (like ArgumentException from Path.GetInvalidPathChars violations) rather than catching all exceptions.
Consider catching only the specific exceptions that GetAbsolutePath is documented to throw (ArgumentException based on the XML documentation), and let unexpected exceptions propagate. This makes debugging easier and prevents masking programming errors.