Add the possibilty to manage suggestedCorrections property with a script rule

[LaurentDardenne]

In the file ScriptRuleDocumentation.md, it is says :

# DiagnosticRecord should have four properties: Message, Extent, RuleName and Severity

$result = [Microsoft.Windows.PowerShell.ScriptAnalyzer.Generic.DiagnosticRecord[]]@{
    "Message"  = "This is a sample rule"
    "Extent"   = $ast.Extent
    "RuleName" = $PSCmdlet.MyInvocation.InvocationName
    "Severity" = "Warning"
}

It is possible to assign the suggestedCorrections property in a script, but the C# code do not assign this property.

[kapilmb]

Yes, you can add SuggestedCorrections property.

$correctionExtent = New-Object `
-TypeName 'Microsoft.Windows.PowerShell.ScriptAnalyzer.Generic.CorrectionExtent' `
-ArgumentList $startLineNumber,$endLineNumber,$startColumnNumber,$endColumnNumber,$replacementText,$filepath,$description

$result = New-Object -TypeName ` 
'Microsoft.Windows.PowerShell.ScriptAnalyzer.Generic.DiagnosticRecord' `
-ArgumentList "This is sample rule",$violationExtent,'rulename','warning','c:\tmp',$null,$correctionExtent

As of now you cannot initialize DiagnosticRecord with SuggestedCorrection property using a dictionary literal.

If it helps, you can find a relevant C# example here

[LaurentDardenne]

Yes, you can add SuggestedCorrections property.
This problem is similar this one

When i use the function outside PSscriptAnalyzer, this property is correctly assigned, but when PSscriptAnalyzer use my function this property is no more correctly assigned :

May be this C# code is incorrect...

[kapilmb]

@LaurentDardenne Thanks for the explanation! I now understand the issue. Yes, looks like something is lost while converting from PSObject to DiagnosticRecord in the Engine.

[ajansveld]

Is this still on the radar? Seems like it would be fairly easy to fix and it would be great to provide custom formatting in vscode.

Thanks!

[bergmeister]

@LaurentDardenne Do I understand correctly that we can close this now because the root cause was fixed in #618?

[LaurentDardenne]

@bergmeister
if you want, I have not tested again for 1 year.
I'm trying to check if it works.

[LaurentDardenne]

The issue 618 is fixed, but not this one.

When i use the function outside PSscriptAnalyzer, this property is correctly assigned, but when PSscriptAnalyzer use my function this property is no more correctly assigned .

[LaurentDardenne]

Maybe this code is involved.
if necessary I can join a test module.

[Mcgurk125]

Has this ever been fixed!?

[bergmeister]

@Mcgurk125
As per this comment 2 months ago, it does not seems so (I have not verified it myself, but there was definitely no code change in this area in the last 2 months). I can take a brief look at it in the next days but also feel free to grab the issue and submit a PR for it.

[bergmeister]

@LaurentDardenne @Mcgurk125 I have a fix for this in my branch ready here and I will also make the property public to keep the construction of the DiagnosticRecord object easy as it is. PR with the fix is below:

[LaurentDardenne]

Thank you for the work done