Skip to content

Remove extra newline in GetComment feature #1080

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 3 commits into from
Oct 31, 2019
Merged

Remove extra newline in GetComment feature #1080

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5a40656
Remove extra newline in GetComment feature
TylerLeonhardt Oct 31, 2019
1b778dd
future proof if PSSA removes it
TylerLeonhardt Oct 31, 2019
db2aae6
Add suggested changes
rjmholt Oct 31, 2019
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
13 changes: 9 additions & 4 deletions src/PowerShellEditorServices/Services/PowerShellContext/Handlers/GetCommentHelpHandler.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@

using System;
using System.Collections.Generic;
using System.Linq;
using System.Management.Automation.Language;
using System.Threading;
using System.Threading.Tasks;
Expand Down Expand Up @@ -80,21 +79,27 @@ public async Task<CommentHelpRequestResult> Handle(CommentHelpRequestParams requ
vscodeSnippetCorrection: true,
placement: helpLocation));

string helpText = analysisResults?.FirstOrDefault()?.Correction?.Edits[0].Text;
string helpText = analysisResults?[0]?.Correction?.Edits[0].Text;
Copy link
Contributor

Choose a reason for hiding this comment

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

This is technically less safe; if there are no results we'll crash. But if we know we're going to get a correction that's ok (looks like we make the assumption that the result we get will have an edit, but that is conditioned on Correction being non-null).

Don't know enough about the context above to know whether the assumption is safe.

But the alternative is cheap I suppose:

if (analysisResults == null || analysisResults.Count == 0)
{
    return result;
}

string helpText = analysisResults[0].Correction?.Edits[0].Text;

if (helpText == null)
{
    return result;
}


if (helpText == null)
{
return result;
}

result.Content = ScriptFile.GetLinesInternal(helpText).ToArray();
List<string> helpLines = ScriptFile.GetLinesInternal(helpText);

if (helpLocation != null &&
!helpLocation.Equals("before", StringComparison.OrdinalIgnoreCase))
{
// we need to trim the leading `{` and newline when helpLocation=="begin"
// we also need to trim the leading newline when helpLocation=="end"
result.Content = result.Content.Skip(1).ToArray();
helpLines = helpLines.GetRange(1, helpLines.Count - 1);
Copy link
Contributor

Choose a reason for hiding this comment

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

GetRange will duplicate the entire list into a new value, leaving two lists on the heap to garbage collect.

It might be better to use RemoveAt:

helpLines.RemoveAt(0);
helpLines.RemoveAt(helpLines.Count - 1);

}

// Trim trailing newline from help text.
if (string.IsNullOrEmpty(helpLines[helpLines.Count - 1]))
{
result.Content = helpLines.GetRange(0, helpLines.Count - 1).ToArray();
Copy link
Contributor

Choose a reason for hiding this comment

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

Should this be where result.Content is assigned?

If there's no empty line at the end, it seems we don't assign result.Content.

So maybe instead the way to go is:

if (string.IsNullOrEmpty(helpLines[helpLines.Count - 1]))
{
    helpLines.RemoveAt(helpLines.Count - 1);
}

result.Content = helpLines.ToArray();
return result;

}

return result;
Expand Down