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.