Get-ScriptAnalyzerRule default list view shows no value for property "Name"

[o-l-a-v]

Before submitting a bug report:

• Make sure you are able to repro it on the latest released version
• Perform a quick search for existing issues to check if this bug has already been reported

Steps to reproduce

Get-ScriptAnalyzerRule -Name 'PSUseCorrectCasing' | Format-List

Expected behavior

PS > Get-ScriptAnalyzerRule -Name 'PSUseCorrectCasing' | Format-List

Name        : PSUseCorrectCasing
Severity    : Information
Description : For better readability and consistency, use the exact casing of the cmdlet/function/parameter.
SourceName  : PS

PS >

Actual behavior

PS > Get-ScriptAnalyzerRule -Name 'PSUseCorrectCasing' | Format-List

Name        : 
Severity    : Information
Description : For better readability and consistency, use the exact casing of the cmdlet/function/parameter.
SourceName  : PS

PS >

If an unexpected error was thrown then please report the full error details using e.g. $error[0] | Select-Object *

Environment data

> $PSVersionTable


Name                           Value
----                           -----
PSVersion                      7.4.3
PSEdition                      Core
GitCommitId                    7.4.3
OS                             Microsoft Windows 10.0.22631
Platform                       Win32NT
PSCompatibleVersions           {1.0, 2.0, 3.0, 4.0}
PSRemotingProtocolVersion      2.3
SerializationVersion           1.1.0.1
WSManStackVersion              3.0



> (Get-Module -ListAvailable PSScriptAnalyzer).Version | ForEach-Object { $_.ToString() }

1.22.0
1.22.0

If selecting all properties with format list:

PS > Get-ScriptAnalyzerRule -Name 'PSUseCorrectCasing' | Format-List -Property '*'

RuleName         : PSUseCorrectCasing
CommonName       : Use exact casing of cmdlet/function/parameter name.
Description      : For better readability and consistency, use the exact casing of the cmdlet/function/parameter.
SourceType       : Builtin
SourceName       : PS
Severity         : Information
ImplementingType : Microsoft.Windows.PowerShell.ScriptAnalyzer.BuiltinRules.UseCorrectCasing

PS >

[liamjpeters]

Hey @o-l-a-v 👋,

This looks to be an issue with the format file definition, which outlines the default type definition of RuleInfo. It is referencing a Name property - which does not exist on the type.

PSScriptAnalyzer/Engine/ScriptAnalyzer.types.ps1xml

Lines 73 to 91 in ae898e7

	<Type>
	<Name>Microsoft.Windows.PowerShell.ScriptAnalyzer.Generic.RuleInfo</Name>
	<Members>
	<MemberSet>
	<Name>PSStandardMembers</Name>
	<Members>
	<PropertySet>
	<Name>DefaultDisplayPropertySet</Name>
	<ReferencedProperties>
	<Name>Name</Name>
	<Name>Severity</Name>
	<Name>Description</Name>
	<Name>SourceName</Name>
	</ReferencedProperties>
	</PropertySet>
	</Members>
	</MemberSet>
	</Members>
	</Type>

I've put together a PR to update this to RuleName. This results in the below:

Thanks for flagging this! 🙂