Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

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

Closed
o-l-a-v opened this issue Jul 7, 2024 · 1 comment · Fixed by #2011
Closed

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

o-l-a-v opened this issue Jul 7, 2024 · 1 comment · Fixed by #2011

Comments

@o-l-a-v
Copy link

o-l-a-v commented Jul 7, 2024

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 >
@o-l-a-v o-l-a-v changed the title "PSScriptAnalyzer" default view shows no value for property "Name" Get-ScriptAnalyzerRule default list view shows no value for property "Name" Jul 7, 2024
@liamjpeters liamjpeters mentioned this issue Jul 8, 2024
Merged
6 tasks
@liamjpeters
Copy link
Contributor

liamjpeters commented Jul 8, 2024 •
edited

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:

image

Thanks for flagging this! 🙂

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Update default type definition of RuleInfo liamjpeters/PSScriptAnalyzer
2 participants
@o-l-a-v @liamjpeters