PowerShell / PowerShell/PSScriptAnalyzer

Need RuleId (Unique Rule Identifier) in addition to the RuleName

Open
#549 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Issue - Discussion
Dominant language
C#
Stars
2.2k
Forks
414
Avg merge
13h 1m
Merged PRs (30d)
2

Description

Is it possible to have the RuleId (Unique Rule Identifier) in addition to the RuleName? I think, the length of RuleName is not fixed, right? If it is fixed, what is the maximum length of the RuleName?

The RuleId is also helpful when the RuleName gets changed/renamed.

Some useful details from the FxCop warnings:
https://msdn.microsoft.com/en-US/library/bb264474(v=vs.80).aspx

Please evaluate if we can have other properties in PSSA Rules similar to the FxCop rules.
https://msdn.microsoft.com/en-us/library/bb429379(v=vs.80).aspx

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue names no files, tests, or entry points. Begin by locating PSScriptAnalyzer's rule metadata and warning output, then compare the existing RuleName representation with the requested unique identifier and other FxCop-like properties. Done would require an agreed metadata design, naming and length rules, and corresponding implementation and tests.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp, powershell
Domain
tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.