How to suppress a warning in a method?

[floh96]

Following example code:

class test {
    [String]$name

    [Array]test_method ($test1, $test2) {
        ...
    }
}

How can i supress a warning in the method test_method?

[JamesWTruher]

it can be done with the appropriate attribute as the following shows:

PS> $ss = 'class foo {                         
>> [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSAvoidUsingCmdletAliases", "")]
>> [string]ToString() {   
>> return (gci).ToString()
>> } 
>> }'
PS> Invoke-ScriptAnalyzer -ScriptDefinition $ss
PS>                                               

without the attribute

PS> $ss = 'class foo {                         
>> [string]ToString() {                                                                
>> return (gci).ToString()
>> }                      
>> }'
PS> Invoke-ScriptAnalyzer -ScriptDefinition $ss
                       
RuleName                            Severity     ScriptName Line  Message
--------                            --------     ---------- ----  -------
PSAvoidUsingCmdletAliases           Warning                 3     'gci' is an alias of 'Get-ChildItem'. Alias can introduce
                                                                  possible problems and make scripts hard to maintain. Please
                                                                  consider changing alias to its full content.

[floh96]

It's not working in the following example:

Class data_bag {
  [String]$name

  [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSAvoidLongLines", "")]
  [Array]decrypt ($decryption_key_location, $decryption_location) {
    $decrypted_data_bag = bundle exec knife data bag show passwords $this.name --secret-file $decryption_key_location -F json -z
    return $decrypted_data_bag
  }
}

I have set MaximumLineLength = 80 in psscriptanalyzersettings.psd1.
Still displays the warning:

RuleName                            Severity     ScriptName Line  Message
--------                            --------     ---------- ----  -------
PSAvoidLongLines                    Warning      beratertes 68    Line exceeds the configured maximum length of 80 characters
                                                 t_vm_initi
                                                 al_setup.p
                                                 s1
1 rule violation found.    Severity distribution:  Error = 0, Warning = 1, Information = 0

[floh96]

@JamesWTruher when i call psscriptanalyzer with Invoke-ScriptAnalyzer -Path .\scripts\test.ps1 -ReportSummary it is showing 0 warnings but when i call psscriptanalyzer with Invoke-ScriptAnalyzer -Path . -Recurse -ReportSummary it's showing the warning.
Is this a known bug?

Edit: it's always showing the warning i was not requiring the PSScriptAnalyzerSettings.psd1 file when i called ScriptAnalyzer against the file.

[rjmholt]

Code for context:

PSScriptAnalyzer/Engine/Helper.cs

Lines 1265 to 1297 in f71cad7

	/// <summary>
	/// Returns a list of rule suppression from the class
	/// </summary>
	/// <param name="typeAst"></param>
	/// <returns></returns>
	internal List<RuleSuppression> GetSuppressionsClass(TypeDefinitionAst typeAst)
	{
	List<RuleSuppression> result = new List<RuleSuppression>();
	if (typeAst != null && typeAst.Attributes != null && typeAst.Attributes.Count != 0)
	{
	result.AddRange(RuleSuppression.GetSuppressions(typeAst.Attributes, typeAst.Extent.StartOffset, typeAst.Extent.EndOffset, typeAst));
	}
	if (typeAst.Members == null)
	{
	return result;
	}
	foreach (var member in typeAst.Members)
	{
	FunctionMemberAst funcMemb = member as FunctionMemberAst;
	if (funcMemb == null)
	{
	continue;
	}
	result.AddRange(RuleSuppression.GetSuppressions(funcMemb.Attributes, funcMemb.Extent.StartOffset, funcMemb.Extent.EndOffset, funcMemb));
	}
	return result;
	}

[floh96]

@JamesWTruher @rjmholt @SydneyhSmith is someone looking into this? (sorry for asking again since this issue has the resolution anwsered label I was afraid that it will get overlooked.)
Or should I open a new issue?