PowerShell / PowerShell/PSScriptAnalyzer

PSProvideCommentHelp should also warn on script param blocks

未关闭
#1,363 2 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

Area - Formatter Area - Rules Issue - Enhancement Up-for-Grabs
主要语言
C#
星标
2.2k
派生
414
平均合并
13 小时 1 分钟
30 天内合并 PR
2

描述

Summary of the new feature

As a user, I want the ## comment generation feature in the PowerShell extension for VSCode to also generate comment based help for param blocks at the top of scripts. The PowerShell extension leverages the PSProvideCommentHelp rule to do this.

Proposed technical implementation details (optional)

Invoke-ScriptAnalyzer -ScriptDefinition 'param($foo)' -Settings @{ 
  Rules = @{
      PSProvideCommentHelp = @{
          Enable = $true
          ExportedOnly = $false
          BlockComment = $true
          VSCodeSnippetCorrection = $false
          Placement = "before"
      }
  }
  }

This should yield a diagnostic record just like this does:

Invoke-ScriptAnalyzer -ScriptDefinition 'function asdf { param($foo) }' -Settings @{
  Rules = @{
      PSProvideCommentHelp = @{
          Enable = $true
          ExportedOnly = $false
          BlockComment = $true
          VSCodeSnippetCorrection = $false
          Placement = "before"
      }
  }
  }


RuleName                            Severity     ScriptName Line  Message
--------                            --------     ---------- ----  -------
PSProvideCommentHelp                Information             1     The cmdlet 'asdf' does not have a help comment.

What is the latest version of PSScriptAnalyzer at the point of writing

1.18.3

贡献指南

打开贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

调研方向

从 PSProvideCommentHelp 规则开始,并使用顶层 param($foo) 脚本定义通过 Invoke-ScriptAnalyzer 进行复现。将其与现有的 function param 示例进行比较;当脚本参数块产生相同的帮助注释诊断时,即表示完成。

由索引模型根据 Issue 内容生成。

评估

技术栈
powershell
领域
tooling
Issue 类型
功能
难度
3/5
预计耗时
1-2 天
活跃度
停滞
描述清晰度
基本清楚
新手友好度
48/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。