Skip to content

Emit relative path to output #8692

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.

Sign up for GitHub

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

Merged
merged 5 commits into from
Apr 25, 2023
Merged

Emit relative path to output #8692

Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
1170ac4
Emit relative path to output
rainersigwald Apr 13, 2023
dc86d53
Case-insensitive comparison and fix links
rainersigwald Apr 24, 2023
750d47a
Guard against short output paths
rainersigwald Apr 25, 2023
fbfeb40
Merge remote-tracking branch 'upstream/main' into livelogger-relative…
rainersigwald Apr 25, 2023
d46e3a6
Merge remote-tracking branch 'upstream/main' into livelogger-relative…
rainersigwald Apr 25, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 19 additions & 3 deletions src/MSBuild/LiveLogger/LiveLogger.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,11 @@ public override string ToString()
/// </summary>
private DateTime _buildStartTime;

/// <summary>
/// The working directory when the build starts, to trim relative output paths.
/// </summary>
private readonly string _initialWorkingDirectory = Environment.CurrentDirectory;

/// <summary>
/// True if the build has encountered at least one error.
/// </summary>
Expand Down Expand Up @@ -350,7 +355,8 @@ private void ProjectFinished(object sender, ProjectFinishedEventArgs e)
// Print the output path as a link if we have it.
if (outputPath is not null)
{
ReadOnlySpan<char> url = outputPath.Value.Span;
ReadOnlySpan<char> outputPathSpan = outputPath.Value.Span;
ReadOnlySpan<char> url = outputPathSpan;
try
{
// If possible, make the link point to the containing directory of the output.
Expand All @@ -360,10 +366,20 @@ private void ProjectFinished(object sender, ProjectFinishedEventArgs e)
{
// Ignore any GetDirectoryName exceptions.
}

// If the output path is under the initial working directory, make the console output relative to that to save space.
if (outputPathSpan.StartsWith(_initialWorkingDirectory.AsSpan(), FileUtilities.PathComparison)
&& (outputPathSpan[_initialWorkingDirectory.Length] == Path.DirectorySeparatorChar
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's not possible for outputPathSpan to be the same as _initialWorkingDirectory to cause a crash here, is it?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hm. Not normally, but we can't control what projects might emit, so we should definitely guard against this.

|| outputPathSpan[_initialWorkingDirectory.Length] == Path.AltDirectorySeparatorChar))
{
outputPathSpan = outputPathSpan.Slice(_initialWorkingDirectory.Length + 1);
}


#if NETCOREAPP
Terminal.WriteLine($" ({duration:F1}s) → {AnsiCodes.LinkPrefix}{url}{AnsiCodes.LinkInfix}{outputPath}{AnsiCodes.LinkSuffix}");
Terminal.WriteLine($" ({duration:F1}s) → {AnsiCodes.LinkPrefix}{url}{AnsiCodes.LinkInfix}{outputPathSpan}{AnsiCodes.LinkSuffix}");
#else
Terminal.WriteLine($" ({duration:F1}s) → {AnsiCodes.LinkPrefix}{url.ToString()}{AnsiCodes.LinkInfix}{outputPath.ToString()}{AnsiCodes.LinkSuffix}");
Terminal.WriteLine($" ({duration:F1}s) → {AnsiCodes.LinkPrefix}{url.ToString()}{AnsiCodes.LinkInfix}{outputPathSpan.ToString()}{AnsiCodes.LinkSuffix}");
#endif
}
else
Expand Down