Configurable ParameterDescription Placement and Section Requirements in PSProvideCommentHelp
Los mantenedores suelen responder en 1 día
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Aptitud para principiantes
- 35/100
Línea de trabajo
Comienza localizando la regla PSProvideCommentHelp y su gestión de configuración existente. Rastrea cómo se encuentran actualmente las descripciones de parámetros y las secciones de ayuda, y luego identifica las pruebas de la regla antes de definir la cobertura para ParameterDescriptionPlacement, RequiredSections y RequiredSectionsOrderMatters. La tarea estará completada cuando se hagan cumplir de forma coherente ambos modos de colocación y la validación de las secciones requeridas, incluido el orden opcional.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
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)
- Lenguaje dominante
- C#
- Estrellas
- 2.2k
- Forks
- 422
- Merge medio
- 2 h 23 min
- PR fusionados (30 d)
- 25
Preparar el entorno
Inicia el contenedor de desarrollo del proyecto en tu navegador, con tu propia cuenta de GitHub.
- Sin Dockerfile ni archivo de Docker Compose
- Tiene una plantilla de pull request
- Leer la guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de PowerShell/PSScriptAnalyzer
-
Up-for-Grabs
Dificultad 1/5 1-3 horas Aptitud para principiantes 78/100
PowerShell/PSScriptAnalyzer#2213 · 2 comentarios ·
Los mantenedores suelen responder en 1 día
-
Dificultad 4/5 1-2 días Aptitud para principiantes 18/100
PowerShell/PSScriptAnalyzer#2302 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 4/5 3-5 días Aptitud para principiantes 55/100
PowerShell/PSScriptAnalyzer#2300 ·
Los mantenedores suelen responder en 1 día
-
Invoke-ScriptAnalyzer fails intermittently with NullReferenceException in CommandInfo.ResolveParameter (ProvideCommentHelp / AvoidReservedCharInCmdlet race on Export-ModuleMember)Posiblemente ocupada @jessehouwing la tomó hace 89 días. AbiertoIssue - Bug
Dificultad 4/5 3-5 días Aptitud para principiantes 52/100
PowerShell/PSScriptAnalyzer#2229 · 6 comentarios ·
Los mantenedores suelen responder en 1 día
-
Dificultad 4/5 3-5 días Aptitud para principiantes 32/100
PowerShell/PSScriptAnalyzer#2222 · 2 comentarios ·
Los mantenedores suelen responder en 1 día
Todos los issues de PowerShell/PSScriptAnalyzer
Issues similares
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
GamaEdtech/gamatrain-back#977 ·
Los mantenedores suelen responder en 1 día
-
area-templates triage:bot-seen triage:needs-human
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
microsoft/aspire#22356 · 1 comentario ·
Los mantenedores suelen responder en 1 día
-
Needs-Triage
Dificultad 2/5 1-3 horas Aptitud para principiantes 84/100
PowerShell/PowerShell#28432 · 1 comentario · 1 reacción ·
Los mantenedores suelen responder en 1 día
-
documentation
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
microsoft/aspire.dev#2184 ·
Los mantenedores suelen responder en 2 días
-
area-controls-refreshview platform/ios s/triaged
Dificultad 2/5 1-3 horas Aptitud para principiantes 74/100
dotnet/maui#40314 · 1 reacción ·
Los mantenedores suelen responder en 1 día