Configurable ParameterDescription Placement and Section Requirements in PSProvideCommentHelp
I maintainer di solito rispondono entro 1 giorno
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Idoneità per principianti
- 35/100
Direzione di ricerca
Inizia individuando la regola PSProvideCommentHelp e la relativa gestione della configurazione esistente. Traccia il modo in cui vengono attualmente individuate le descrizioni dei parametri e le sezioni della guida, quindi identifica i test della regola prima di definire la copertura per ParameterDescriptionPlacement, RequiredSections e RequiredSectionsOrderMatters. Il lavoro è completato quando entrambe le modalità di posizionamento e la convalida delle sezioni obbligatorie, incluso l'ordinamento facoltativo, vengono applicati in modo coerente.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
Summary of the new feature
As a user of PSScriptAnalyzer, I want to be able to configure where ParameterDescription comments appear and enforce required help sections (with optional order enforcement) in the PSProvideCommentHelp rule, so that I can align documentation with my project's standards and ensure consistency.
Proposed technical implementation details (optional)
-
Configurable ParameterDescription Placement
- Add a new configuration option for PSProvideCommentHelp called
ParameterDescriptionPlacementwith two possible values:WithCommentHelp(default): Parameter descriptions are included in the comment help block as today.InParamBlock: Parameter descriptions are placed as inline comments in the param block itself.
- The setting would control where parameter docs are generated and where the rule expects to find them.
- Add a new configuration option for PSProvideCommentHelp called
-
Required Sections and Order Enforcement
- Add a configuration option called
RequiredSections, accepting an array of section names (e.g.,["Synopsis", "Description", "Parameters"]). - Add a boolean configuration option
RequiredSectionsOrderMatters(default:false). If set totrue, the order of the sections in the array is enforced in the help comment, and the rule will fail if the order is incorrect. - If
RequiredSectionsOrderMattersis false, presence of all required sections is enforced, but order is not.
- Add a configuration option called
These options would give users more flexibility in how comment-based help is structured and validated.
What is the latest version of PSScriptAnalyzer at the point of writing
2024.6.0 (or latest at time of filing)
- Lingua principale
- C#
- Stelle
- 2.2k
- Fork
- 422
- Merge medio
- 2h 23m
- PR unite (30g)
- 25
Preparare l'ambiente
Avvia il container di sviluppo del progetto nel browser, con il tuo account GitHub.
- Nessun Dockerfile né file Docker Compose
- Ha un modello di pull request
- Leggi 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.
Altre issue di PowerShell/PSScriptAnalyzer
-
Up-for-Grabs
Difficoltà 1/5 1-3 ore Idoneità per principianti 78/100
PowerShell/PSScriptAnalyzer#2213 · 2 commenti ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 4/5 1-2 giorni Idoneità per principianti 18/100
PowerShell/PSScriptAnalyzer#2302 ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 4/5 3-5 giorni Idoneità per principianti 55/100
PowerShell/PSScriptAnalyzer#2300 ·
I maintainer di solito rispondono entro 1 giorno
-
Invoke-ScriptAnalyzer fails intermittently with NullReferenceException in CommandInfo.ResolveParameter (ProvideCommentHelp / AvoidReservedCharInCmdlet race on Export-ModuleMember)Forse già presa @jessehouwing l’ha presa 89 giorni fa. ApertaIssue - Bug
Difficoltà 4/5 3-5 giorni Idoneità per principianti 52/100
PowerShell/PSScriptAnalyzer#2229 · 6 commenti ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 4/5 3-5 giorni Idoneità per principianti 32/100
PowerShell/PSScriptAnalyzer#2222 · 2 commenti ·
I maintainer di solito rispondono entro 1 giorno
Tutte le issue di PowerShell/PSScriptAnalyzer
Issue simili
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 68/100
GamaEdtech/gamatrain-back#977 ·
I maintainer di solito rispondono entro 1 giorno
-
area-templates triage:bot-seen triage:needs-human
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100
microsoft/aspire#22356 · 1 commento ·
I maintainer di solito rispondono entro 1 giorno
-
Needs-Triage
Difficoltà 2/5 1-3 ore Idoneità per principianti 84/100
PowerShell/PowerShell#28432 · 1 commento · 1 reazione ·
I maintainer di solito rispondono entro 1 giorno
-
documentation
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
microsoft/aspire.dev#2184 ·
I maintainer di solito rispondono entro 2 giorni
-
area-controls-refreshview platform/ios s/triaged
Difficoltà 2/5 1-3 ore Idoneità per principianti 74/100
dotnet/maui#40314 · 1 reazione ·
I maintainer di solito rispondono entro 1 giorno