Add suppression message for ScriptAnalyzer rule in New-SqlDscFileGroup function

johlju · johlju · commit 0fcf82b4e826 · 2025-11-22T10:30:13.000+01:00
diff --git a/source/Public/New-SqlDscFileGroup.ps1 b/source/Public/New-SqlDscFileGroup.ps1
@@ -80,6 +80,7 @@
 #>
 function New-SqlDscFileGroup
 {
+    [System.Diagnostics.CodeAnalysis.SuppressMessageAttribute('UseSyntacticallyCorrectExamples', '', Justification = 'Because the rule does not yet support parsing the code when a parameter type is not available. The ScriptAnalyzer rule UseSyntacticallyCorrectExamples will always error in the editor due to https://github.com/indented-automation/Indented.ScriptAnalyzerRules/issues/8.')]
     [CmdletBinding(DefaultParameterSetName = 'AsSpec', SupportsShouldProcess = $true, ConfirmImpact = 'High')]
     [OutputType([Microsoft.SqlServer.Management.Smo.FileGroup])]
     [OutputType([DatabaseFileGroupSpec])]

Original file line number	Diff line number	Diff line change
`@@ -80,6 +80,7 @@`
`80`	`80`	`#>`
`81`	`81`	`function New-SqlDscFileGroup`
`82`	`82`	`{`
	`83`	`+ [System.Diagnostics.CodeAnalysis.SuppressMessageAttribute('UseSyntacticallyCorrectExamples', '', Justification = 'Because the rule does not yet support parsing the code when a parameter type is not available. The ScriptAnalyzer rule UseSyntacticallyCorrectExamples will always error in the editor due to https://github.com/indented-automation/Indented.ScriptAnalyzerRules/issues/8.')]`
`83`	`84`	`[CmdletBinding(DefaultParameterSetName = 'AsSpec', SupportsShouldProcess = $true, ConfirmImpact = 'High')]`
`84`	`85`	`[OutputType([Microsoft.SqlServer.Management.Smo.FileGroup])]`
`85`	`86`	`[OutputType([DatabaseFileGroupSpec])]`