PowerShell / PowerShell/PSScriptAnalyzer
I suggest adding an "Accuracy" property to DiagnosticRecord.
Nessuno ha ancora preso questa issue.
- Lingua principale
- C#
- Stelle
- 2.2k
- Fork
- 414
- Merge medio
- 13h 1m
- PR unite (30g)
- 2
Descrizione
Suggestion
Add an "Accuracy" property to DiagnosticRecord that will state the probability of the diagnostic being correct.
Benefits for the Users
Users can filter and sort diagnostics based on their accuracy.
invoke-scriptanalyzer |
where {$_.accuracy -gt 0.75} |
sort rulename, accuracy -descending
Benefits for the Rule Writers
Rule writers can introduce new rules sooner by introducing rules with a low accuracy, and then later increase the accuracy as the rule is refined.
For example, the "UseShouldProcessForStateChangingFunctions" rule right now is based only on the function name, so the rule can be assigned with an accuracy of, let's say, 0.25. If the rule is improved with better heuristics, then its accuracy can be increased. If the default of Invoke-ScriptAnalyzer doesn't show diagnostics with an accuracy of less than 0.50, then users won't have to suppress the "UseShouldProcessForStateChangingFunctions" while the rule is still in its initial stages.
This allows rule writers to get feedback on their rules while the rules are still being refined without adding noise to Invoke-ScriptAnalyzer results.
Benefits for the Rules
The rules can have multiple diagnostic accuracies.
For example, the "PossibleIncorrectComparisonWithNull" will be more useful if it can output diagnostics with different accuracies based on context.
A line such as:
if ($a -ne $null)
should output a diagnostic for this rule with a high accuracy because "$a -ne $null" is very likely to be a compare operation instead of a filter operation.
However, a line such as:
$a = $b -ne $null
should output a diagnostic for this rule with a low accuracy because "$b -ne $null" can either be a compare operation or a filter operation, and it will be very difficult to assert that the user violated the rule.
Now, the rule doesn't have to be hardcoded with the compromise of when to generate diagnostics because it can generate all diagnostics with different accuracy levels.
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Inizia tracciando DiagnosticRecord e il percorso di output di Invoke-ScriptAnalyzer; l'issue non indica file sorgente né test. Determina come debba essere rappresentata l'accuratezza, come debba essere prodotta dalle regole e come debba essere esposta per il filtraggio e l'ordinamento. Il lavoro è completo quando la proprietà e la relativa semantica sono supportate in modo coerente negli scenari diagnostici proposti.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- csharp, powershell
- Ambito
- cli, devtools
- Tipo di issue
- Funzionalità
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 25/100